Subnautica: fix _Root errors

- Set data path to "" instead of "_Root"
- Exclude unsupported save dir with source=destination mapping

Author: ZashIn

games/game_subnautica-below-zero.py

@@ -7,26 +7,23 @@
 class SubnauticaBelowZeroGame(game_subnautica.SubnauticaGame):
     Name = "Subnautica Below Zero Support Plugin"
     Author = "dekart811, Zash"
-    Version = "2.2"
+    Version = "2.3"
 
     GameName = "Subnautica: Below Zero"
     GameShortName = "subnauticabelowzero"
     GameNexusName = "subnauticabelowzero"
     GameSteamId = 848450
     GameEpicId = "foxglove"
     GameBinary = "SubnauticaZero.exe"
-    GameDataPath = "_ROOT"
-    GameDocumentsDirectory = "%GAME_PATH%"
     GameSupportURL = (
         r"https://github.com/ModOrganizer2/modorganizer-basic_games/wiki/"
         "Game:-Subnautica:-Below-Zero"
     )
-    GameSavesDirectory = r"%GAME_PATH%\SNAppData\SavedGames"
 
-    _game_extra_save_paths = [
+    _game_saves_directory_epic = (
         r"%USERPROFILE%\Appdata\LocalLow\Unknown Worlds"
         r"\Subnautica Below Zero\SubnauticaZero\SavedGames"
-    ]
+    )
 
     def _set_mod_data_checker(
         self, extra_patterns: GlobPatterns | None = None, use_qmod: bool | None = None

games/game_subnautica.py

@@ -2,13 +2,10 @@
 
 import fnmatch
 import os
-from collections.abc import Iterable
-from enum import Enum
 from pathlib import Path
 
-from PyQt6.QtCore import QDir, qWarning
-
 import mobase
+from PyQt6.QtCore import QDir
 
 from ..basic_features import BasicModDataChecker, GlobPatterns
 from ..basic_features.basic_save_game_info import (
@@ -87,15 +84,15 @@ def fix(self, filetree: mobase.IFileTree) -> mobase.IFileTree:
 class SubnauticaGame(BasicGame, mobase.IPluginFileMapper):
     Name = "Subnautica Support Plugin"
     Author = "dekart811, Zash"
-    Version = "2.2"
+    Version = "2.3"
 
     GameName = "Subnautica"
     GameShortName = "subnautica"
     GameNexusName = "subnautica"
     GameSteamId = 264710
     GameEpicId = "Jaguar"
     GameBinary = "Subnautica.exe"
-    GameDataPath = "_ROOT"  # Custom mappings to actual root folders below.
+    GameDataPath = ""
     GameDocumentsDirectory = r"%GAME_PATH%"
     GameSupportURL = (
         r"https://github.com/ModOrganizer2/modorganizer-basic_games/wiki/"
@@ -110,21 +107,6 @@ class SubnauticaGame(BasicGame, mobase.IPluginFileMapper):
 
     _forced_libraries = ["winhttp.dll"]
 
-    _root_blacklist = {GameDataPath.casefold()}
-
-    class MapType(Enum):
-        FILE = 0
-        FOLDER = 1
-
-    _root_extra_overwrites: dict[str, MapType] = {
-        "qmodmanager_log-Subnautica.txt": MapType.FILE,
-        "qmodmanager-config.json": MapType.FILE,
-        "BepInEx_Shim_Backup": MapType.FOLDER,
-    }
-    """Extra files & folders created in game root by mods / BepInEx after game launch,
-    but not included in the mod archives.
-    """
-
     def __init__(self):
         super().__init__()
         mobase.IPluginFileMapper.__init__(self)
@@ -205,73 +187,15 @@ def executableForcedLoads(self) -> list[mobase.ExecutableForcedLoadSetting]:
         ]
 
     def mappings(self) -> list[mobase.Mapping]:
-        game = self._organizer.managedGame()
-        game_path = Path(game.gameDirectory().absolutePath())
-        overwrite_path = Path(self._organizer.overwritePath())
+        game_dir = self._organizer.managedGame().gameDirectory()
 
+        # Save game file writes seem not compatible with USVFS:
+        # exclude save folder from default root mappings (write back to game dir)
         return [
-            *(
-                # Extra overwrites
-                self._overwrite_mapping(
-                    overwrite_path / name,
-                    dest,
-                    is_dir=(map_type is self.MapType.FOLDER),
-                )
-                for name, map_type in self._root_extra_overwrites.items()
-                if not (dest := game_path / name).exists()
-            ),
-            *self._root_mappings(game_path, overwrite_path),
+            mobase.Mapping(
+                source=(source := game_dir.absoluteFilePath("SNAppData")),
+                destination=source,
+                is_directory=True,
+                create_target=True,
+            )
         ]
-
-    def _root_mappings(
-        self, game_path: Path, overwrite_path: Path
-    ) -> Iterable[mobase.Mapping]:
-        for mod_path in self._active_mod_paths():
-            mod_name = mod_path.name
-
-            for child in mod_path.iterdir():
-                # Check blacklist
-                if child.name.casefold() in self._root_blacklist:
-                    qWarning(f"Skipping {child.name} ({mod_name})")
-                    continue
-                destination = game_path / child.name
-                # Check existing
-                if destination.exists():
-                    qWarning(
-                        f"Overwriting of existing game files/folders is not supported! "
-                        f"{destination.as_posix()} ({mod_name})"
-                    )
-                    continue
-                # Mapping: mod -> root
-                yield mobase.Mapping(
-                    source=str(child),
-                    destination=str(destination),
-                    is_directory=child.is_dir(),
-                    create_target=False,
-                )
-                if child.is_dir():
-                    # Mapping: overwrite <-> root
-                    yield self._overwrite_mapping(
-                        overwrite_path / child.name, destination, is_dir=True
-                    )
-
-    def _active_mod_paths(self) -> Iterable[Path]:
-        mods_parent_path = Path(self._organizer.modsPath())
-        modlist = self._organizer.modList().allModsByProfilePriority()
-        for mod in modlist:
-            if self._organizer.modList().state(mod) & mobase.ModState.ACTIVE:
-                yield mods_parent_path / mod
-
-    def _overwrite_mapping(
-        self, overwrite_source: Path, destination: Path, is_dir: bool
-    ) -> mobase.Mapping:
-        """Mapping: overwrite <-> root"""
-        if is_dir:
-            # Root folders in overwrite need to exits.
-            overwrite_source.mkdir(parents=True, exist_ok=True)
-        return mobase.Mapping(
-            str(overwrite_source),
-            str(destination),
-            is_dir,
-            create_target=True,
-        )