1 files changed, 187 insertions, 0 deletions
diff --git a/libs/basic_games/steam_utils.py b/libs/basic_games/steam_utils.py
new file mode 100644
index 0000000..d1d4a06
--- /dev/null
+++ b/libs/basic_games/steam_utils.py
@@ -0,0 +1,187 @@
+# Code greatly inspired by https://github.com/LostDragonist/steam-library-setup-tool
+
+import sys
+import winreg
+from pathlib import Path
+from typing import TypedDict, cast
+
+import vdf  # pyright: ignore[reportMissingTypeStubs]
+
+
+class SteamGame:
+    def __init__(self, appid: str, installdir: str):
+        self.appid = appid
+        self.installdir = installdir
+
+    def __repr__(self):
+        return str(self)
+
+    def __str__(self):
+        return "{} ({})".format(self.appid, self.installdir)
+
+
+class _AppState(TypedDict):
+    appid: str
+    installdir: str
+
+
+class _AppManifest(TypedDict):
+    AppState: _AppState
+
+
+class _LibraryFolder(TypedDict):
+    path: str
+
+
+class _LibraryFolders(TypedDict, total=False):
+    libraryfolders: dict[str, _LibraryFolder]
+    LibraryFolders: dict[str, str]
+
+
+class LibraryFolder:
+    def __init__(self, path: Path):
+        self.path = path
+
+        self.games: list[SteamGame] = []
+        for filepath in path.joinpath("steamapps").glob("appmanifest_*.acf"):
+            try:
+                with open(filepath, "r", encoding="utf-8") as fp:
+                    info = cast(
+                        _AppManifest,
+                        vdf.load(fp),  # pyright: ignore[reportUnknownMemberType]
+                    )
+                    app_state = info["AppState"]
+            except KeyError:
+                print(
+                    f'Unable to read application state from "{filepath}"',
+                    file=sys.stderr,
+                )
+                continue
+            except Exception as e:
+                print(f'Unable to parse file "{filepath}": {e}', file=sys.stderr)
+                continue
+
+            try:
+                app_id = app_state["appid"]
+                install_dir = app_state["installdir"]
+                self.games.append(SteamGame(app_id, install_dir))
+            except KeyError:
+                print(
+                    f"Unable to read application ID or installation folder "
+                    f'from "{filepath}"',
+                    file=sys.stderr,
+                )
+                continue
+
+    def __repr__(self):
+        return str(self)
+
+    def __str__(self):
+        return "LibraryFolder at {}: {}".format(self.path, self.games)
+
+
+def parse_library_info(library_vdf_path: Path) -> list[LibraryFolder]:
+    """
+    Read library folders from the main library file.
+
+    Args:
+        library_vdf_path: The main library file (from the Steam installation
+            folder).
+
+    Returns:
+        A list of LibraryFolder, for each library found.
+    """
+
+    with open(library_vdf_path, "r", encoding="utf-8") as f:
+        info = cast(
+            _LibraryFolders,
+            vdf.load(f),  # pyright: ignore[reportUnknownMemberType]
+        )
+
+    info_folders: dict[str, str] | dict[str, _LibraryFolder]
+
+    if "libraryfolders" in info:
+        # new format
+        info_folders = info["libraryfolders"]
+
+    elif "LibraryFolders" in info:
+        # old format
+        info_folders = info["LibraryFolders"]
+
+    else:
+        raise ValueError(f'Unknown file format from "{library_vdf_path}"')
+
+    library_folders: list[LibraryFolder] = []
+
+    for key, value in info_folders.items():
+        # only keys that are integer values contains library folder
+        try:
+            int(key)
+        except ValueError:
+            continue
+
+        if isinstance(value, str):
+            path = value
+        else:
+            path = value["path"]
+
+        try:
+            library_folders.append(LibraryFolder(Path(path)))
+        except Exception as e:
+            print(
+                'Failed to read steam library from "{}", {}'.format(path, repr(e)),
+                file=sys.stderr,
+            )
+
+    return library_folders
+
+
+def find_steam_path() -> Path | None:
+    """
+    Retrieve the Steam path, if available.
+
+    Returns:
+        The Steam path, or None if Steam is not installed.
+    """
+    try:
+        with winreg.OpenKey(winreg.HKEY_CURRENT_USER, "Software\\Valve\\Steam") as key:
+            value = winreg.QueryValueEx(key, "SteamExe")
+            return Path(value[0].replace("/", "\\")).parent
+    except FileNotFoundError:
+        return None
+
+
+def find_games() -> dict[str, Path]:
+    """
+    Find the list of Steam games installed.
+
+    Returns:
+        A mapping from Steam game ID to install locations for available
+        Steam games.
+    """
+    steam_path = find_steam_path()
+    if not steam_path:
+        return {}
+
+    library_vdf_path = steam_path.joinpath("steamapps", "libraryfolders.vdf")
+
+    try:
+        library_folders = parse_library_info(library_vdf_path)
+        library_folders.append(LibraryFolder(steam_path))
+    except FileNotFoundError:
+        return {}
+
+    games: dict[str, Path] = {}
+    for library in library_folders:
+        for game in library.games:
+            games[game.appid] = Path(library.path).joinpath(
+                "steamapps", "common", game.installdir
+            )
+
+    return games
+
+
+if __name__ == "__main__":
+    games = find_games()
+    for k, v in games.items():
+        print("Found game with id {} at {}.".format(k, v))