handle multiple possible cwds

Author: apple1417

prepare_release.py

@@ -8,7 +8,6 @@
 from collections.abc import Iterator
 from functools import cache
 from io import BytesIO
-from os import path
 from pathlib import Path
 from zipfile import ZIP_DEFLATED, ZipFile
 
@@ -20,6 +19,9 @@
 ZIP_SETTINGS_FOLDER = ZIP_MODS_FOLDER / "settings"
 ZIP_EXECUTABLE_FOLDER = Path("Binaries")
 ZIP_PLUGINS_FOLDER = ZIP_EXECUTABLE_FOLDER / "Plugins"
+ZIP_PROXY_INIT_SCRIPT_FOLDERS = [
+    ZIP_EXECUTABLE_FOLDER / ZIP_MODS_FOLDER,
+]
 
 # The base CMake directories - these need the preset added after
 BUILD_DIR_BASE = THIS_FOLDER / "out" / "build"
@@ -36,6 +38,7 @@
 
 # And there are a few extra files which we want which aren't matched by the above
 INIT_SCRIPT = MODS_FOLDER / "__main__.py"
+PROXY_INIT_SCRIPT = MODS_FOLDER / "proxy__main__.py"
 SETTINGS_GITIGNORE = MODS_FOLDER / "settings" / ".gitignore"
 STUBS_DIR = THIS_FOLDER / "libs" / "pyunrealsdk" / "stubs"
 STUBS_LICENSE = THIS_FOLDER / "libs" / "pyunrealsdk" / "LICENSE"
@@ -217,10 +220,17 @@ def zip_config_file(zip_file: ZipFile) -> None:
     Args:
         zip_file: The zip file to add the config file to.
     """
-    # 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)
+    # When launching via Steam, the CWD is (sometimes) `<steam>\Borderlands`. When launching via Mod
+    # Organiser, or by running the exe directly, it's `Borderlands\Binaries`.
+    # Stick with Steam as the default, since if we're not using Steam, the path this checks will
+    # still be inside the game folder.
+    init_script_path = str(ZIP_MODS_FOLDER / INIT_SCRIPT.name)
+    pyexec_root = str(ZIP_MODS_FOLDER)
+
+    # Copy the proxy script to all the spots the relative path might otherwise end up
+    for path in ZIP_PROXY_INIT_SCRIPT_FOLDERS:
+        zip_file.write(PROXY_INIT_SCRIPT, path / INIT_SCRIPT.name)
+        zip_file.writestr(str(path / "Wrong folder, you cannot place sdk mods here!.txt"), "")
 
     version_number = tomllib.loads(MANAGER_PYPROJECT.read_text())["project"]["version"]
     git_version = get_git_repo_version()

src/__main__.py

@@ -102,7 +102,7 @@ def get_all_mod_folders() -> Sequence[Path]:
             Path(x) for x in unrealsdk.config.get("mod_manager", {}).get("extra_folders", [])
         ]
 
-    return [Path(__file__).parent, *extra_folders]
+    return [Path(__file__).resolve().parent, *extra_folders]
 
 
 @cache
@@ -225,7 +225,6 @@ def find_mods_to_import(all_mod_folders: Sequence[Path]) -> Collection[ModInfo]:
                 mod_info = ModInfo(entry.name, entry)
 
             elif entry.is_file() and validate_file_in_mods_folder(entry):
-                # Files are never legacy mods
                 mod_info = ModInfo(entry.stem, entry)
             else:
                 continue

src/proxy__main__.py

@@ -0,0 +1,24 @@
+# When launching via Steam, the CWD is (sometimes) `<steam>\Borderlands`. When launching via Mod
+# Organiser, or by running the exe directly, it's `Borderlands\Binaries`. This means we can't put a
+# single location in the `unrealsdk.toml`.
+# This file is copied into a few different places by the release script, and attempts to normalize
+# the path to the expected location
+
+import importlib.util
+import sys
+from pathlib import Path
+
+from unrealsdk import logging
+
+binaries_dir = Path(sys.executable).resolve().parent
+real_init_script = binaries_dir.parent / "sdk_mods" / "__main__.py"
+
+logging.misc(f"Redirecting init script to: {real_init_script}")
+
+# Use importlib to completely replace ourselves as the root module
+spec = importlib.util.spec_from_file_location("__main__", real_init_script)
+assert spec is not None and spec.loader is not None
+
+module = importlib.util.module_from_spec(spec)
+sys.modules["__main__"] = module
+spec.loader.exec_module(module)