Add support for STALKER: Shadow of Chernobyl.

.github/workflows/linters.yml

@@ -5,22 +5,20 @@ on: [push, pull_request]
 jobs:
   checks:
     runs-on: ubuntu-latest
-    strategy:
-      max-parallel: 4
-      matrix:
-        python-version: [3.8]
-
     steps:
-    - uses: actions/checkout@v1
-      with:
-        path: basic_games
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v1
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install tox
-    - name: Test with tox
-      run: tox -e py38-lint
+      - uses: actions/checkout@v4
+        with:
+          path: "basic_games"
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.11
+      - uses: abatilo/actions-poetry@v2
+      - name: Install
+        run: |
+          cd basic_games
+          poetry install
+      - name: Lint
+        run: |
+          cd basic_games
+          poetry run poe lint-all

.gitignore

@@ -1,5 +1,6 @@
 .mypy_cache
 __pycache__
+.venv
 .tox
 .vscode
 .idea

README.md

@@ -25,7 +25,7 @@ Download the archive for your MO2 version and extract it directly into your MO2
 **Important:** Extract the *folder* in your `plugins` folder, not the individual files. Your
 `plugins` folder should look like this:
 
-```
+```text
 dlls/
 plugins/
   data/
@@ -152,6 +152,7 @@ class Witcher3Game(BasicGame):
 | GameLauncher | Name of the game launcher, relative to the game path  (Optional) | `getLauncherName` | `str` |
 | GameDataPath | Name of the folder containing mods, relative to game folder| `dataDirectory` | |
 | GameDocumentsDirectory | Documents directory (Optional) | `documentsDirectory` | `str` or `QDir` |
+| GameIniFiles | Config files in documents, for profile specific config (Optional) | `iniFiles` | `str` or `List[str]` |
 | GameSavesDirectory | Directory containing saves (Optional, default to `GameDocumentsDirectory`) | `savesDirectory` | `str` or `QDir` |
 | GameSaveExtension | Save file extension (Optional) `savegameExtension` | `str` |
 | GameSteamId | Steam ID of the game (Optional) | `steamAPPId` | `List[str]` or `str` or `int` |
@@ -176,10 +177,13 @@ The meta-plugin provides some useful extra feature:
   `GameOriginManifestIds`, `GameEpicId` or `GameEaDesktopId`), the game will be listed
   in the list of available games when creating a new MO2 instance (if the game is
   installed via Steam, GOG, Origin, Epic Games / Legendary or EA Desktop).
-2. **Basic save game preview:** If you use the Python version, and if you can easily obtain a picture (file)
-  for any saves, you can provide basic save-game preview by using the `BasicGameSaveGameInfo`.
-  See [games/game_witcher3.py](games/game_witcher3.py) for  more details.
-3. **Basic mod data checker** (Python):
+2. **Basic save game preview / metadata** (Python): If you can easily obtain a picture
+  (file) and/or metadata (like from json) for any saves, you can provide basic save-game
+  preview by using the `BasicGameSaveGameInfo`. See
+  [games/game_witcher3.py](games/game_witcher3.py) and
+  [games/game_bladeandsorcery.py](games/game_bladeandsorcery.py) for more details.
+3. **Basic local save games** (Python): profile specific save games, as in [games/game_valheim.py](games/game_valheim.py).
+4. **Basic mod data checker** (Python):
   Check and fix different mod archive layouts for an automatic installation with the proper
   file structure, using simple (glob) patterns via `BasicModDataChecker`.
   See [games/game_valheim.py](games/game_valheim.py) and [game_subnautica.py](games/game_subnautica.py) for an example.
@@ -195,3 +199,23 @@ Game IDs can be found here:
 - For Legendary (alt. Epic launcher) via command `legendary list-games`
     or from: `%USERPROFILE%\.config\legendary\installed.json`
 - For EA Desktop from `<EA Games install location>\<game title>\__Installer\installerdata.xml`
+
+## Contribute
+
+We recommend using a dedicated Python environment to write a new basic game plugins.
+
+1. Install the required version of Python --- Currently Python 3.11 (MO2 2.5).
+2. Remove the repository at `${MO2_INSTALL}/plugins/basic_games`.
+3. Clone this repository at the location of the old plugin (
+  `${MO2_INSTALL}/plugins/basic_games`).
+4. Place yourself inside the cloned folder and:
+
+  ```bash
+  # create a virtual environment (recommended)
+  py -3.11 -m venv .\venv
+  .\venv\scripts\Activate.ps1
+
+  # "install" poetry and the development package
+  pip install poetry
+  poetry install
+  ```

__init__.py

@@ -1,4 +1,4 @@
-# -*- encoding: utf-8 -*-
+# pyright: reportUnboundVariable=false
 
 import glob
 import importlib
@@ -17,7 +17,6 @@
 
 
 def createPlugins():
-
     # List of game class from python:
     game_plugins: typing.List[BasicGame] = []
 

basic_features/__init__.py

@@ -1,4 +1,10 @@
-# -*- encoding: utf-8 -*-
+from .basic_local_savegames import BasicLocalSavegames
+from .basic_mod_data_checker import BasicModDataChecker, GlobPatterns
+from .basic_save_game_info import BasicGameSaveGameInfo
 
-from .basic_mod_data_checker import BasicModDataChecker  # noqa
-from .basic_save_game_info import BasicGameSaveGameInfo  # noqa
+__all__ = [
+    "BasicModDataChecker",
+    "BasicGameSaveGameInfo",
+    "GlobPatterns",
+    "BasicLocalSavegames",
+]

basic_features/basic_local_savegames.py

@@ -0,0 +1,21 @@
+import mobase
+from PyQt6.QtCore import QDir
+
+
+class BasicLocalSavegames(mobase.LocalSavegames):
+    def __init__(self, game_save_dir: QDir):
+        super().__init__()
+        self._game_saves_dir = game_save_dir.absolutePath()
+
+    def mappings(self, profile_save_dir: QDir):
+        return [
+            mobase.Mapping(
+                source=profile_save_dir.absolutePath(),
+                destination=self._game_saves_dir,
+                is_directory=True,
+                create_target=True,
+            )
+        ]
+
+    def prepareProfile(self, profile: mobase.IProfile) -> bool:
+        return profile.localSavesEnabled()