Merge pull request #38 from apple1417/master

merge mods base + console mod menu with willow + switch to submodules, upgrade to python 3.13

Author: apple1417

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "[email protected]:bl-sdk/common_dotfiles.git",
-  "commit": "6b31480199099e9957b18918373a75d979951919",
+  "commit": "d03eee713ad436d20033d0598eb88f1529c56ca8",
   "checkout": null,
   "context": {
     "cookiecutter": {

.gitmodules

@@ -1,6 +1,12 @@
-[submodule "pyunrealsdk"]
+[submodule "libs/pyunrealsdk"]
 	path = libs/pyunrealsdk
-	url = [email protected]:bl-sdk/pyunrealsdk.git
+	url = ../../bl-sdk/pyunrealsdk.git
 [submodule "libs/pluginloader"]
 	path = libs/pluginloader
-	url = [email protected]:bl-sdk/pluginloader.git
+	url = ../../bl-sdk/pluginloader.git
+[submodule "src/mods_base"]
+	path = src/mods_base
+	url = ../../bl-sdk/mods_base.git
+[submodule "src/console_mod_menu"]
+	path = src/console_mod_menu
+	url = ../../bl-sdk/console_mod_menu.git

CMakeLists.txt

@@ -5,7 +5,7 @@ project(oak_mod_manager)
 set(UNREALSDK_ARCH x64)
 set(UNREALSDK_UE_VERSION UE4)
 set(EXPLICIT_PYTHON_ARCH amd64)
-set(EXPLICIT_PYTHON_VERSION 3.12.3)
+set(EXPLICIT_PYTHON_VERSION 3.13.0)
 
 add_subdirectory(libs/pyunrealsdk)
 

libs/pluginloader

@@ -2,7 +2,6 @@
 import re
 import shutil
 import subprocess
-import textwrap
 import tomllib
 from collections.abc import Iterator, Sequence
 from functools import cache
@@ -24,6 +23,12 @@
 
 LICENSE = THIS_FOLDER / "LICENSE"
 
+MODS_WITH_EXISTING_LICENSE = {
+    # These have their own due to being submodules
+    BASE_MOD,
+    CONSOLE_MENU,
+}
+
 BUILD_DIR_BASE = THIS_FOLDER / "out" / "build"
 INSTALL_DIR_BASE = THIS_FOLDER / "out" / "install"
 
@@ -33,6 +38,11 @@
 PYPROJECT_FILE = THIS_FOLDER / "manager_pyproject.toml"
 
 
+# Primarily to skip over all the dotfiles in mods which are submodules
+VALID_MOD_FILE_SUFFIXES = {".py", ".pyi", ".pyd", ".md"}
+
+
+# Regex to extract presets from a `cmake --list-presets` command
 LIST_PRESETS_RE = re.compile('  "(.+)"')
 
 
@@ -106,7 +116,7 @@ def iter_mod_files(mod_folder: Path, debug: bool) -> Iterator[Path]:
         if file.parent.name == "__pycache__":
             continue
 
-        if file.suffix == ".cpp":
+        if file.suffix not in VALID_MOD_FILE_SUFFIXES:
             continue
         if file.suffix == ".pyd" and file.stem.endswith("_d") != debug:
             continue
@@ -151,7 +161,8 @@ def _zip_mod_folders(zip_file: ZipFile, mod_folders: Sequence[Path], debug: bool
                 )
 
             # Add the license
-            zip_file.write(LICENSE, ZIP_MODS_FOLDER / mod.name / LICENSE.name)
+            license_file = mod / "LICENSE" if mod in MODS_WITH_EXISTING_LICENSE else LICENSE
+            zip_file.write(license_file, ZIP_MODS_FOLDER / mod.name / LICENSE.name)
         else:
             # Otherwise, we can add it as a .sdkmod
             buffer = BytesIO()
@@ -163,7 +174,8 @@ def _zip_mod_folders(zip_file: ZipFile, mod_folders: Sequence[Path], debug: bool
                     )
 
                 # Add the license
-                sdkmod_zip.write(LICENSE, Path(mod.name) / LICENSE.name)
+                license_file = mod / "LICENSE" if mod in MODS_WITH_EXISTING_LICENSE else LICENSE
+                sdkmod_zip.write(license_file, Path(mod.name) / LICENSE.name)
 
             buffer.seek(0)
             zip_file.writestr(
@@ -212,18 +224,6 @@ def _zip_dlls(zip_file: ZipFile, install_dir: Path) -> None:
 
         zip_file.write(file, dest)
 
-    py_stem = next(install_dir.glob("python*.zip")).stem
-    zip_file.writestr(
-        str(ZIP_PLUGINS_FOLDER / (py_stem + "._pth")),
-        textwrap.dedent(
-            f"""
-            {path.relpath(ZIP_MODS_FOLDER, ZIP_PLUGINS_FOLDER)}
-            {py_stem}.zip
-            DLLs
-            """,
-        )[1:-1],
-    )
-
 
 def zip_release(
     output: Path,

libs/pyunrealsdk

@@ -1,16 +1,18 @@
 [tool.pyright]
-pythonVersion = "3.12"
+pythonVersion = "3.13"
 typeCheckingMode = "strict"
+pythonPlatform = "Windows"
 
 include = ["src"]
 stubPath = "libs/pyunrealsdk/stubs"
 reportMissingModuleSource = false
 
 [tool.ruff]
-target-version = "py312"
+target-version = "py313"
 line-length = 100
 
 [tool.ruff.lint]
+# Last time rules scrutinised: ruff 0.6.9 / 2024-10-08
 select = [
     "F",
     "W",

prepare_release.py

@@ -146,7 +146,7 @@ def setup_callback(struct: WrappedStruct) -> None:
         _dialog_stack.append(self)
         show_dialog_box(ENGINE.GameInstance, setup_callback)
 
-    @hook("/Script/OakGame.OakGameInstance:OnNATHelpChoiceMade", Type.PRE, auto_enable=True)
+    @hook("/Script/OakGame.OakGameInstance:OnNATHelpChoiceMade", Type.PRE, immediately_enable=True)
     @staticmethod
     def _on_dialog_closed_hook(
         _1: UObject,

pyproject.toml

@@ -14,6 +14,8 @@
 using namespace unrealsdk::unreal;
 using namespace unrealsdk::memory;
 
+namespace {
+
 bool injecting_next_call = false;
 pyunrealsdk::StaticPyObject configure_callback{};
 
@@ -67,7 +69,7 @@ UGbxGFxDialogBox* show_dialog_hook(UGbxPlayerController* player_controller,
         // To avoid this, swap it out with an empty array for this call
         auto arr = info_struct.get<UArrayProperty>(choices_prop);
         const TArray<void> arr_backup = *arr.base;
-        *arr.base = TArray<void>{nullptr, 0, 0};
+        *arr.base = TArray<void>{.data = nullptr, .count = 0, .max = 0};
 
         try {
             const py::gil_scoped_acquire gil{};
@@ -89,6 +91,8 @@ UGbxGFxDialogBox* show_dialog_hook(UGbxPlayerController* player_controller,
     return show_dialog_ptr(player_controller, info);
 }
 
+}  // namespace
+
 // NOLINTNEXTLINE(readability-identifier-length)
 PYBIND11_MODULE(dialog_box, m) {
     detour(SHOW_DIALOG, show_dialog_hook, &show_dialog_ptr,

src/bl3_mod_menu/dialog_box.py

@@ -11,6 +11,8 @@
 using namespace unrealsdk::unreal;
 using namespace unrealsdk::memory;
 
+namespace {
+
 const constinit Pattern<25> COMBO_BOX_GET_SELECTED_INDEX{
     "48 8B 81 ????????"  // mov rax, [rcx+00000318]
     "48 85 C0"           // test rax, rax
@@ -66,6 +68,8 @@ spinner_get_current_selection_index_func spinner_get_current_selection_index_ptr
         SPINNER_GET_CURRENT_SELECTION_INDEX.sigscan(
             "UGbxGFxListItemSpinner::GetCurrentSelectionIndex"));
 
+}  // namespace
+
 // NOLINTNEXTLINE(readability-identifier-length)
 PYBIND11_MODULE(options_getters, m) {
     m.def(