prepare next release

Author: GermanCodeEngineer

TODO.txt

@@ -3,20 +3,9 @@ TODOs Sorted by Priorites
 Special:
     TODOs in Code + read through code, optimize here and there
 
-Currently Working On:
-    - M/L: make a script which show info for the requested block opcode
-    - add the above to docs
+Currently Working On: /
 
-Changelog since last Release:
-    - Major Changes:
-        - Compatability with all Builtin Extensions
-        - Builtin Extensions are now generated locally, not maintained manually
-        - Renamed built-in Second Repr/"new" opcodes -> "&category::block (INPUT) text"
-        - Added new category blocks(as of 24.09.2025)
-        - Updated documentation and tests
-    - Minor Changes:
-        - Implemented special and difficult "draw polygon" block(pen extension)
-        - Added CONTRIBUTING.md
+Changelog since last Release: /
 
 High: /
 

builtin_extension_source

@@ -5,9 +5,9 @@ This is what the **Opcode Documentation Generator** is for.
 
 ---
 
-## Using `get_opcode_doc(info_api: OpcodeInfoAPI, new_opcode: str)`
+## Using `generate_opcode_doc(info_api: OpcodeInfoAPI, new_opcode: str)`
 
-You can use `get_opcode_doc` to generated Markdown documentation for an opcode:
+You can use `generate_opcode_doc` to generate Markdown documentation for an opcode:
 ```python
 from pmp_manip import init_config, get_default_config, info_api, generate_opcode_doc
 
@@ -36,7 +36,11 @@ Output:
 ### Monitor: /
 
 ```
-You can write it to a file and use any tool(like VSCode) to display it:
+
+## Viewing the Documentation
+
+You can write it to a file and use any markdown viewer (like VSCode, GitHub, or grip) to display it nicely:
+
 ```python
 from pmp_manip import init_config, get_default_config, info_api, generate_opcode_doc
 
@@ -45,11 +49,14 @@ init_config(get_default_config())
 doc_string = generate_opcode_doc(info_api, new_opcode="&motion::glide (SECONDS) secs to ([TARGET])")
 with open("generated_doc.md", "w") as file:
     file.write(doc_string)
+
+# Optional: Preview with grip (install with: pip install grip)
+# Then run: grip generated_doc.md
 ```
-Displayed:
 
----
+The rendered result can look like this:
 
+---
 ## Documentation for opcode `glide (SECONDS) secs to ([TARGET])`(motion)
 ### Block Shape
 * [**STATEMENT**](https://github.com/GermanCodeEngineer/py-pmp-manip/blob/main/docs/block_shape.md#STATEMENT)
@@ -74,9 +81,9 @@ Note: It can also be used for block opcodes from extensions after adding them to
 ## Searching for opcodes
 
 Opcodes of almost all blocks are based on their name in the PenguinMod Editor. Just the inputs and dropdowns(ALLCAPS) were added.
-Let us say you want to get information for this block or are trying to find out its opcode:
-![](images/doc_api_searched_opcode.jpg)
-If an opcode is not found, `generate_opcode_doc` will show the closest matches. We know it is from the `sensing` category and contains the words "touching clone of":
+Let us say you want to get information for this block or are trying to find out its opcode:<br>
+![](images/doc_api_searched_opcode.jpg)<br>
+If an opcode is not found, `generate_opcode_doc` will show the closest matches. We know it is from the `sensing` category and contains the words `"touching clone of"`:
 ```python
 from pmp_manip import init_config, get_default_config, info_api, generate_opcode_doc
 

docs/doc_api.md

@@ -12,3 +12,4 @@
 
 ## Other Resources
 * **Shapes of Blocks:** [docs/block_shape.md](block_shape.md)
+* [FOR DEVS] **Steps to publishing a new release:** [docs/release_tutorial.md](release_tutorial.md)

docs/images/second_repr_uml.svg

@@ -13,6 +13,7 @@
 * ✅ Code is clean, readable, and follows PEP 8 style conventions.
 * ✅ Functions and classes are well-organized; modular design.
 * ✅ Unused code, debug prints, and commented-out sections are removed.
+* ✅ Temporary files and file calls are removed.
 * ✅ Proper exception handling is in place.
 
 ---

docs/index.md

@@ -116,7 +116,6 @@ def from_file(cls, file_path: str) -> "FRProject":
         project_data = loads(contents["project.json"].decode())
         del contents["project.json"]
         from pmp_manip.utility import write_file_text
-        write_file_text("data.lua", FRProject.__repr__(project_data))
 
         if   file_path.endswith(".sb3"):
             project_data = FRProject._data_sb3_to_pmp(project_data)

docs/release_tutorial.md

@@ -159,6 +159,8 @@
     "jwStorage",
     # date type
     "jwDate",
+    # scoped variables
+    "jwScope",
 
     # jw: They'll think its made by jwklong >:)
     # (but it's not (yet (maybe (probably not (but its made by ianyourgod)))))