Add option to install as mod

Author: ChrisDKN

src/wizards/_install_as_mod.py

@@ -0,0 +1,79 @@
+"""Shared helpers for wizards that can install their payload as a managed mod
+(staging folder + modlist entry + rootFolder=true flag).
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING, Callable
+
+if TYPE_CHECKING:
+    from Games.base_game import BaseGame
+
+
+def derive_mod_name(archive: Path, fallback: str) -> str:
+    """Derive a mod folder name from the archive filename, stripping the
+    extension (including double extensions like ``.tar.gz``).  Falls back to
+    *fallback* when the resulting stem is empty.
+    """
+    stem = archive.name
+    for ext in (".tar.gz", ".tar.bz2", ".tar.xz"):
+        if stem.lower().endswith(ext):
+            stem = stem[: -len(ext)]
+            break
+    else:
+        stem = Path(stem).stem
+    return stem.strip() or fallback
+
+
+def register_as_mod(
+    game: "BaseGame",
+    mod_name: str,
+    archive: Path,
+    *,
+    parent_widget,
+    log_fn: Callable[[str], None],
+) -> None:
+    """Write meta.ini with rootFolder=true, prepend the mod to modlist.txt,
+    and trigger a refresh of the modlist panel if reachable from *parent_widget*.
+
+    Must be called from the worker thread; UI refresh is scheduled via .after().
+    """
+    from Nexus.nexus_meta import NexusModMeta, write_meta
+    from Utils.modlist import prepend_mod
+
+    staging = game.get_effective_mod_staging_path()
+    if staging is None:
+        raise RuntimeError("Mod staging path is not configured.")
+
+    mod_dir = staging / mod_name
+    mod_dir.mkdir(parents=True, exist_ok=True)
+
+    meta = NexusModMeta(
+        mod_name=mod_name,
+        installation_file=archive.name,
+        root_folder=True,
+    )
+    write_meta(mod_dir / "meta.ini", meta)
+
+    mod_panel = None
+    try:
+        toplevel = parent_widget.winfo_toplevel()
+        mod_panel = getattr(toplevel, "_mod_panel", None)
+    except Exception:
+        mod_panel = None
+
+    modlist_path: Path | None = None
+    if mod_panel is not None:
+        modlist_path = getattr(mod_panel, "_modlist_path", None)
+    if modlist_path is None:
+        modlist_path = game.get_profile_root() / "profiles" / "default" / "modlist.txt"
+
+    prepend_mod(modlist_path, mod_name, enabled=True)
+    log_fn(f"Wizard: added '{mod_name}' to modlist with rootFolder=true.")
+
+    if mod_panel is not None:
+        try:
+            mod_panel.after(0, mod_panel.reload_after_install)
+        except Exception as exc:
+            log_fn(f"Wizard: could not trigger mod panel refresh: {exc}")

src/wizards/bepinex.py

@@ -38,6 +38,7 @@
     TEXT_DIM, TEXT_MAIN,
     FONT_NORMAL, FONT_BOLD, FONT_SMALL,
 )
+from wizards._install_as_mod import derive_mod_name, register_as_mod
 
 _ARCHIVE_EXTS = {".zip", ".7z", ".rar", ".tar", ".tar.gz", ".tar.bz2", ".tar.xz"}
 
@@ -179,7 +180,9 @@ def __init__(
         self._chmod_files = chmod_files or []
         self._archive_path: Path | None = None
         self._game_root: Path | None = game.get_game_path()
-        self._install_to_root_folder = ctk.BooleanVar(value=False)
+        # "game" = extract to game folder (default), "root" = Root_Folder staging,
+        # "mod" = install as a managed mod (staging dir + modlist entry + rootFolder flag)
+        self._install_mode = ctk.StringVar(value="game")
 
         title_bar = ctk.CTkFrame(self, fg_color=BG_HEADER, corner_radius=0, height=40)
         title_bar.pack(fill="x")
@@ -206,6 +209,22 @@ def _clear_body(self):
         for w in self._body.winfo_children():
             w.destroy()
 
+    def _build_install_mode_chooser(self, parent) -> ctk.CTkFrame:
+        """Three-way radio: install to game folder, Root_Folder staging, or as a mod."""
+        frame = ctk.CTkFrame(parent, fg_color="transparent")
+        for label, value in (
+            ("Install to game folder", "game"),
+            ("Install to Root_Folder (staging)", "root"),
+            ("Install as mod (managed in modlist)", "mod"),
+        ):
+            ctk.CTkRadioButton(
+                frame, text=label,
+                variable=self._install_mode, value=value,
+                font=FONT_SMALL, text_color=TEXT_DIM,
+                fg_color=ACCENT, hover_color=ACCENT_HOV,
+            ).pack(anchor="w", pady=(0, 2))
+        return frame
+
     # ------------------------------------------------------------------
     # Step 1 \u2014 Download prompt
     # ------------------------------------------------------------------
@@ -245,14 +264,7 @@ def _show_step_download(self):
                 font=FONT_SMALL, text_color="#e06c6c",
             ).pack(pady=(0, 8))
 
-        ctk.CTkCheckBox(
-            self._body,
-            text="Install to Root_Folder (staging) instead of game folder",
-            variable=self._install_to_root_folder,
-            font=FONT_SMALL, text_color=TEXT_DIM,
-            fg_color=ACCENT, hover_color=ACCENT_HOV,
-            checkmark_color="white",
-        ).pack(pady=(0, 12))
+        self._build_install_mode_chooser(self._body).pack(pady=(0, 12))
 
         ctk.CTkButton(
             self._body, text="Next \u2192", width=120, height=36,
@@ -373,38 +385,58 @@ def _show_step_extract(self):
 
     def _do_extract(self):
         try:
-            if self._install_to_root_folder.get():
-                game_root = self._game.get_effective_root_folder_path()
-                game_root.mkdir(parents=True, exist_ok=True)
-            else:
-                game_root = self._game_root
-            if game_root is None:
-                raise RuntimeError("Game path is not configured.")
-
+            mode = self._install_mode.get()
             archive = self._archive_path
             if archive is None or not archive.is_file():
                 raise RuntimeError("Archive not found.")
 
-            self._set_status("Restoring game to vanilla state\u2026")
-            try:
-                self._game.restore(log_fn=self._log)
-            except Exception as exc:
-                self._log(f"Wizard: restore skipped or failed: {exc}")
-
-            self._set_status("Extracting archive to game folder\u2026")
-            self._log(f"Wizard: extracting {archive.name} \u2192 {game_root}")
-
-            paths = _extract_bepinex(archive, game_root, self._inner_folder)
+            install_as_mod = mode == "mod"
+            mod_name: str | None = None
+            if install_as_mod:
+                staging = self._game.get_effective_mod_staging_path()
+                if staging is None:
+                    raise RuntimeError("Mod staging path is not configured.")
+                mod_name = derive_mod_name(archive, fallback="BepInEx")
+                dest = staging / mod_name
+                if dest.exists():
+                    shutil.rmtree(dest, ignore_errors=True)
+                dest.mkdir(parents=True, exist_ok=True)
+            elif mode == "root":
+                dest = self._game.get_effective_root_folder_path()
+                dest.mkdir(parents=True, exist_ok=True)
+            else:
+                dest = self._game_root
+                if dest is None:
+                    raise RuntimeError("Game path is not configured.")
+                self._set_status("Restoring game to vanilla state\u2026")
+                try:
+                    self._game.restore(log_fn=self._log)
+                except Exception as exc:
+                    self._log(f"Wizard: restore skipped or failed: {exc}")
+
+            dest_label = {
+                "mod": f"mod folder ({mod_name})",
+                "root": "Root_Folder (staging)",
+                "game": "game folder",
+            }[mode]
+            self._set_status(f"Extracting archive to {dest_label}\u2026")
+            self._log(f"Wizard: extracting {archive.name} \u2192 {dest}")
+
+            paths = _extract_bepinex(archive, dest, self._inner_folder)
             file_count = len([p for p in paths if p.is_file()])
             self._log(f"Wizard: extracted {file_count} file(s).")
 
             for name in self._chmod_files:
-                target = game_root / name
+                target = dest / name
                 if target.is_file():
                     current = target.stat().st_mode
                     target.chmod(current | stat.S_IXUSR)
                     self._log(f"Wizard: chmod u+x {name}")
 
+            if install_as_mod:
+                register_as_mod(self._game, mod_name, archive,
+                                parent_widget=self, log_fn=self._log)
+
             try:
                 archive.unlink()
                 self._log(f"Wizard: deleted {archive.name} from Downloads.")
@@ -420,7 +452,6 @@ def _do_extract(self):
                     "  ./start_game_bepinex.sh %command%"
                 )
 
-            dest_label = "Root_Folder (staging)" if self._install_to_root_folder.get() else "game folder"
             self._set_status(
                 f"BepInEx installed successfully!\n"
                 f"{file_count} file(s) extracted to the {dest_label}."

src/wizards/script_extender.py

@@ -38,6 +38,7 @@
     TEXT_DIM, TEXT_MAIN,
     FONT_NORMAL, FONT_BOLD, FONT_SMALL,
 )
+from wizards._install_as_mod import derive_mod_name, register_as_mod
 
 _ARCHIVE_EXTS = {".zip", ".7z", ".rar", ".tar", ".tar.gz", ".tar.bz2", ".tar.xz"}
 
@@ -207,7 +208,9 @@ def __init__(
         self._archive_path: Path | None = None
         self._resolved_download_url: str | None = None
         self._game_root: Path | None = game.get_game_path()
-        self._install_to_root_folder = ctk.BooleanVar(value=False)
+        # "game" = extract to game folder (default), "root" = Root_Folder staging,
+        # "mod" = install as a managed mod (staging dir + modlist entry + rootFolder flag)
+        self._install_mode = ctk.StringVar(value="game")
 
         title_bar = ctk.CTkFrame(self, fg_color=BG_HEADER, corner_radius=0, height=40)
         title_bar.pack(fill="x")
@@ -237,6 +240,22 @@ def _clear_body(self):
         for w in self._body.winfo_children():
             w.destroy()
 
+    def _build_install_mode_chooser(self, parent) -> ctk.CTkFrame:
+        """Three-way radio: install to game folder, Root_Folder staging, or as a mod."""
+        frame = ctk.CTkFrame(parent, fg_color="transparent")
+        for label, value in (
+            ("Install to game folder", "game"),
+            ("Install to Root_Folder (staging)", "root"),
+            ("Install as mod (managed in modlist)", "mod"),
+        ):
+            ctk.CTkRadioButton(
+                frame, text=label,
+                variable=self._install_mode, value=value,
+                font=FONT_SMALL, text_color=TEXT_DIM,
+                fg_color=ACCENT, hover_color=ACCENT_HOV,
+            ).pack(anchor="w", pady=(0, 2))
+        return frame
+
     # ------------------------------------------------------------------
     # Step 1 — Download (GitHub auto-download or manual page fallback)
     # ------------------------------------------------------------------
@@ -322,14 +341,7 @@ def _show_step_download_github(self):
         self._dl_progress.pack(pady=(0, 16))
         self._dl_progress.start()
 
-        ctk.CTkCheckBox(
-            self._body,
-            text="Install to Root_Folder (staging) instead of game folder",
-            variable=self._install_to_root_folder,
-            font=FONT_SMALL, text_color=TEXT_DIM,
-            fg_color=ACCENT, hover_color=ACCENT_HOV,
-            checkmark_color="white",
-        ).pack(pady=(0, 8))
+        self._build_install_mode_chooser(self._body).pack(pady=(0, 8))
 
         btn_frame = ctk.CTkFrame(self._body, fg_color="transparent")
         btn_frame.pack(side="bottom", pady=(8, 0))
@@ -448,14 +460,7 @@ def _show_step_download_manual(self):
                 font=FONT_SMALL, text_color="#e06c6c",
             ).pack(pady=(0, 8))
 
-        ctk.CTkCheckBox(
-            self._body,
-            text="Install to Root_Folder (staging) instead of game folder",
-            variable=self._install_to_root_folder,
-            font=FONT_SMALL, text_color=TEXT_DIM,
-            fg_color=ACCENT, hover_color=ACCENT_HOV,
-            checkmark_color="white",
-        ).pack(pady=(0, 12))
+        self._build_install_mode_chooser(self._body).pack(pady=(0, 12))
 
         ctk.CTkButton(
             self._body, text="Next \u2192", width=120, height=36,
@@ -564,38 +569,57 @@ def _show_step_extract(self):
 
     def _do_extract(self):
         try:
-            if self._install_to_root_folder.get():
-                game_root = self._game.get_effective_root_folder_path()
-                game_root.mkdir(parents=True, exist_ok=True)
-            else:
-                game_root = self._game_root
-            if game_root is None:
-                raise RuntimeError("Game path is not configured.")
-
+            mode = self._install_mode.get()
             archive = self._archive_path
             if archive is None or not archive.is_file():
                 raise RuntimeError("Archive not found.")
 
-            self._set_status("Restoring game to vanilla state\u2026")
-            try:
-                self._game.restore(log_fn=self._log)
-            except Exception as exc:
-                self._log(f"Wizard: restore skipped or failed: {exc}")
-
-            self._set_status("Extracting archive to game folder\u2026")
-            self._log(f"Wizard: extracting {archive.name} \u2192 {game_root}")
-
-            paths = _extract_archive(archive, game_root)
+            install_as_mod = mode == "mod"
+            mod_name: str | None = None
+            if install_as_mod:
+                staging = self._game.get_effective_mod_staging_path()
+                if staging is None:
+                    raise RuntimeError("Mod staging path is not configured.")
+                mod_name = derive_mod_name(archive, fallback="Script Extender")
+                dest = staging / mod_name
+                if dest.exists():
+                    shutil.rmtree(dest, ignore_errors=True)
+                dest.mkdir(parents=True, exist_ok=True)
+            elif mode == "root":
+                dest = self._game.get_effective_root_folder_path()
+                dest.mkdir(parents=True, exist_ok=True)
+            else:
+                dest = self._game_root
+                if dest is None:
+                    raise RuntimeError("Game path is not configured.")
+                self._set_status("Restoring game to vanilla state\u2026")
+                try:
+                    self._game.restore(log_fn=self._log)
+                except Exception as exc:
+                    self._log(f"Wizard: restore skipped or failed: {exc}")
+
+            dest_label = {
+                "mod": f"mod folder ({mod_name})",
+                "root": "Root_Folder (staging)",
+                "game": "game folder",
+            }[mode]
+            self._set_status(f"Extracting archive to {dest_label}\u2026")
+            self._log(f"Wizard: extracting {archive.name} \u2192 {dest}")
+
+            paths = _extract_archive(archive, dest)
             file_count = len([p for p in paths if p.is_file()])
             self._log(f"Wizard: extracted {file_count} file(s).")
 
+            if install_as_mod:
+                register_as_mod(self._game, mod_name, archive,
+                                parent_widget=self, log_fn=self._log)
+
             try:
                 archive.unlink()
                 self._log(f"Wizard: deleted {archive.name} from Downloads.")
             except OSError as exc:
                 self._log(f"Wizard: could not delete archive: {exc}")
 
-            dest_label = "Root_Folder (staging)" if self._install_to_root_folder.get() else "game folder"
             self._set_status(
                 f"Script extender installed successfully!\n"
                 f"{file_count} file(s) extracted to the {dest_label}.\n\n"