Merge pull request #36 from apple1417/master

add coop support field, update check, tutorial message helper

Author: apple1417

.cruft.json

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

.typos.toml

@@ -7,6 +7,12 @@ extend-exclude = [
     ".typos.toml"
 ]
 
+[default]
+extend-ignore-re = [
+    # Ignore markdown links to github commits/trees
+    "\\[[0-9a-fA-F]+?\\]\\(https://github.com/.+?/.+?/(commit|tree)/.+?\\)",
+]
+
 [default.extend-identifiers]
 llibgcc_s_seh = "llibgcc_s_seh"
 

changelog.md

@@ -5,11 +5,58 @@
 Also see the unrealsdk v1.3.0 changelog [here](https://github.com/bl-sdk/unrealsdk/blob/master/changelog.md#v130)
 and the pyunrealsdk v1.3.0 changelog [here](https://github.com/bl-sdk/pyunrealsdk/blob/master/changelog.md#v130).
 
-## General
+### General
 - Fixed that in some cases a mod couldn't be disabled, or wouldn't enable actively, due to hooks not
   getting added/removed properly.
 
   [unrealsdk@227a93d2](https://github.com/bl-sdk/unrealsdk/commit/227a93d2)
+  
+- Mods now show how well they support coop. This is unknown by default, developers need to set it.
+
+  [db89e4b3](https://github.com/bl-sdk/oak-mod-manager/commit/db89e4b3)
+
+- The mod manager now occasionally checks for updates. These will appear on the "Python SDK" mod
+  menu entry.
+
+  [9bf295b0](https://github.com/bl-sdk/oak-mod-manager/commit/9bf295b0)
+
+### General - Developer
+- Set `PYUNREALSDK_PYEXEC_ROOT` to the sdk mods folder by default.
+
+  [2f15c5ba](https://github.com/bl-sdk/oak-mod-manager/commit/2f15c5ba)
+
+- Fixed that pyright would always error on creating a HiddenOption (due to mismatching generics).
+
+  [9bf295b0](https://github.com/bl-sdk/oak-mod-manager/commit/9bf295b0)
+
+### BL3 Mod Menu v1.3
+- Display mods' coop support.
+
+  [db89e4b3](https://github.com/bl-sdk/oak-mod-manager/commit/db89e4b3)
+
+### Console Mod Menu v1.3
+- Display mods' coop support.
+
+  [db89e4b3](https://github.com/bl-sdk/oak-mod-manager/commit/db89e4b3)
+
+### Mods Base v1.4
+- Added the "Coop Support" field.
+
+  [db89e4b3](https://github.com/bl-sdk/oak-mod-manager/commit/db89e4b3)
+  
+- Automatically check for mod manager updates.
+
+  [9bf295b0](https://github.com/bl-sdk/oak-mod-manager/commit/9bf295b0)
+
+### UI Utils v1.2
+
+- Added a helper to show a tutorial dialog, `show_modal_tutorial_dialog`.
+
+  [51d3c872](https://github.com/bl-sdk/oak-mod-manager/commit/51d3c872)
+
+- Fixed an attribute error when calling `show_hud_message` during a load screen (from a thread).
+
+  [51d3c872](https://github.com/bl-sdk/oak-mod-manager/commit/51d3c872)
 
 ## v1.3
 

manager_pyproject.toml

@@ -12,3 +12,4 @@ authors = [{ name = "bl-sdk" }]
 name = "BL3 / WL Mod Manager"
 license = {name = "LGPL3", url = "https://choosealicense.com/licenses/lgpl-3.0/" }
 download = "https://github.com/bl-sdk/oak-mod-manager/releases/latest"
+coop_support = "ClientSide"

src/__main__.py

@@ -395,7 +395,11 @@ def check_proton_bugs() -> None:
 # Most modules are fine to get imported as a mod/by another mod, but we need to do a few manually.
 # Prefer to import these after console is ready so we can show errors
 import keybinds  # noqa: F401, E402  # pyright: ignore[reportUnusedImport]
+from mods_base.mod_list import register_base_mod  # noqa: E402
 
 import_mods(mods_to_import)
 
+# After importing everything, register the base mod
+register_base_mod()
+
 del mod_folders, mods_to_import

src/bl3_mod_menu/__init__.py

@@ -7,7 +7,7 @@
     "__version_info__",
 ]
 
-__version_info__: tuple[int, int] = (1, 2)
+__version_info__: tuple[int, int] = (1, 3)
 __version__: str = f"{__version_info__[0]}.{__version_info__[1]}"
 __author__: str = "bl-sdk"
 
@@ -42,6 +42,5 @@
             ),
         ),
     )
-    base_mod.load_settings()
 
 base_mod.components.append(base_mod.ComponentInfo("BL3 Mod Menu", __version__))

src/bl3_mod_menu/options_setup.py

@@ -12,6 +12,7 @@
     BaseOption,
     BoolOption,
     ButtonOption,
+    CoopSupport,
     DropdownOption,
     Game,
     GroupedOption,
@@ -189,6 +190,64 @@ def get_option_header() -> str:
     )
 
 
+def create_description_title(mod: Mod) -> str:
+    """
+    Creates the description title to use for a mod's description option.
+
+    Args:
+        mod: The mod to create the title for.
+    Returns:
+        The description title.
+    """
+    description_title = ""
+    if mod.author:
+        description_title += f"By {mod.author}"
+    if mod.author and mod.version:
+        description_title += "  -  "
+    if mod.version:
+        description_title += mod.version
+    return description_title or "Description"
+
+
+def create_description_text(mod: Mod) -> str:
+    """
+    Creates the text to use for a mod's description option.
+
+    Args:
+        mod: The mod to create the title for.
+    Returns:
+        The description text.
+    """
+    blocks: list[str] = []
+
+    if Game.get_current() not in mod.supported_games:
+        supported = [g.name for g in Game if g in mod.supported_games and g.name is not None]
+        blocks.append(
+            "<font color='#ffff00'>Incompatible Game!</font>\n"
+            "This mod supports: " + ", ".join(supported),
+        )
+
+    if mod.description:
+        blocks.append(mod.description)
+
+    match mod.coop_support:
+        case CoopSupport.Unknown:
+            blocks.append("<font color='#e0e0e0'>Coop Support: Unknown</font>")
+        case CoopSupport.Incompatible:
+            blocks.append(
+                "<font color='#e0e0e0'>Coop Support:</font>"
+                " <font color='#ffff00'>Incompatible</font>",
+            )
+        case CoopSupport.RequiresAllPlayers:
+            blocks.append(
+                "<font color='#e0e0e0'>Coop Support: Requires All Players</font>",
+            )
+        case CoopSupport.ClientSide:
+            blocks.append("<font color='#e0e0e0'>Coop Support: Client Side</font>")
+
+    return "\n\n".join(blocks)
+
+
 def get_mod_options(mod: Mod) -> tuple[BaseOption, ...]:
     """
     Gets the full list of mod options to display, including our custom header.
@@ -201,27 +260,11 @@ def get_mod_options(mod: Mod) -> tuple[BaseOption, ...]:
 
     def inner() -> Iterator[BaseOption]:
         # Display the author and version in the title, if they're not the empty string
-        description_title = ""
-        if mod.author:
-            description_title += f"By {mod.author}"
-        if mod.author and mod.version:
-            description_title += "  -  "
-        if mod.version:
-            description_title += mod.version
-        description_title = description_title or "Description"
-
-        description = mod.description
-        if Game.get_current() not in mod.supported_games:
-            supported = [g.name for g in Game if g in mod.supported_games and g.name is not None]
-            description = (
-                "<font color='#ffff00'>Incompatible Game!</font>\r"
-                "This mod supports: " + ", ".join(supported) + "\n\n" + description
-            )
 
         yield ButtonOption(
             "Description",
-            description=description,
-            description_title=description_title,
+            description=create_description_text(mod),
+            description_title=create_description_title(mod),
         )
 
         if not mod.enabling_locked:

src/console_mod_menu/__init__.py

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

src/console_mod_menu/screens/mod.py

@@ -10,6 +10,7 @@
     BaseOption,
     BoolOption,
     ButtonOption,
+    CoopSupport,
     DropdownOption,
     GroupedOption,
     KeybindOption,
@@ -124,7 +125,8 @@ class ModScreen(OptionListScreen):
     def __post_init__(self) -> None:
         self.name = self.mod.name
 
-    def draw(self) -> None:  # noqa: D102
+    def draw_mod_header(self) -> None:
+        """Draws the header for the mod, everything before the options."""
         draw_stack_header()
 
         header = ""
@@ -137,12 +139,26 @@ def draw(self) -> None:  # noqa: D102
         draw(header)
 
         draw(self.mod.get_status())
+
+        match self.mod.coop_support:
+            case CoopSupport.Unknown:
+                draw("Coop Support: Unknown")
+            case CoopSupport.Incompatible:
+                draw("Coop Support: Incompatible")
+            case CoopSupport.RequiresAllPlayers:
+                draw("Coop Support: Requires All Players")
+            case CoopSupport.ClientSide:
+                draw("Coop Support: Client Side")
+
         draw("")
 
         if self.mod.description:
             draw_description(self.mod.description)
             draw("")
 
+    def draw(self) -> None:  # noqa: D102
+        self.draw_mod_header()
+
         if not self.mod.enabling_locked:
             if self.mod.is_enabled:
                 draw("[D] Disable")

src/mods_base/__init__.py

@@ -8,7 +8,7 @@
 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, 3)
+__version_info__: tuple[int, int] = (1, 4)
 __version__: str = f"{__version_info__[0]}.{__version_info__[1]}"
 __author__: str = "bl-sdk"
 
@@ -31,7 +31,7 @@
 from .hook import HookProtocol, hook
 from .html_to_plain_text import html_to_plain_text
 from .keybinds import EInputEvent, KeybindType, keybind
-from .mod import Game, Library, Mod, ModType
+from .mod import CoopSupport, Game, Library, Mod, ModType
 from .mod_factory import build_mod
 from .mod_list import (
     deregister_mod,
@@ -65,6 +65,7 @@
     "ButtonOption",
     "capture_next_console_line",
     "command",
+    "CoopSupport",
     "deregister_mod",
     "DropdownOption",
     "EInputEvent",
@@ -106,7 +107,7 @@ def get_pc() -> UObject: ...
 def get_pc(*, possibly_loading: Literal[True] = True) -> UObject | None: ...
 
 
-def get_pc(*, possibly_loading: bool = False) -> UObject | None:  # noqa: ARG001
+def get_pc(*, possibly_loading: bool = False) -> UObject | None:
     """
     Gets the main (local) player controller object.