Merge pull request #41 from apple1417/master

fix spinner options not working, pull in updates

Author: apple1417

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.13.0)
+set(EXPLICIT_PYTHON_VERSION 3.13.1)
 
 add_subdirectory(libs/pyunrealsdk)
 

Readme.md

@@ -15,22 +15,25 @@ When developing, it's recommended to point pyunrealsdk directly at this repo. To
 
 1. Navigate to the plugins folder - `<game>\OakGame\Binaries\Win64\Plugins\`
 
-2. Edit `python3XX._pth`, replacing `..\..\..\..\sdk_mods` with `<path to repo>\src`. If you have a
-   debug build, also edit `python3XX_d._pth`.
+2. Create/edit `unrealsdk.user.toml`, adding the following:
+   ```toml
+   [pyunrealsdk]
+   init_script = "<path to repo>\\src\\__main__.py"
+   ```
 
-3. Edit `unrealsdk.env`, setting `PYUNREALSDK_INIT_SCRIPT=<path to repo>\src\__main__.py`.
+3. (Optional) Update `pyunrealsdk.pyexec_root` to the same folder, to make sure pyexec commands go
+   where you expect.
 
-4. (Optional) Edit `unrealsdk.env`, adding/updating
-   `OAK_MOD_MANAGER_EXTRA_FOLDERS=["C:\\path\\to\\new\\mod\\folder"]`, pointing at your old
-   `sdk_mods` folder. This is a json list of paths to folders to load, though note it must stay on
-   one line.
+4. (Optional) Add the path to your old `sdk_mods` folder to the `mod_manager.extra_folders` array,
+   so they continue getting loaded.
 
 5. (Optional) Copy/symlink your original settings folder into `src\settings` - settings are only
    loaded from the base mods folder.
 
 Once you've done this, you can modify the python files in place.
 
-To build the native modules:
+## Native code
+The mod manager uses a few native modules. To edit these, or even just the base pyunrealsdk code:
 
 1. Initialize the git submodules.
    ```sh

changelog.md

@@ -1,5 +1,63 @@
 # Changelog
 
+## v1.6: (codename tbd)
+
+### BL3 Mod Menu v1.5
+- Fixed the handling of spinner option updates, so that they're actually usable.
+
+### [Mods Base v1.6](https://github.com/bl-sdk/mods_base/blob/master/Readme.md#v16)
+> - Changed default type of `HookType` generic type hint to any, so that by default pre and post hooks
+>   can be combined under the same type. As an example, previously if you passed an explicit hook list
+>   to `build_mod`, the type hinting would only accept a list where all hooks were of the same type.
+>
+> - Fixed that defining an option, keybind, hook, or command as a class member, and then constructing
+>   it via the `build_mod` factory, would pass empty lists to the constructor and thus prevent the
+>   auto member collection from running.
+>
+> - Changed the display version to be sourced from `mod_manager.display_version` in the unrealsdk
+>   config file, rather than an environment variable.
+>
+> - Gave `@command` and `ArgParseCommand.add_argument` default type hinting for the args they forward.
+
+### Keybinds v2.4
+- Linting fixes.
+
+### [pyunrealsdk v1.5.0](https://github.com/bl-sdk/pyunrealsdk/blob/master/changelog.md#v150)
+> - Deprecated `unrealsdk.hooks.inject_next_call` in favour of a new
+>   `unrealsdk.hooks.prevent_hooking_direct_calls` context manager.
+> 
+> - The `WeakPointer` constructor can now be called with no args, to create a null pointer.
+> 
+> - As with unrealsdk, reworked the configuration system to no longer rely on environment variables.
+>   All sdk configuration is now also done through the `unrealsdk.toml`.
+> 
+>   The full contents of the unrealsdk config are parsed and exposed to Python in `unrealsdk.config`.
+
+### [unrealsdk v1.5.0](https://github.com/bl-sdk/unrealsdk/blob/master/changelog.md#v150)
+> - Completely reworked the configuration system.
+> 
+>   Environment variables and the `unrealsdk.env` are no longer used, due to issues with them not fully
+>   propagating within the same process. The new configuration now uses an `unrealsdk.toml` instead.
+>   
+>   Also added support for a user specific override file - `unrealsdk.user.toml`. This allows projects
+>   to ship their own `unrealsdk.toml`, without overwriting user's settings on update.
+> 
+> - `unrealsdk::hook_manager::inject_next_call` is now thread local.
+> 
+> - Fixed that `unrealsdk::commands::has_command` and `unrealsdk::commands::remove_command` were case
+>   sensitive, while `unrealsdk::commands::add_command` and the callbacks were not. Commands should be
+>   now be case insensitive everywhere.
+> 
+> - Fixed that the executed command message of custom sdk commands would not appear in console if you
+>   increased the minimum log level, and that they may have appeared out of order with respects to
+>   native engine messages.
+> 
+> - Added an additional console command hook in BL2, to cover commands not run directly via console.
+> 
+> - Renamed the `unrealsdk.locking_process_event` (previously `UNREALSDK_LOCKING_PROCESS_EVENT`)
+>   setting to `unrealsdk.locking_function_calls`, and expanded it's scope to cover all function
+>   calls. This fixes a few more possibilities for lockups.
+
 ## v1.5: Time Skip
 
 ### General

libs/pyunrealsdk

@@ -5,7 +5,7 @@
 
 [project]
 name = "oak_mod_manager"
-version = "1.5"
+version = "1.6"
 authors = [{ name = "bl-sdk" }]
 
 [tool.sdkmod]

manager_pyproject.toml

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+import json
 import re
 import shutil
 import subprocess
@@ -74,30 +75,55 @@ def cmake_install(build_dir: Path) -> None:
 
 
 @cache
-def get_git_repo_version() -> str:
+def get_git_commit_hash(identifier: str | None = None) -> str:
     """
-    Gets a version string representing the current state of the git repo.
+    Gets the full commit hash of the current git repo.
 
+    Args:
+        identifier: The identifier of the commit to get, or None to get the latest.
     Returns:
-        The version string.
+        The commit hash.
     """
-    commit_hash = subprocess.run(
-        ["git", "show", "-s", "--format=%H"],
+    args = ["git", "show", "-s", "--format=%H"]
+    if identifier is not None:
+        args.append(identifier)
+
+    return subprocess.run(
+        args,
+        cwd=Path(__file__).parent,
         check=True,
         stdout=subprocess.PIPE,
         encoding="utf8",
     ).stdout.strip()
 
+
+@cache
+def check_git_is_dirty() -> bool:
+    """
+    Checks if the git repo is dirty.
+
+    Returns:
+        True if the repo is dirty.
+    """
     # This command returns the list of modified files, so any output means dirty
-    is_dirty = any(
+    return any(
         subprocess.run(
             ["git", "status", "--porcelain"],
+            cwd=Path(__file__).parent,
             check=True,
             stdout=subprocess.PIPE,
         ).stdout,
     )
 
-    return commit_hash[:8] + (", dirty" if is_dirty else "")
+
+def get_git_repo_version() -> str:
+    """
+    Gets a version string representing the current state of the git repo.
+
+    Returns:
+        The version string.
+    """
+    return get_git_commit_hash()[:8] + (", dirty" if check_git_is_dirty() else "")
 
 
 def iter_mod_files(mod_folder: Path, debug: bool) -> Iterator[Path]:
@@ -132,21 +158,31 @@ def iter_mod_files(mod_folder: Path, debug: bool) -> Iterator[Path]:
 
 
 def _zip_init_script(zip_file: ZipFile) -> None:
-    output_init_script = ZIP_MODS_FOLDER / INIT_SCRIPT.name
-    zip_file.write(INIT_SCRIPT, output_init_script)
-    unrealsdk_env = (
-        # Path.relative_to doesn't work when where's no common base, need to use os.path
-        # While the file goes in the plugins folder, this path is relative to *the executable*
-        f"PYUNREALSDK_INIT_SCRIPT={path.relpath(output_init_script, ZIP_EXECUTABLE_FOLDER)}\n"
-        f"PYUNREALSDK_PYEXEC_ROOT={path.relpath(ZIP_MODS_FOLDER, ZIP_EXECUTABLE_FOLDER)}\n"
-    )
+    zip_file.write(INIT_SCRIPT, ZIP_MODS_FOLDER / INIT_SCRIPT.name)
+
+
+def _zip_config_file(zip_file: ZipFile) -> None:
+    # Path.relative_to doesn't work when where's no common base, need to use os.path
+    # While the file goes in the plugins folder, this path is relative to *the executable*
+    init_script_path = path.relpath(ZIP_MODS_FOLDER / INIT_SCRIPT.name, ZIP_EXECUTABLE_FOLDER)
+    pyexec_root = path.relpath(ZIP_MODS_FOLDER, ZIP_EXECUTABLE_FOLDER)
 
-    # We also define the display version via an env var, do that here too
     version_number = tomllib.loads(PYPROJECT_FILE.read_text())["project"]["version"]
     git_version = get_git_repo_version()
-    unrealsdk_env += f"MOD_MANAGER_DISPLAY_VERSION={version_number} ({git_version})\n"
+    display_version = f"{version_number} ({git_version})"
+
+    # Tomllib doesn't support dumping yet, so we have to create it as a string
+    # Using `json.dumps` to escape strings, since it should be mostly compatible
+    config = (
+        f"[pyunrealsdk]\n"
+        f"init_script = {json.dumps(init_script_path)}\n"
+        f"pyexec_root = {json.dumps(pyexec_root)}\n"
+        f"\n"
+        f"[mod_manager]\n"
+        f"display_version = {json.dumps(display_version)}\n"
+    )
 
-    zip_file.writestr(str(ZIP_PLUGINS_FOLDER / "unrealsdk.env"), unrealsdk_env)
+    zip_file.writestr(str(ZIP_PLUGINS_FOLDER / "unrealsdk.toml"), config)
 
 
 def _zip_mod_folders(zip_file: ZipFile, mod_folders: Sequence[Path], debug: bool) -> None:
@@ -247,6 +283,7 @@ def zip_release(
 
     with ZipFile(output, "w", ZIP_DEFLATED, compresslevel=9) as zip_file:
         _zip_init_script(zip_file)
+        _zip_config_file(zip_file)
         _zip_mod_folders(zip_file, mod_folders, debug)
         _zip_stubs(zip_file)
         _zip_settings(zip_file)
@@ -287,21 +324,23 @@ def zip_release(
     )
     args = parser.parse_args()
 
+    if check_git_is_dirty():
+        print("WARNING: git repo is dirty")
+
     install_dir = INSTALL_DIR_BASE / str(args.preset)
 
     if not args.skip_install:
         shutil.rmtree(install_dir, ignore_errors=True)
         cmake_install(BUILD_DIR_BASE / args.preset)
 
     assert install_dir.exists() and install_dir.is_dir(), "install dir doesn't exist"
-
     # Zip up all the requested files
-    COMMON_FOLDERS = (BASE_MOD, KEYBINDS, UI_UTILS)
+    COMMON_FOLDERS = (BASE_MOD, CONSOLE_MENU, KEYBINDS, UI_UTILS)
 
     for prefix, arg, mods in (
-        ("bl3", args.bl3, (*COMMON_FOLDERS, BL3_MENU, CONSOLE_MENU)),
-        ("wl", args.wl, (*COMMON_FOLDERS, CONSOLE_MENU)),
-        ("unified", args.unified, (*COMMON_FOLDERS, BL3_MENU, CONSOLE_MENU)),
+        ("bl3", args.bl3, (*COMMON_FOLDERS, BL3_MENU)),
+        ("wl", args.wl, COMMON_FOLDERS),
+        ("unified", args.unified, (*COMMON_FOLDERS, BL3_MENU)),
     ):
         if not arg:
             continue

prepare_release.py

@@ -7,7 +7,7 @@
     "__version_info__",
 ]
 
-__version_info__: tuple[int, int] = (1, 4)
+__version_info__: tuple[int, int] = (1, 5)
 __version__: str = f"{__version_info__[0]}.{__version_info__[1]}"
 __author__: str = "bl-sdk"
 

src/bl3_mod_menu/__init__.py

@@ -4,10 +4,10 @@ from unrealsdk.unreal import UObject
 
 __all__: tuple[str, ...] = (
     "add_menu_item",
-    "set_add_menu_item_callback",
     "begin_configure_menu_items",
-    "set_menu_state",
     "get_menu_state",
+    "set_add_menu_item_callback",
+    "set_menu_state",
 )
 
 type _AddMenuItemCallback = Callable[[UObject, str, str, bool, int], int]

src/bl3_mod_menu/native/outer_menu.pyi

@@ -71,7 +71,7 @@ def unimplemented_option_clicked(  # noqa: C901 - imo the match is rated too hig
                 value = round(value)
             option.value = value
         case SpinnerOption():
-            assert button.Class.Name == "GbxGFxListItemComboBox"
+            assert button.Class.Name == "GbxGFxListItemSpinner"
             option.value = option.choices[get_spinner_selected_idx(button)]
         case KeybindOption():
             handle_keybind_press(obj, option)

src/bl3_mod_menu/options_callbacks.py

@@ -13,7 +13,7 @@
     "__version_info__",
 )
 
-__version_info__: tuple[int, int] = (2, 3)
+__version_info__: tuple[int, int] = (2, 4)
 __version__: str = f"{__version_info__[0]}.{__version_info__[1]}"
 __author__: str = "bl-sdk"
 

src/keybinds/__init__.py

@@ -8,8 +8,8 @@ from unrealsdk.hooks import Block
 from mods_base import EInputEvent
 
 __all__: tuple[str, ...] = (
-    "register_keybind",
     "deregister_keybind",
+    "register_keybind",
 )
 
 _KeybindHandle = NewType("_KeybindHandle", object)