Merge pull request #2 from apple1417/master

integrate with mods db

Author: apple1417

.github/workflows/build.yml

@@ -81,7 +81,7 @@ jobs:
     - name: Setup Python
       uses: actions/setup-python@v4
       with:
-        python-version: ">=3.10"
+        python-version: ">=3.11"
 
     - name: Checkout repository and submodules
       uses: actions/checkout@v3
@@ -136,6 +136,11 @@ jobs:
     - name: Setup CMake and Ninja
       uses: lukka/get-cmake@latest
 
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: ">=3.11"
+
     - name: Setup msitools
       uses: awalsh128/cache-apt-pkgs-action@latest
       with:
@@ -258,7 +263,7 @@ jobs:
     - name: Setup Python
       uses: actions/setup-python@v4
       with:
-        python-version: ">=3.10"
+        python-version: ">=3.11"
 
     - name: Checkout repository and submodules
       uses: actions/checkout@v3

prepare_release.py

@@ -3,6 +3,7 @@
 import shutil
 import subprocess
 import textwrap
+import tomllib
 from collections.abc import Iterator, Sequence
 from functools import cache
 from io import BytesIO
@@ -244,7 +245,7 @@ def zip_release(
     STUBS_DIR = Path("libs") / "pyunrealsdk" / "stubs"
     SETTINGS_DIR = Path("src") / "settings"
 
-    GIT_VERSION_FILE = BASE_MOD / "git_version.txt"
+    PYPROJECT_FILE = BASE_MOD / "pyproject.toml"
 
     parser = ArgumentParser(description="Prepares a release zip.")
     parser.add_argument(
@@ -275,12 +276,6 @@ def zip_release(
         default=False,
         help="Create a unified release zip. Defaults to off.",
     )
-    parser.add_argument(
-        "--update-git-version-txt",
-        action=BooleanOptionalAction,
-        default=True,
-        help="Updates the `git_version.txt`. Defaults to on.",
-    )
     args = parser.parse_args()
 
     install_dir = INSTALL_DIR_BASE / str(args.preset)
@@ -291,10 +286,18 @@ def zip_release(
 
     assert install_dir.exists() and install_dir.is_dir(), "install dir doesn't exist"
 
-    if args.update_git_version_txt:
-        with GIT_VERSION_FILE.open("w") as file:
-            file.write(get_git_repo_version())
+    # Add the git hash to the displayed version in the pyproject
+    old_pyproject = PYPROJECT_FILE.read_text()
+    version_number = tomllib.loads(old_pyproject)["project"]["version"]
+    git_version = get_git_repo_version()
+    PYPROJECT_FILE.write_text(
+        old_pyproject.replace(
+            "# RELEASE_SCRIPT_REPLACE_ME_WITH_DISPLAY_VERSION",
+            f'version = "{version_number} ({git_version})"',
+        ),
+    )
 
+    # Zip up all the requested files
     COMMON_FOLDERS = (BASE_MOD, KEYBINDS, UI_UTILS)
 
     for prefix, arg, mods in (
@@ -317,3 +320,6 @@ def zip_release(
             SETTINGS_DIR,
             install_dir,
         )
+
+    # Restore the old pyproject contents
+    PYPROJECT_FILE.write_text(old_pyproject)

src/mods_base/.gitignore

@@ -1,13 +1,24 @@
+import tomllib
 from pathlib import Path
 
 import unrealsdk
 from unrealsdk.unreal import UObject
 
+from .dot_sdkmod import open_in_mod_dir
+
 # Need to define a few things first to avoid circular imports
-__version_info__: tuple[int, int] = (1, 0)
-__version__: str = f"{__version_info__[0]}.{__version_info__[1]}"
+with open_in_mod_dir(Path(__file__).parent / "pyproject.toml", binary=True) as _pyproject:
+    # We're being a bit unsafe here, but we know what we expect to see, and given we expect to be
+    # in a .sdkmod it's quite unlikely that a regular user will unknowingly edit it
+    _pyproject_data = tomllib.load(_pyproject)
+    _version_str = _pyproject_data["project"]["version"]
+    _major, _, _minor = _version_str.partition(".")
 
-if True:  # Inner block suppresses E402 for following imports
+    __version_info__: tuple[int, int] = (int(_major), int(_minor))
+    __version__: str = _pyproject_data["tool"]["sdkmod"].get("version", _version_str)
+    del _major, _, _minor, _version_str, _pyproject_data, _pyproject
+
+    # This doesn't need to be in the inner block, but exiting would cause E402 for following imports
     MODS_DIR: Path = (
         _mod_dir
         if (_mod_dir := Path(__file__).parent.parent).is_dir()
@@ -23,7 +34,6 @@
     command,
     remove_next_console_line_capture,
 )
-from .dot_sdkmod import open_in_mod_dir
 from .hook import hook
 from .keybinds import EInputEvent, KeybindType, keybind
 from .mod import Game, Library, Mod, ModType

src/mods_base/__init__.py

@@ -9,13 +9,14 @@
 
 from . import MODS_DIR, __version__
 from .command import AbstractCommand
-from .dot_sdkmod import open_in_mod_dir
 from .hook import HookProtocol
 from .keybinds import KeybindType
 from .mod import Library, Mod, ModType
 from .options import BaseOption, ButtonOption
 from .settings import SETTINGS_DIR
 
+MOD_DB_URL = "https://bl-sdk.github.io/oak-mod-db/"
+
 
 @dataclass
 class BaseMod(Library):
@@ -62,29 +63,26 @@ def description(  # pyright: ignore[reportIncompatibleVariableOverride]
         """No-op description setter."""
 
 
-try:
-    with open_in_mod_dir(Path(__file__).with_name("git_version.txt")) as file:
-        _base_mod_version = f"{__version__} ({file.read().strip()})"
-except FileNotFoundError:
-    _base_mod_version = __version__
-
 mod_list: list[Mod] = [
     base_mod := BaseMod(
         options=[
             ButtonOption(
-                "Open Mods Folder",
+                "Open Mod Database",
+                on_press=lambda _: os.startfile(MOD_DB_URL),  # type: ignore
+            ),
+            ButtonOption(
+                "Open Installed Mods Folder",
                 on_press=lambda _: os.startfile(MODS_DIR),  # type: ignore
             ),
         ],
         components=[
-            BaseMod.ComponentInfo("Base", _base_mod_version),
+            BaseMod.ComponentInfo("Base", __version__),
             # Both of these start their version strings with their module name, strip it out
             BaseMod.ComponentInfo("unrealsdk", unrealsdk.__version__.partition(" ")[2]),
             BaseMod.ComponentInfo("pyunrealsdk", pyunrealsdk.__version__.partition(" ")[2]),
         ],
     ),
 ]
-del _base_mod_version
 
 
 def register_mod(mod: Mod) -> None:

src/mods_base/mod_list.py

@@ -0,0 +1,11 @@
+[project]
+name = "mods_base"
+version = "1.0"
+authors = [{ name = "bl-sdk" }]
+description = "The SDK itself."
+
+[tool.sdkmod]
+name = "Python SDK"
+# RELEASE_SCRIPT_REPLACE_ME_WITH_DISPLAY_VERSION
+license = {name = "LGPL3", url = "https://choosealicense.com/licenses/lgpl-3.0/" }
+download = "https://github.com/bl-sdk/oak-mod-manager/releases/latest"