Merge pull request #277 from Root-Core/trivial_changes

Refactor: some "trivial" changes

Author: GloriousEggroll

.github/scripts/steam_client.py

@@ -8,45 +8,60 @@
 from steam.utils.proto import proto_to_dict
 from typing import Any
 
+class Steam:
+    """Minimal implementation of the SteamClient package that allows app id validation"""
 
-class Steam:  # noqa: D101
-    def __init__(self) -> None:  # noqa: D107
+    def __init__(self) -> None:
+        """Setup SteamClient and it's events
+
+        Raises:
+            ValueError: When the SteamClient fires it's "error" event
+
+        """
         self.logged_on_once = False
 
         self.steam = client = SteamClient()
 
-        @client.on('error')
+        # FIXME: pyright outputs 'error: Object of type "None" cannot be called (reportOptionalCall)'
+        @client.on(SteamClient.EVENT_ERROR) # pyright: ignore (reportOptionalCall)
         def handle_error(result: EResult) -> None:
             raise ValueError(f'Steam error: {repr(result)}')
 
-        @client.on('connected')
+        @client.on(SteamClient.EVENT_CONNECTED) # pyright: ignore (reportOptionalCall)
         def handle_connected() -> None:
             print(f'Connected to {client.current_server_addr}', file=sys.stderr)
 
-        @client.on('channel_secured')
+        @client.on(SteamClient.EVENT_CHANNEL_SECURED) # pyright: ignore (reportOptionalCall)
         def send_login() -> None:
             if self.logged_on_once and self.steam.relogin_available:
                 self.steam.relogin()
 
-        @client.on('disconnected')
+        @client.on(SteamClient.EVENT_DISCONNECTED) # pyright: ignore (reportOptionalCall)
         def handle_disconnect() -> None:
             print('Steam disconnected', file=sys.stderr)
             if self.logged_on_once:
                 print('Reconnecting...', file=sys.stderr)
                 client.reconnect(maxdelay=30)
 
-        @client.on('logged_on')
+        @client.on(SteamClient.EVENT_LOGGED_ON) # pyright: ignore (reportOptionalCall)
         def handle_after_logon() -> None:
             self.logged_on_once = True
 
         client.anonymous_login()
 
+
     def get_valid_appids(self, appids: set[int]) -> set[int]:
         """Queries Steam for the specified appids.
 
-        If an appid doesn't exist, it won't be in the response.
+        Args:
+            appids (set[int]): The app ids that should be validated
+
+        Raises:
+            ValueError: When the response is empty / unexpected
+
+        Returns:
+            set[int]: Only valid app ids will be returned
 
-        Raises a ValueError if Steam returns unexpected data
         """
         # https://github.com/SteamRE/SteamKit/blob/master/SteamKit2/SteamKit2/Base/Generated/SteamMsgClientServerAppInfo.cs#L331
         resp = self.steam.send_job_and_wait(

fix.py

@@ -8,6 +8,7 @@
 from functools import lru_cache
 from importlib import import_module
 
+from .util import ProtonVersion
 from .config import config
 from .checks import run_checks
 from .logger import log
@@ -184,5 +185,6 @@ def main() -> None:
         log.debug('Not running protonfixes for setup runs')
         return
 
-    log.info('Running protonfixes')
+    version = ProtonVersion.from_version_file()
+    log.info(f'Running protonfixes on "{version.version_name}", build at {version.build_date}.')
     run_fix(get_game_id())

gamefixes-steam/105400.py

@@ -23,4 +23,4 @@ def main() -> None:
     if os.path.exists(dirpath):
         shutil.rmtree(dirpath)
     else:
-        log(f"Path '{dirpath}' could not be found")
+        log.info(f"Path '{dirpath}' could not be found")

gamefixes-steam/1449280.py

@@ -13,4 +13,4 @@ def main() -> None:
     try:
         Path(save_dir).mkdir(parents=True, exist_ok=True)
     except OSError as e:
-        log(f"Not able to make the settings directory at '{save_dir}': {e}")
+        log.warn(f"Not able to make the settings directory at '{save_dir}': {e}")

gamefixes-steam/1873170.py

@@ -1,5 +1,5 @@
 """Cease to Breathe
-Replace included nwjs(0.71) wich doesn't work with 0.86
+Replace included nwjs (0.71) - which doesn't work - with 0.86
 Fix cursor hitbox (set frame=false in package.json)
 Updated from 0.85 that didn't display custom cursors.
 """

gamefixes-steam/22330.py

@@ -12,7 +12,6 @@
 
 import os
 
-from dataclasses import dataclass
 from protonfixes import util
 
 
@@ -24,19 +23,11 @@ def main_with_id(game_id: str) -> None:
 
     # Run script extender if it exists.
     mapping = get_redirect_name(game_id)
-    if os.path.isfile(mapping.to_name):
-        util.replace_command(mapping.from_name, mapping.to_name)
+    if os.path.isfile(mapping.to_value):
+        util.replace_command(mapping.from_value, mapping.to_value)
 
 
-@dataclass
-class Redirect:
-    """Used for replacements"""
-
-    from_name: str
-    to_name: str
-
-
-def get_redirect_name(game_id: str) -> Redirect:
+def get_redirect_name(game_id: str) -> util.ReplaceType:
     """Mapping for SteamID -> script extender replacements"""
     mapping = {
         '22380': ('FalloutNV.exe', 'nvse_loader.exe'),  # Fallout New Vegas
@@ -51,4 +42,4 @@ def get_redirect_name(game_id: str) -> Redirect:
         '489830': ('SkyrimSELauncher.exe', 'skse64_loader.exe'),  # Skyrim SE
         '1716740': ('Starfield.exe', 'sfse_loader.exe'),  # Starfield
     }.get(game_id, ('', ''))
-    return Redirect(*mapping)
+    return util.ReplaceType(*mapping)

gamefixes-steam/2475980.py

@@ -1,33 +1,29 @@
-"""Gobliiins 5
+"""Gobliiins 5 (and Demo - 2505910)
 Setup doesn't work and language is default to french
 """
 
-import os
-import sys
-import subprocess
-import glob
 from protonfixes import util
 
 
-def main() -> None:
-    if sys.argv[2].find('winsetup') != -1:
-        os.chdir(sys.argv[2][-29:-13])
+def main_with_id(game_id: str) -> None:
+    """The game consists of 4 parts, that are located in their own folder
+    They each have a separate config, that needs to be patched
 
-    install_dir = glob.escape(util.get_game_install_path())
-    with open(
-        os.path.join(install_dir, 'Gobliiins5-Part4/acsetup.cfg'), encoding='utf-8'
-    ) as f:
-        if 'Linear' not in f.read():
-            for i in range(1, 5):
-                subprocess.call(
-                    [
-                        f"sed -i 's/filter=stdscale/filter=Linear/' {install_dir}/Gobliiins5-Part{i}/acsetup.cfg"
-                    ],
-                    shell=True,
-                )
-                subprocess.call(
-                    [
-                        f"sed -i 's/translation.*/translation=English/' {install_dir}/Gobliiins5-Part{i}/acsetup.cfg"
-                    ],
-                    shell=True,
-                )
+    The demo launches from it's install directory and doesn't need a subfolder
+    """
+    cfg_str = """
+    [language]
+    translation=English
+
+    [graphics]
+    filter=Linear
+    """
+
+    # Demo
+    if game_id == '2505910':
+        util.set_ini_options(cfg_str, 'acsetup.cfg', 'utf-8', 'game')#
+        return
+
+    # Full
+    for i in range(1, 5):
+        util.set_ini_options(cfg_str, f'Gobliiins5-Part{i}/acsetup.cfg', 'utf-8', 'game')

gamefixes-steam/2505910.py

@@ -0,0 +1 @@
+2475980.py

gamefixes-steam/294700.py

@@ -1,27 +1,24 @@
 """Game fix for Putt-Putt: Pep's Birthday Surprise"""
 
-import os
 from protonfixes import util
 
 
-# Putt-Putt: PBS doesn't run unless there is a CD-ROM drive attached.
 def main() -> None:
-    dosdevice = os.path.join(util.protonprefix(), 'dosdevices/r:')
-    if not os.path.exists(dosdevice):
-        os.symlink('/tmp', dosdevice)  # create symlink for dosdevices
+    """The game doesn't run unless there is a CD-ROM drive attached."""
+    util.create_dos_device()
 
+    # sets up ID? exported from regedit
     util.regedit_add(
         'HKLM\\System\\MountedDevices',
         '\\??\\Volume{00000000-0000-0000-0000-000000000052}',
         'REG_BINARY',
         '2f746d7000',
-    )  # sets up ID? exported from regedit
+    )
+
+    # sets up dosdevice? exported from regedit
     util.regedit_add(
         'HKLM\\System\\MountedDevices',
         '\\DosDevices\\R:',
         'REG_BINARY',
         '5c005c002e005c0064003a000000',
-    )  # sets up dosdevice? exported from regedit
-    util.regedit_add(
-        'HKLM\\Software\\Wine\\Drives', 'r:', 'REG_SZ', 'cdrom', True
-    )  # designate drive as CD-ROM, requires 64-bit access
+    )

gamefixes-steam/39500.py

@@ -1,6 +1,5 @@
-"""Game fix for Gothic 3"""
+"""Game fix for Gothic 3 (and Forsaken Gods Enhanced Edition)"""
 
-import os
 from protonfixes import util
 
 
@@ -12,4 +11,4 @@ def main() -> None:
     FpS.Max=0
     """
 
-    util.set_ini_options(game_opts, os.path.join('Ini', 'ge3.ini'), 'cp1251', 'game')
+    util.set_ini_options(game_opts, 'Ini/ge3.ini', 'cp1251', 'game')