Merge pull request #221 from RedShyGuy/release/3.0.0

Release/3.0.0

Author: RedShyGuy

.github/workflows/c-cpp.yml

@@ -5,6 +5,7 @@ on:
     branches: ["master"]
   pull_request:
     branches: ["master"]
+  workflow_dispatch:
 
 jobs:
   build:
@@ -14,30 +15,27 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-    - name: Download libctrpf
-      run: |
-        wget -O libctrpf.tar.bz2 "https://gitlab.com/-/project/35748837/uploads/8d2a3dc282f32b6a75d5f6abaeafe88f/libctrpf-0.8.0.tar.bz2"
-        tar -xjf libctrpf.tar.bz2
-
-    - name: Install libctrpf
-      run: |
-        mkdir -p /opt/devkitpro/libctrpf/include
-        mkdir -p /opt/devkitpro/libctrpf/lib
-        cp -r include/* /opt/devkitpro/libctrpf/include/
-        cp -r lib/* /opt/devkitpro/libctrpf/lib/
-
     - name: Download 3gxtool
       run: |
         wget -O 3gxtool "https://gitlab.com/-/project/35893975/uploads/7cf27fcdc26921d9a6c5505c1e5bbcaa/3gxtool"
         chmod +x 3gxtool
         cp 3gxtool /opt/devkitpro/tools/bin/3gxtool
 
-    - name: Build Plugin
-      run: make
+    - name: Clone libctrpf (develop)
+      run: |
+        git clone --depth=1 --branch develop https://gitlab.com/thepixellizeross/ctrpluginframework.git libctrpf
+
+    - name: Build & Install libctrpf
+      run: |
+        cd libctrpf
+        make
 
     - name: Run Language Python Script
       run: python3 LanguageBinCreator/json_to_bin.py
 
+    - name: Build Plugin
+      run: make
+
     - name: Package Plugin
       run: |
         mkdir -p package/Vapecord/Data/
@@ -51,12 +49,18 @@ jobs:
             cp -r Files/snd/* package/luma/plugins/$folder/snd/
         done
 
-    - name: Upload Artifacts
+    - name: Upload Package Artifact
       uses: actions/upload-artifact@v4
       with:
         name: Vapecord.Public
         path: package/
 
+    - name: Upload ELF Artifact
+      uses: actions/upload-artifact@v4
+      with:
+        name: Vapecord.Public.elf
+        path: Vapecord_Public.elf
+
     - name: Check For Unused Text
       run: python3 CheckForUnusedText.py
 
@@ -66,5 +70,9 @@ jobs:
     - name: Check If Text Is Translated
       run: python3 CheckIfTextIsTranslated.py
 
+    - name: Check For Unused Addresses
+      run: python3 CheckForUnusedAddresses.py
+
+
 
 

.vscode/c_cpp_properties.json

@@ -27,7 +27,7 @@
                 "databaseFilename": ""
             },
             "cStandard": "c11",
-            "cppStandard": "gnu++20",
+            "cppStandard": "c++11",
             "intelliSenseMode": "gcc-arm"  
         }
     ],

CheckForUnusedAddresses.py

@@ -0,0 +1,100 @@
+import os
+import re
+import sys
+from pathlib import Path
+
+SCRIPT_DIR = Path(__file__).parent
+ADDRESSES_HEADER = SCRIPT_DIR / "Includes/Address/Addresses.hpp"
+
+address_usage_pattern = re.compile(
+    r"\bAddress(?:\s+\w+)?\s*\(\s*(0x[0-9A-Fa-f]+)\s*\)"
+)
+
+array_pattern = re.compile(
+    r"\{\s*(0x[0-9A-Fa-f]+)\s*,"
+)
+
+
+# --- comment stripping ---
+
+def strip_block_comments(text: str) -> str:
+    return re.sub(r"/\*.*?\*/", "", text, flags=re.DOTALL)
+
+
+def strip_all_comments(text: str) -> str:
+    text = re.sub(r"/\*.*?\*/", "", text, flags=re.DOTALL)
+    text = re.sub(r"//.*", "", text)
+    return text
+
+
+# --- header scan ---
+
+def collect_addresses_from_header():
+    addresses = set()
+
+    if not ADDRESSES_HEADER.exists():
+        print(f"ERROR: {ADDRESSES_HEADER} not found!")
+        return addresses
+
+    with open(ADDRESSES_HEADER, "r", encoding="utf-8", errors="ignore") as f:
+        content = strip_block_comments(f.read())
+
+    for match in array_pattern.finditer(content):
+        addresses.add(match.group(1).lower())
+
+    return addresses
+
+
+# --- code scan ---
+
+def collect_used_addresses():
+    used = set()
+
+    for root, _, files in os.walk("."):
+        for file in files:
+            if not file.endswith((".cpp", ".hpp", ".h")):
+                continue
+
+            path = Path(root) / file
+
+            if path.resolve() == ADDRESSES_HEADER.resolve():
+                continue
+
+            with open(path, "r", encoding="utf-8", errors="ignore") as f:
+                content = strip_all_comments(f.read())
+
+            for match in address_usage_pattern.finditer(content):
+                used.add(match.group(1).lower())
+
+    return used
+
+
+# --- main ---
+
+def main():
+    print("Scanning for unused addresses...")
+
+    header_addresses = collect_addresses_from_header()
+    used_addresses = collect_used_addresses()
+
+    unused = sorted(header_addresses - used_addresses)
+
+    print(f"Total in header: {len(header_addresses)}")
+    print(f"Used in code: {len(used_addresses)}")
+    print(f"Unused: {len(unused)}")
+
+    if unused:
+        print("\nUnused addresses:")
+        for addr in unused:
+            print(f"  {addr}")
+        exit_code = 1
+    else:
+        print("\nNo unused addresses found!")
+        exit_code = 0
+
+    sys.exit(exit_code)
+
+
+if __name__ == "__main__":
+    main()
+

CheckForUnusedText.py

@@ -1,24 +1,16 @@
 import json
 from pathlib import Path
 import re
+import sys
 
 # Config
 PROJECT_ROOT = Path(__file__).parent
 LANG_JSON_DIR = PROJECT_ROOT / "LanguageBinCreator" / "languages"
 
-# Regex: match anything inside get("...") or get('...')
-LANG_PATTERN = re.compile(r'Language::getInstance\(\)->get\(\s*["\'](.+?)["\']\s*\)')
+# Regex: match anything like TextID::KEY
+TEXTID_PATTERN = re.compile(r'TextID::([A-Z0-9_]+)')
 
-# MenuFolderExtras
-MENUFOLDER_PATTERN = re.compile(r'MenuFolderExtras\(\s*["\'](.+?)["\']')
-
-# MenuEntryExtras
-MENUENTRY_PATTERN = re.compile(r'MenuEntryExtras\((.*?)\)')
-
-# HotkeyExtras
-HOTKEY_PATTERN = re.compile(r'HotkeyExtras\([^,]+,\s*["\'](.+?)["\']\s*\)')
-
-# Scan code files for keys
+# Scan code files for enum keys
 keys_used = set()
 
 for file_path in PROJECT_ROOT.rglob("*"):
@@ -29,16 +21,11 @@
             print(f"[WARNING] Could not read {file_path}: {e}")
             continue
 
-        matches = MENUFOLDER_PATTERN.findall(content) + \
-          HOTKEY_PATTERN.findall(content) + \
-          LANG_PATTERN.findall(content)
-        
+        matches = TEXTID_PATTERN.findall(content)
         keys_used.update(matches)
 
-        params = MENUENTRY_PATTERN.findall(content)
-        for param_str in params:
-            string_keys = re.findall(r'["\'](.+?)["\']', param_str)
-            keys_used.update(string_keys)
+# Ignore TextID::NONE
+keys_used.discard("NONE")
 
 # Load all JSON entries
 json_files = list(LANG_JSON_DIR.glob("*.json"))
@@ -63,12 +50,15 @@
 # Print results
 if not unused_keys_report:
     print("All language keys in JSON files are used in the code!")
+    exit_code = 0
 else:
     print(f"Unused language keys found ({sum(len(v) for v in unused_keys_report.values())}):")
     for json_name, keys in sorted(unused_keys_report.items()):
         print(f"\n{json_name} ({len(keys)} unused keys):")
         for key in sorted(keys):
             print(f"  - {key}")
+    exit_code = 1
 
-print(f"\nTotal keys used in code: {len(keys_used)}")
+print(f"\nTotal TextID keys used in code: {len(keys_used)}")
 print(f"JSON files scanned: {len(json_files)}")
+sys.exit(exit_code)

CheckIfAddressesArePorted.py

@@ -1,5 +1,6 @@
 import os
 import re
+import sys
 from pathlib import Path
 
 # CONFIG
@@ -67,8 +68,12 @@ def main():
             print(f"\n{file}:")
             for line, val in entries:
                 print(f"  Line {line}: {val}")
+        exit_code = 1
     else:
         print("\nAll Address-Entries are ported!")
+        exit_code = 0
+
+    sys.exit(exit_code)
 
 if __name__ == "__main__":
     main()

CheckIfTextIsTranslated.py

@@ -1,25 +1,17 @@
 import json
 from pathlib import Path
 import re
+import sys
 
 # Config
 PROJECT_ROOT = Path(__file__).parent
 LANG_JSON_DIR = PROJECT_ROOT / "LanguageBinCreator" / "languages"
+TEXTID_ENUM_FILE = PROJECT_ROOT.parent / "Includes" / "TextID.hpp"
 
-# Regex: match anything inside get("...") or get('...')
-LANG_PATTERN = re.compile(r'Language::getInstance\(\)->get\(\s*["\'](.+?)["\']\s*\)')
+# Regex: match anything like TextID::SOME_KEY
+TEXTID_PATTERN = re.compile(r'TextID::([A-Z0-9_]+)')
 
-# MenuFolderExtras: first parameter
-MENUFOLDER_PATTERN = re.compile(r'MenuFolderExtras\(\s*["\'](.+?)["\']')
-
-# MenuEntryExtras: last string parameter
-
-MENUENTRY_PATTERN = re.compile(r'MenuEntryExtras\((.*?)\)')
-
-# HotkeyExtras: second parameter
-HOTKEY_PATTERN = re.compile(r'HotkeyExtras\([^,]+,\s*["\'](.+?)["\']\s*\)')
-
-# Scan code files for keys
+# Scan code files for enum keys
 keys_used = set()
 
 for file_path in PROJECT_ROOT.rglob("*"):
@@ -28,20 +20,16 @@
             content = file_path.read_text(encoding="utf-8")
         except Exception as e:
             print(f"[WARNING] Could not read {file_path}: {e}")
+            exit_code = 1
             continue
 
-        matches = MENUFOLDER_PATTERN.findall(content) + \
-          HOTKEY_PATTERN.findall(content) + \
-          LANG_PATTERN.findall(content)
-
+        matches = TEXTID_PATTERN.findall(content)
         keys_used.update(matches)
 
-        params = MENUENTRY_PATTERN.findall(content)
-        for param_str in params:
-            string_keys = re.findall(r'["\'](.+?)["\']', param_str)
-            keys_used.update(string_keys)
+# Ignore NONE
+keys_used.discard("NONE")
 
-# Load all JSON entries
+# Load all JSON entries (master_keys)
 json_files = list(LANG_JSON_DIR.glob("*.json"))
 json_entries_per_file = {}
 
@@ -52,6 +40,7 @@
         json_entries_per_file[json_file.name] = entries
     except Exception as e:
         print(f"[WARNING] Could not parse {json_file}: {e}")
+        exit_code = 1
 
 # Check each key in every JSON
 missing_keys_report = {}
@@ -66,11 +55,14 @@
 
 # Print results
 if not missing_keys_report:
-    print("All language keys exist in every JSON file!")
+    print("All TextID keys exist in every JSON file!")
+    exit_code = 0
 else:
-    print(f"Some language keys are missing in JSON files ({len(missing_keys_report)}):")
+    print(f"Some TextID keys are missing in JSON files ({len(missing_keys_report)}):")
     for key, missing_files in sorted(missing_keys_report.items()):
         print(f"  - {key} missing in: {', '.join(missing_files)}")
+    exit_code = 1
 
-print(f"\nTotal keys found in code: {len(keys_used)}")
+print(f"\nTotal TextID keys found in code: {len(keys_used)}")
 print(f"JSON files scanned: {len(json_files)}")
+sys.exit(exit_code)