{dllStats.error || "Failed to get DLL stats"}
- ) : (
-
-
- dllStats.dll_path && copyToClipboard(dllStats.dll_path)}
- onActivate={() => dllStats.dll_path && copyToClipboard(dllStats.dll_path)}
- >
- {dllStats.dll_path || t('NERD_NOT_AVAILABLE', 'Not available')}
-
-
-
-
- dllStats.dll_sha256 && copyToClipboard(dllStats.dll_sha256)}
- onActivate={() => dllStats.dll_sha256 && copyToClipboard(dllStats.dll_sha256)}
- >
- {dllStats.dll_sha256 ? formatSHA256(dllStats.dll_sha256) : t('NERD_NOT_AVAILABLE', 'Not available')}
-
-
-
- {dllStats.dll_source && (
-
-
- )}
-
- )}
-
- )}
-
{/* Launch Script Section */}
{scriptContent && (
{dllStats.dll_source}
-
- {dllDetected ? "✅" : "❌"}
+ {losslessScalingInstalled ? "✅" : "❌"}
- {dllDetectionStatus}
+ {losslessScalingInstalled ? "Lossless Scaling Installed" : "Lossless Scaling Not Installed"}
+ {!losslessScalingInstalled && losslessScalingStatus && (
+
+ {losslessScalingStatus}
+
+ )}
void,
setInstallationStatus: (value: string) => void,
- reloadConfig?: () => Promise
+ reloadConfig?: () => Promise,
+ reloadStatus?: () => Promise
) => {
setIsInstalling(true);
setInstallationStatus("Installing lsfg-vk...");
@@ -30,6 +31,9 @@ export function useInstallationActions() {
if (reloadConfig) {
await reloadConfig();
}
+ if (reloadStatus) {
+ await reloadStatus();
+ }
} else {
setInstallationStatus(`Installation failed: ${result.error}`);
showInstallErrorToast(result.error);
@@ -44,7 +48,8 @@ export function useInstallationActions() {
const handleUninstall = async (
setIsInstalled: (value: boolean) => void,
- setInstallationStatus: (value: string) => void
+ setInstallationStatus: (value: string) => void,
+ reloadStatus?: () => Promise
) => {
setIsUninstalling(true);
setInstallationStatus("Uninstalling lsfg-vk...");
@@ -54,6 +59,9 @@ export function useInstallationActions() {
if (result.success) {
setIsInstalled(false);
setInstallationStatus("lsfg-vk uninstalled successfully!");
+ if (reloadStatus) {
+ await reloadStatus();
+ }
showUninstallSuccessToast();
} else {
setInstallationStatus(`Uninstallation failed: ${result.error}`);
diff --git a/src/hooks/useLsfgHooks.ts b/src/hooks/useLsfgHooks.ts
index d9bbe3e..597110e 100644
--- a/src/hooks/useLsfgHooks.ts
+++ b/src/hooks/useLsfgHooks.ts
@@ -1,7 +1,6 @@
import { useState, useEffect, useCallback } from "react";
import {
checkLsfgVkInstalled,
- checkLosslessScalingDll,
getLsfgConfig,
updateLsfgConfigFromObject,
type ConfigUpdateResult
@@ -12,11 +11,15 @@ import { showErrorToast, ToastMessages } from "../utils/toastUtils";
export function useInstallationStatus() {
const [isInstalled, setIsInstalled] = useState(false);
const [installationStatus, setInstallationStatus] = useState("");
+ const [losslessScalingInstalled, setLosslessScalingInstalled] = useState(false);
+ const [losslessScalingStatus, setLosslessScalingStatus] = useState("");
const checkInstallation = async () => {
try {
const status = await checkLsfgVkInstalled();
setIsInstalled(status.installed);
+ setLosslessScalingInstalled(status.lossless_scaling_installed);
+ setLosslessScalingStatus(status.lossless_scaling_status || "Lossless Scaling Not Installed");
if (status.installed) {
setInstallationStatus("lsfg-vk Installed");
} else {
@@ -24,6 +27,8 @@ export function useInstallationStatus() {
}
return status.installed;
} catch (error) {
+ setLosslessScalingInstalled(false);
+ setLosslessScalingStatus("Lossless Scaling Not Installed");
setInstallationStatus("lsfg-vk Not Installed");
return false;
}
@@ -38,38 +43,12 @@ export function useInstallationStatus() {
installationStatus,
setIsInstalled,
setInstallationStatus,
+ losslessScalingInstalled,
+ losslessScalingStatus,
checkInstallation
};
}
-export function useDllDetection() {
- const [dllDetected, setDllDetected] = useState(false);
- const [dllDetectionStatus, setDllDetectionStatus] = useState("");
-
- const checkDllDetection = async () => {
- try {
- const result = await checkLosslessScalingDll();
- setDllDetected(result.detected);
- if (result.detected) {
- setDllDetectionStatus("Lossless Scaling Installed");
- } else {
- setDllDetectionStatus("Lossless Scaling Not Installed");
- }
- } catch (error) {
- setDllDetectionStatus("Lossless Scaling Not Installed");
- }
- };
-
- useEffect(() => {
- checkDllDetection();
- }, []);
-
- return {
- dllDetected,
- dllDetectionStatus
- };
-}
-
export function useLsfgConfig() {
const [config, setConfig] = useState(() => getDefaults());
diff --git a/src/i18n/languages.json b/src/i18n/languages.json
index c1a49b8..46b4cd9 100644
--- a/src/i18n/languages.json
+++ b/src/i18n/languages.json
@@ -67,10 +67,6 @@
"FLATPAK_STEP_FINAL": "最終的な結果はこのようになります:",
"FLATPAK_CLOSE": "閉じる",
"NERD_LOADING": "情報を読み込み中...",
- "NERD_DLL_PATH": "DLLパス",
- "NERD_NOT_AVAILABLE": "利用不可",
- "NERD_DLL_HASH": "DLL SHA256ハッシュ",
- "NERD_DETECTION_SOURCE": "検出ソース",
"NERD_LAUNCH_SCRIPT": "起動スクリプト",
"NERD_SCRIPT_NOT_FOUND_PREFIX": "スクリプトが見つかりません:",
"NERD_PATH_PREFIX": "パス:",
@@ -174,10 +170,6 @@
"FLATPAK_STEP_FINAL": "최종 결과는 다음과 같아야 합니다:",
"FLATPAK_CLOSE": "닫기",
"NERD_LOADING": "정보 불러오는 중...",
- "NERD_DLL_PATH": "DLL 경로",
- "NERD_NOT_AVAILABLE": "사용 불가",
- "NERD_DLL_HASH": "DLL SHA256 해시",
- "NERD_DETECTION_SOURCE": "감지 소스",
"NERD_LAUNCH_SCRIPT": "실행 스크립트",
"NERD_SCRIPT_NOT_FOUND_PREFIX": "스크립트 없음:",
"NERD_PATH_PREFIX": "경로:",
@@ -309,10 +301,6 @@
"FLATPAK_STEP_FINAL": "Final result should look like:",
"FLATPAK_CLOSE": "Close",
"NERD_LOADING": "Loading information...",
- "NERD_DLL_PATH": "DLL Path",
- "NERD_NOT_AVAILABLE": "Not available",
- "NERD_DLL_HASH": "DLL SHA256 Hash",
- "NERD_DETECTION_SOURCE": "Detection Source",
"NERD_LAUNCH_SCRIPT": "Launch Script",
"NERD_SCRIPT_NOT_FOUND_PREFIX": "Script not found:",
"NERD_PATH_PREFIX": "Path:",
--
cgit v1.2.3
From 89e64a7dbddb8f713dd2ca37131924e8bd8ab51f Mon Sep 17 00:00:00 2001
From: xXJSONDeruloXx
Date: Sat, 5 Sep 2026 23:58:16 -0400
Subject: feat: select Lossless Scaling lsfg-vk branch
---
py_modules/lsfg_vk/constants.py | 2 +
py_modules/lsfg_vk/plugin.py | 8 ++
py_modules/lsfg_vk/steam_service.py | 273 ++++++++++++++++++++++++++++++++++++
py_modules/lsfg_vk/types.py | 17 +++
src/api/lsfgApi.ts | 19 +++
src/components/Content.tsx | 22 +++
src/components/StatusDisplay.tsx | 115 ++++++++++-----
src/hooks/useLsfgHooks.ts | 46 +++++-
8 files changed, 463 insertions(+), 39 deletions(-)
create mode 100644 py_modules/lsfg_vk/steam_service.py
diff --git a/py_modules/lsfg_vk/constants.py b/py_modules/lsfg_vk/constants.py
index 1f78a59..19df278 100644
--- a/py_modules/lsfg_vk/constants.py
+++ b/py_modules/lsfg_vk/constants.py
@@ -18,6 +18,8 @@ UI_ICON_FILENAME = "gay.pancake.lsfg-vk-ui.png"
FLATPAK_23_08_FILENAME = "org.freedesktop.Platform.VulkanLayer.lsfg_vk_23.08.flatpak"
FLATPAK_24_08_FILENAME = "org.freedesktop.Platform.VulkanLayer.lsfg_vk_24.08.flatpak"
FLATPAK_25_08_FILENAME = "org.freedesktop.Platform.VulkanLayer.lsfg_vk_25.08.flatpak"
+STEAM_LOSSLESS_SCALING_APP_ID = "993090"
+STEAM_LOSSLESS_SCALING_BRANCH = "lsfg-vk"
LEGACY_LIB_FILENAME = "liblsfg-vk.so"
LEGACY_JSON_FILENAME = "VkLayer_LS_frame_generation.json"
diff --git a/py_modules/lsfg_vk/plugin.py b/py_modules/lsfg_vk/plugin.py
index 6a8dfc5..1676566 100644
--- a/py_modules/lsfg_vk/plugin.py
+++ b/py_modules/lsfg_vk/plugin.py
@@ -16,6 +16,7 @@ from .configuration import ConfigurationService
from .config_schema import ConfigurationManager
from .flatpak_service import FlatpakService
from .runtime_service import RuntimeService
+from .steam_service import SteamService
class Plugin:
@@ -33,6 +34,7 @@ class Plugin:
self.installation_service = InstallationService(runtime_service=self.runtime_service)
self.configuration_service = ConfigurationService(runtime_service=self.runtime_service)
self.flatpak_service = FlatpakService()
+ self.steam_service = SteamService()
async def install_lsfg_vk(self) -> Dict[str, Any]:
"""Install the bundled lsfg-vk runtime to ~/.local
@@ -320,6 +322,12 @@ class Plugin:
"""
return self.flatpak_service.get_flatpak_apps()
+ async def get_lossless_scaling_branch_status(self) -> Dict[str, Any]:
+ return self.steam_service.get_branch_status()
+
+ async def select_lossless_scaling_branch(self) -> Dict[str, Any]:
+ return self.steam_service.select_branch()
+
async def set_flatpak_app_override(self, app_id: str) -> Dict[str, Any]:
"""Set lsfg-vk overrides for a Flatpak app
diff --git a/py_modules/lsfg_vk/steam_service.py b/py_modules/lsfg_vk/steam_service.py
new file mode 100644
index 0000000..3278f3c
--- /dev/null
+++ b/py_modules/lsfg_vk/steam_service.py
@@ -0,0 +1,273 @@
+import os
+import re
+import tempfile
+from pathlib import Path
+from typing import Dict, Optional, Tuple
+
+from .base_service import BaseService
+from .constants import STEAM_LOSSLESS_SCALING_APP_ID, STEAM_LOSSLESS_SCALING_BRANCH
+
+
+class SteamService(BaseService):
+ DEFAULT_BRANCH = "public"
+ MANIFEST_FILENAME = f"appmanifest_{STEAM_LOSSLESS_SCALING_APP_ID}.acf"
+
+ def _steam_library_roots(self):
+ candidates = (
+ self.user_home / ".local/share/Steam",
+ self.user_home / ".steam/steam",
+ self.user_home / ".steam/root",
+ self.user_home / ".var/app/com.valvesoftware.Steam/.local/share/Steam",
+ )
+ seen = set()
+
+ for candidate in candidates:
+ yield from self._unique_existing_root(candidate, seen)
+
+ library_file = candidate / "steamapps/libraryfolders.vdf"
+ try:
+ content = library_file.read_text(encoding="utf-8")
+ except OSError:
+ continue
+
+ for raw_path in re.findall(r'(?m)^\s*"path"\s+"((?:\\.|[^"])*)"', content):
+ path = raw_path.replace(r'\"', '"').replace(r'\\', '\\')
+ yield from self._unique_existing_root(Path(path), seen)
+
+ @staticmethod
+ def _unique_existing_root(path: Path, seen: set[str]):
+ if not path.exists():
+ return
+ try:
+ resolved = str(path.resolve())
+ except OSError:
+ resolved = str(path)
+ if resolved in seen:
+ return
+ seen.add(resolved)
+ yield path
+
+ def _manifest_path(self) -> Optional[Path]:
+ for library_root in self._steam_library_roots():
+ manifest = library_root / "steamapps" / self.MANIFEST_FILENAME
+ if manifest.is_file():
+ return manifest
+ return None
+
+ @staticmethod
+ def _section_bounds(content: str, section_name: str) -> Optional[Tuple[int, int, str]]:
+ section = re.search(
+ rf'(?m)^(?P[ \t]*)"{re.escape(section_name)}"[ \t\r\n]*\{{',
+ content,
+ )
+ if section is None:
+ return None
+
+ depth = 1
+ in_string = False
+ escaped = False
+ for index in range(section.end(), len(content)):
+ character = content[index]
+ if in_string:
+ if escaped:
+ escaped = False
+ elif character == "\\":
+ escaped = True
+ elif character == '"':
+ in_string = False
+ continue
+
+ if character == '"':
+ in_string = True
+ elif character == "{":
+ depth += 1
+ elif character == "}":
+ depth -= 1
+ if depth == 0:
+ return section.end(), index, section.group("indent")
+ return None
+
+ @classmethod
+ def _section_value(cls, content: str, section_name: str, key: str) -> Optional[str]:
+ bounds = cls._section_bounds(content, section_name)
+ if bounds is None:
+ return None
+ body_start, body_end, _ = bounds
+ pattern = re.compile(
+ r'(?m)^[ \t]*"(?P[^"]+)"[ \t]+"(?P(?:\\.|[^"\\])*)"'
+ )
+ for match in pattern.finditer(content, body_start, body_end):
+ if match.group("key") == key:
+ return match.group("value")
+ return None
+
+ @classmethod
+ def _set_section_value(cls, content: str, section_name: str, key: str, value: str) -> str:
+ bounds = cls._section_bounds(content, section_name)
+ if bounds is None:
+ if section_name != "UserConfig":
+ raise ValueError(f"Steam manifest is missing the {section_name} section")
+ app_state = cls._section_bounds(content, "AppState")
+ if app_state is None:
+ raise ValueError("Steam manifest is missing the AppState section")
+ _, app_state_end, app_state_indent = app_state
+ prefix = content[:app_state_end]
+ if not prefix.endswith(("\n", "\r")):
+ prefix += "\n"
+ entry_indent = app_state_indent + "\t"
+ section = (
+ f'{entry_indent}"UserConfig"\n'
+ f'{entry_indent}{{\n'
+ f'{entry_indent}\t"{key}"\t"{value}"\n'
+ f'{entry_indent}}}\n'
+ )
+ return prefix + section + content[app_state_end:]
+
+ body_start, body_end, section_indent = bounds
+ pattern = re.compile(
+ rf'(?m)^[ \t]*"{re.escape(key)}"[ \t]+"(?P(?:\\.|[^"\\])*)"'
+ )
+ match = pattern.search(content, body_start, body_end)
+ if match is not None:
+ return content[: match.start("value")] + value + content[match.end("value") :]
+
+ prefix = content[:body_end]
+ if not prefix.endswith(("\n", "\r")):
+ prefix += "\n"
+ entry_indent = section_indent + "\t"
+ return prefix + f'{entry_indent}"{key}"\t"{value}"\n' + content[body_end:]
+
+ @classmethod
+ def _branch_or_default(cls, branch: Optional[str]) -> str:
+ return branch or cls.DEFAULT_BRANCH
+
+ def _status_fields(self, manifest_path: Path, content: str) -> Dict[str, object]:
+ selected_branch = self._branch_or_default(
+ self._section_value(content, "UserConfig", "BetaKey")
+ )
+ current_branch = self._branch_or_default(
+ self._section_value(content, "MountedConfig", "BetaKey")
+ or self._section_value(content, "UserConfig", "BetaKey")
+ )
+ needs_switch = (
+ selected_branch != STEAM_LOSSLESS_SCALING_BRANCH
+ or current_branch != STEAM_LOSSLESS_SCALING_BRANCH
+ )
+ return {
+ "installed": True,
+ "manifest_path": str(manifest_path),
+ "selected_branch": selected_branch,
+ "current_branch": current_branch,
+ "target_branch": STEAM_LOSSLESS_SCALING_BRANCH,
+ "needs_switch": needs_switch,
+ "restart_required": (
+ selected_branch == STEAM_LOSSLESS_SCALING_BRANCH
+ and current_branch != STEAM_LOSSLESS_SCALING_BRANCH
+ ),
+ }
+
+ def get_branch_status(self) -> Dict[str, object]:
+ try:
+ manifest_path = self._manifest_path()
+ if manifest_path is None:
+ return self._success_response(
+ dict,
+ "Lossless Scaling is not installed through Steam",
+ installed=False,
+ manifest_path=None,
+ selected_branch=None,
+ current_branch=None,
+ target_branch=STEAM_LOSSLESS_SCALING_BRANCH,
+ needs_switch=False,
+ restart_required=False,
+ )
+
+ content = manifest_path.read_text(encoding="utf-8")
+ fields = self._status_fields(manifest_path, content)
+ if not fields["needs_switch"]:
+ message = "Lossless Scaling is using the lsfg-vk Steam branch"
+ elif fields["restart_required"]:
+ message = "lsfg-vk is selected; restart Steam to finish the branch switch"
+ else:
+ message = "Lossless Scaling is not using the lsfg-vk Steam branch"
+ return self._success_response(dict, message, **fields)
+ except Exception as error:
+ return self._error_response(
+ dict,
+ str(error),
+ installed=False,
+ manifest_path=None,
+ selected_branch=None,
+ current_branch=None,
+ target_branch=STEAM_LOSSLESS_SCALING_BRANCH,
+ needs_switch=False,
+ restart_required=False,
+ )
+
+ def select_branch(self) -> Dict[str, object]:
+ try:
+ manifest_path = self._manifest_path()
+ if manifest_path is None:
+ raise FileNotFoundError("Lossless Scaling is not installed through Steam")
+
+ content = manifest_path.read_text(encoding="utf-8")
+ fields = self._status_fields(manifest_path, content)
+ if not fields["needs_switch"]:
+ return self._success_response(
+ dict,
+ "Lossless Scaling is already using the lsfg-vk Steam branch",
+ changed=False,
+ **fields,
+ )
+
+ updated = self._set_section_value(
+ content,
+ "UserConfig",
+ "BetaKey",
+ STEAM_LOSSLESS_SCALING_BRANCH,
+ )
+ if updated != content:
+ file_mode = manifest_path.stat().st_mode & 0o777
+ temporary_path = None
+ try:
+ with tempfile.NamedTemporaryFile(
+ mode="w",
+ encoding="utf-8",
+ dir=manifest_path.parent,
+ prefix=f".{manifest_path.name}.",
+ delete=False,
+ ) as temporary_file:
+ temporary_path = Path(temporary_file.name)
+ temporary_file.write(updated)
+ temporary_file.flush()
+ os.fsync(temporary_file.fileno())
+ temporary_path.chmod(file_mode)
+ os.replace(temporary_path, manifest_path)
+ except Exception:
+ if temporary_path is not None:
+ temporary_path.unlink(missing_ok=True)
+ raise
+
+ new_fields = dict(fields)
+ new_fields["selected_branch"] = STEAM_LOSSLESS_SCALING_BRANCH
+ new_fields["needs_switch"] = new_fields["current_branch"] != STEAM_LOSSLESS_SCALING_BRANCH
+ new_fields["restart_required"] = new_fields["needs_switch"]
+ return self._success_response(
+ dict,
+ "lsfg-vk selected for Lossless Scaling; restart Steam to download it",
+ changed=updated != content,
+ **new_fields,
+ )
+ except Exception as error:
+ return self._error_response(
+ dict,
+ str(error),
+ changed=False,
+ installed=False,
+ manifest_path=None,
+ selected_branch=None,
+ current_branch=None,
+ target_branch=STEAM_LOSSLESS_SCALING_BRANCH,
+ needs_switch=False,
+ restart_required=False,
+ )
diff --git a/py_modules/lsfg_vk/types.py b/py_modules/lsfg_vk/types.py
index 0f0428b..96ce23b 100644
--- a/py_modules/lsfg_vk/types.py
+++ b/py_modules/lsfg_vk/types.py
@@ -42,6 +42,23 @@ class InstallationCheckResponse(TypedDict):
error: Optional[str]
+class SteamBranchStatusResponse(TypedDict):
+ success: bool
+ message: str
+ error: Optional[str]
+ installed: bool
+ manifest_path: Optional[str]
+ selected_branch: Optional[str]
+ current_branch: Optional[str]
+ target_branch: str
+ needs_switch: bool
+ restart_required: bool
+
+
+class SteamBranchOperationResponse(SteamBranchStatusResponse):
+ changed: bool
+
+
class ConfigurationResponse(BaseResponse):
"""Response for configuration operations"""
config: Optional[ConfigurationData]
diff --git a/src/api/lsfgApi.ts b/src/api/lsfgApi.ts
index 68cf6bf..64d43cb 100644
--- a/src/api/lsfgApi.ts
+++ b/src/api/lsfgApi.ts
@@ -16,6 +16,23 @@ export interface InstallationStatus {
error?: string;
}
+export interface SteamBranchStatus {
+ success: boolean;
+ message: string;
+ error?: string;
+ installed: boolean;
+ manifest_path?: string;
+ selected_branch?: string;
+ current_branch?: string;
+ target_branch: string;
+ needs_switch: boolean;
+ restart_required: boolean;
+}
+
+export interface SteamBranchOperationResult extends SteamBranchStatus {
+ changed: boolean;
+}
+
// Use centralized configuration data type
export type LsfgConfig = ConfigurationData;
@@ -112,6 +129,8 @@ export interface ProfileResult {
export const installLsfgVk = callable<[], InstallationResult>("install_lsfg_vk");
export const uninstallLsfgVk = callable<[], InstallationResult>("uninstall_lsfg_vk");
export const checkLsfgVkInstalled = callable<[], InstallationStatus>("check_lsfg_vk_installed");
+export const getLosslessScalingBranchStatus = callable<[], SteamBranchStatus>("get_lossless_scaling_branch_status");
+export const selectLosslessScalingBranch = callable<[], SteamBranchOperationResult>("select_lossless_scaling_branch");
export const getLsfgConfig = callable<[], ConfigResult>("get_lsfg_config");
export const getConfigSchema = callable<[], ConfigSchemaResult>("get_config_schema");
export const getLaunchOption = callable<[], LaunchOptionResult>("get_launch_option");
diff --git a/src/components/Content.tsx b/src/components/Content.tsx
index aab2fb8..4e4e33a 100644
--- a/src/components/Content.tsx
+++ b/src/components/Content.tsx
@@ -15,6 +15,7 @@ import { NerdStuffModal } from "./NerdStuffModal";
import { FlatpaksModal } from "./FlatpaksModal";
import { ConfigurationData } from "../config/configSchema";
import t from '../i18n/i18n';
+import { showErrorToast, showSuccessToast } from "../utils/toastUtils";
export function Content() {
const {
@@ -24,6 +25,9 @@ export function Content() {
setInstallationStatus,
losslessScalingInstalled,
losslessScalingStatus,
+ steamBranchStatus,
+ isSwitchingSteamBranch,
+ selectLosslessScalingBranch,
checkInstallation
} = useInstallationStatus();
@@ -67,6 +71,18 @@ export function Content() {
handleUninstall(setIsInstalled, setInstallationStatus, checkInstallation);
};
+ const onSelectLosslessScalingBranch = async () => {
+ const result = await selectLosslessScalingBranch();
+ if (result.success) {
+ showSuccessToast("Steam branch selected", result.message);
+ } else {
+ showErrorToast(
+ "Steam branch selection failed",
+ result.error || "Unable to select the lsfg-vk Steam branch"
+ );
+ }
+ };
+
const handleShowNerdStuff = () => {
showModal( void;
}
export function StatusDisplay({
isInstalled,
installationStatus,
losslessScalingInstalled,
- losslessScalingStatus
+ losslessScalingStatus,
+ steamBranchStatus,
+ isSwitchingSteamBranch,
+ onSelectLosslessScalingBranch
}: StatusDisplayProps) {
return (
-
-
- {steamBranchStatus.needs_switch && (
-
-
)}
-
- {losslessScalingInstalled ? "✅" : "❌"}
-
- {losslessScalingInstalled ? "Lossless Scaling Installed" : "Lossless Scaling Not Installed"}
-
- {!losslessScalingInstalled && losslessScalingStatus && (
-
- {losslessScalingStatus}
+ <>
+
+
+
+
+ {losslessScalingInstalled && steamBranchStatus?.installed && (
+
+
+ )}
+
);
}
diff --git a/src/hooks/useLsfgHooks.ts b/src/hooks/useLsfgHooks.ts
index 597110e..dfbf2cd 100644
--- a/src/hooks/useLsfgHooks.ts
+++ b/src/hooks/useLsfgHooks.ts
@@ -2,8 +2,12 @@ import { useState, useEffect, useCallback } from "react";
import {
checkLsfgVkInstalled,
getLsfgConfig,
+ getLosslessScalingBranchStatus,
+ selectLosslessScalingBranch,
updateLsfgConfigFromObject,
- type ConfigUpdateResult
+ type ConfigUpdateResult,
+ type SteamBranchOperationResult,
+ type SteamBranchStatus
} from "../api/lsfgApi";
import { ConfigurationData, getDefaults } from "../config/configSchema";
import { showErrorToast, ToastMessages } from "../utils/toastUtils";
@@ -13,8 +17,17 @@ export function useInstallationStatus() {
const [installationStatus, setInstallationStatus] = useState("");
const [losslessScalingInstalled, setLosslessScalingInstalled] = useState(false);
const [losslessScalingStatus, setLosslessScalingStatus] = useState("");
+ const [steamBranchStatus, setSteamBranchStatus] = useState(null);
+ const [isSwitchingSteamBranch, setIsSwitchingSteamBranch] = useState(false);
const checkInstallation = async () => {
+ try {
+ setSteamBranchStatus(await getLosslessScalingBranchStatus());
+ } catch (error) {
+ console.error("Error checking Lossless Scaling Steam branch:", error);
+ setSteamBranchStatus(null);
+ }
+
try {
const status = await checkLsfgVkInstalled();
setIsInstalled(status.installed);
@@ -27,6 +40,7 @@ export function useInstallationStatus() {
}
return status.installed;
} catch (error) {
+ setSteamBranchStatus(null);
setLosslessScalingInstalled(false);
setLosslessScalingStatus("Lossless Scaling Not Installed");
setInstallationStatus("lsfg-vk Not Installed");
@@ -34,6 +48,33 @@ export function useInstallationStatus() {
}
};
+ const selectLosslessScalingBranchForUser = async (): Promise => {
+ setIsSwitchingSteamBranch(true);
+ try {
+ const result = await selectLosslessScalingBranch();
+ setSteamBranchStatus(result);
+ return result;
+ } catch (error) {
+ const result: SteamBranchOperationResult = {
+ success: false,
+ message: "",
+ error: String(error),
+ installed: false,
+ manifest_path: undefined,
+ selected_branch: undefined,
+ current_branch: undefined,
+ target_branch: "lsfg-vk",
+ needs_switch: false,
+ restart_required: false,
+ changed: false
+ };
+ setSteamBranchStatus(result);
+ return result;
+ } finally {
+ setIsSwitchingSteamBranch(false);
+ }
+ };
+
useEffect(() => {
checkInstallation();
}, []);
@@ -45,6 +86,9 @@ export function useInstallationStatus() {
setInstallationStatus,
losslessScalingInstalled,
losslessScalingStatus,
+ steamBranchStatus,
+ isSwitchingSteamBranch,
+ selectLosslessScalingBranch: selectLosslessScalingBranchForUser,
checkInstallation
};
}
--
cgit v1.2.3
From f9352694a78a2bcfd00d237398a2b30de14c70be Mon Sep 17 00:00:00 2001
From: xXJSONDeruloXx
Date: Sun, 6 Sep 2026 00:06:58 -0400
Subject: fix: show Steam branch recovery action
---
src/components/StatusDisplay.tsx | 12 +++++++-----
1 file changed, 7 insertions(+), 5 deletions(-)
diff --git a/src/components/StatusDisplay.tsx b/src/components/StatusDisplay.tsx
index b6290b0..5eb1823 100644
--- a/src/components/StatusDisplay.tsx
+++ b/src/components/StatusDisplay.tsx
@@ -20,13 +20,15 @@ export function StatusDisplay({
isSwitchingSteamBranch,
onSelectLosslessScalingBranch
}: StatusDisplayProps) {
+ const losslessScalingAppInstalled = losslessScalingInstalled || steamBranchStatus?.installed === true;
+
return (
<>
- {losslessScalingInstalled && steamBranchStatus?.installed && (
+ {steamBranchStatus?.installed && (
@@ -80,15 +70,6 @@ export function StatusDisplay({
+
-
+
+ {losslessScalingInstalled ? "✅" : "❌"}
+
+ {losslessScalingInstalled ? "Lossless Scaling Installed" : "Lossless Scaling Not Installed"}
+
+ {!losslessScalingInstalled && losslessScalingStatus && (
+
+ {losslessScalingStatus}
+
+ )}
+
+
+ {isInstalled ? "✅" : "❌"}
+
+ {installationStatus}
- )}
-
-
- {isInstalled ? "✅" : "❌"}
-
- {installationStatus}
-
+
+ {isSwitchingSteamBranch ? "Selecting lsfg-vk..." : "Use lsfg-vk Steam branch"}
+
+ )}
+
+
+ Steam branch: {steamBranchStatus.current_branch || "public"}
+ {steamBranchStatus.needs_switch && (
+
+ {steamBranchStatus.needs_switch && (
+
+ {steamBranchStatus.message}
+
+ )}
+
- {losslessScalingInstalled ? "✅" : "❌"}
+ {losslessScalingAppInstalled ? "✅" : "❌"}
- {losslessScalingInstalled ? "Lossless Scaling Installed" : "Lossless Scaling Not Installed"}
+ {losslessScalingAppInstalled ? "Lossless Scaling Installed" : "Lossless Scaling Not Installed"}
- {!losslessScalingInstalled && losslessScalingStatus && (
+ {!losslessScalingAppInstalled && losslessScalingStatus && (
{losslessScalingStatus}
@@ -61,7 +63,7 @@ export function StatusDisplay({
Date: Sun, 6 Sep 2026 00:16:19 -0400
Subject: refactor: make Steam branch integration read-only
---
py_modules/lsfg_vk/plugin.py | 3 -
py_modules/lsfg_vk/steam_service.py | 106 ---------------------------------
py_modules/lsfg_vk/types.py | 5 --
scripts/generate_python_boilerplate.py | 2 +-
scripts/generate_ts_schema.py | 8 +--
src/api/lsfgApi.ts | 5 --
src/components/Content.tsx | 19 ------
src/components/StatusDisplay.tsx | 23 +------
src/hooks/useLsfgHooks.ts | 32 ----------
9 files changed, 7 insertions(+), 196 deletions(-)
diff --git a/py_modules/lsfg_vk/plugin.py b/py_modules/lsfg_vk/plugin.py
index 1676566..f764086 100644
--- a/py_modules/lsfg_vk/plugin.py
+++ b/py_modules/lsfg_vk/plugin.py
@@ -325,9 +325,6 @@ class Plugin:
async def get_lossless_scaling_branch_status(self) -> Dict[str, Any]:
return self.steam_service.get_branch_status()
- async def select_lossless_scaling_branch(self) -> Dict[str, Any]:
- return self.steam_service.select_branch()
-
async def set_flatpak_app_override(self, app_id: str) -> Dict[str, Any]:
"""Set lsfg-vk overrides for a Flatpak app
diff --git a/py_modules/lsfg_vk/steam_service.py b/py_modules/lsfg_vk/steam_service.py
index 3278f3c..867a135 100644
--- a/py_modules/lsfg_vk/steam_service.py
+++ b/py_modules/lsfg_vk/steam_service.py
@@ -1,6 +1,4 @@
-import os
import re
-import tempfile
from pathlib import Path
from typing import Dict, Optional, Tuple
@@ -101,42 +99,6 @@ class SteamService(BaseService):
return match.group("value")
return None
- @classmethod
- def _set_section_value(cls, content: str, section_name: str, key: str, value: str) -> str:
- bounds = cls._section_bounds(content, section_name)
- if bounds is None:
- if section_name != "UserConfig":
- raise ValueError(f"Steam manifest is missing the {section_name} section")
- app_state = cls._section_bounds(content, "AppState")
- if app_state is None:
- raise ValueError("Steam manifest is missing the AppState section")
- _, app_state_end, app_state_indent = app_state
- prefix = content[:app_state_end]
- if not prefix.endswith(("\n", "\r")):
- prefix += "\n"
- entry_indent = app_state_indent + "\t"
- section = (
- f'{entry_indent}"UserConfig"\n'
- f'{entry_indent}{{\n'
- f'{entry_indent}\t"{key}"\t"{value}"\n'
- f'{entry_indent}}}\n'
- )
- return prefix + section + content[app_state_end:]
-
- body_start, body_end, section_indent = bounds
- pattern = re.compile(
- rf'(?m)^[ \t]*"{re.escape(key)}"[ \t]+"(?P(?:\\.|[^"\\])*)"'
- )
- match = pattern.search(content, body_start, body_end)
- if match is not None:
- return content[: match.start("value")] + value + content[match.end("value") :]
-
- prefix = content[:body_end]
- if not prefix.endswith(("\n", "\r")):
- prefix += "\n"
- entry_indent = section_indent + "\t"
- return prefix + f'{entry_indent}"{key}"\t"{value}"\n' + content[body_end:]
-
@classmethod
def _branch_or_default(cls, branch: Optional[str]) -> str:
return branch or cls.DEFAULT_BRANCH
@@ -203,71 +165,3 @@ class SteamService(BaseService):
needs_switch=False,
restart_required=False,
)
-
- def select_branch(self) -> Dict[str, object]:
- try:
- manifest_path = self._manifest_path()
- if manifest_path is None:
- raise FileNotFoundError("Lossless Scaling is not installed through Steam")
-
- content = manifest_path.read_text(encoding="utf-8")
- fields = self._status_fields(manifest_path, content)
- if not fields["needs_switch"]:
- return self._success_response(
- dict,
- "Lossless Scaling is already using the lsfg-vk Steam branch",
- changed=False,
- **fields,
- )
-
- updated = self._set_section_value(
- content,
- "UserConfig",
- "BetaKey",
- STEAM_LOSSLESS_SCALING_BRANCH,
- )
- if updated != content:
- file_mode = manifest_path.stat().st_mode & 0o777
- temporary_path = None
- try:
- with tempfile.NamedTemporaryFile(
- mode="w",
- encoding="utf-8",
- dir=manifest_path.parent,
- prefix=f".{manifest_path.name}.",
- delete=False,
- ) as temporary_file:
- temporary_path = Path(temporary_file.name)
- temporary_file.write(updated)
- temporary_file.flush()
- os.fsync(temporary_file.fileno())
- temporary_path.chmod(file_mode)
- os.replace(temporary_path, manifest_path)
- except Exception:
- if temporary_path is not None:
- temporary_path.unlink(missing_ok=True)
- raise
-
- new_fields = dict(fields)
- new_fields["selected_branch"] = STEAM_LOSSLESS_SCALING_BRANCH
- new_fields["needs_switch"] = new_fields["current_branch"] != STEAM_LOSSLESS_SCALING_BRANCH
- new_fields["restart_required"] = new_fields["needs_switch"]
- return self._success_response(
- dict,
- "lsfg-vk selected for Lossless Scaling; restart Steam to download it",
- changed=updated != content,
- **new_fields,
- )
- except Exception as error:
- return self._error_response(
- dict,
- str(error),
- changed=False,
- installed=False,
- manifest_path=None,
- selected_branch=None,
- current_branch=None,
- target_branch=STEAM_LOSSLESS_SCALING_BRANCH,
- needs_switch=False,
- restart_required=False,
- )
diff --git a/py_modules/lsfg_vk/types.py b/py_modules/lsfg_vk/types.py
index 96ce23b..2c56a15 100644
--- a/py_modules/lsfg_vk/types.py
+++ b/py_modules/lsfg_vk/types.py
@@ -54,11 +54,6 @@ class SteamBranchStatusResponse(TypedDict):
needs_switch: bool
restart_required: bool
-
-class SteamBranchOperationResponse(SteamBranchStatusResponse):
- changed: bool
-
-
class ConfigurationResponse(BaseResponse):
"""Response for configuration operations"""
config: Optional[ConfigurationData]
diff --git a/scripts/generate_python_boilerplate.py b/scripts/generate_python_boilerplate.py
index a03aa2b..d134337 100644
--- a/scripts/generate_python_boilerplate.py
+++ b/scripts/generate_python_boilerplate.py
@@ -244,7 +244,7 @@ def main():
print(f"Generated {schema_file.relative_to(project_root)}")
except Exception as e:
- print(f"❌ Error generating Python files: {e}")
+ print(f"Error generating Python files: {e}")
sys.exit(1)
diff --git a/scripts/generate_ts_schema.py b/scripts/generate_ts_schema.py
index c4c0e8a..27969f1 100644
--- a/scripts/generate_ts_schema.py
+++ b/scripts/generate_ts_schema.py
@@ -132,11 +132,11 @@ def main():
target_file = project_root / "src" / "config" / "generatedConfigSchema.ts"
target_file.write_text(ts_content)
- print(f"✅ Generated {target_file} from shared_config.py")
+ print(f"Generated {target_file} from shared_config.py")
print(f" Fields: {len(CONFIG_SCHEMA_DEF)}")
# Also generate Python boilerplate
- print("\n🔄 Generating Python boilerplate...")
+ print("\nGenerating Python boilerplate...")
from pathlib import Path
import subprocess
@@ -147,10 +147,10 @@ def main():
if result.returncode == 0:
print(result.stdout)
else:
- print(f"⚠️ Python boilerplate generation had issues:\n{result.stderr}")
+ print(f"Warning: Python boilerplate generation had issues:\n{result.stderr}")
except Exception as e:
- print(f"❌ Error generating schema: {e}")
+ print(f"Error generating schema: {e}")
sys.exit(1)
diff --git a/src/api/lsfgApi.ts b/src/api/lsfgApi.ts
index 64d43cb..c0d6528 100644
--- a/src/api/lsfgApi.ts
+++ b/src/api/lsfgApi.ts
@@ -29,10 +29,6 @@ export interface SteamBranchStatus {
restart_required: boolean;
}
-export interface SteamBranchOperationResult extends SteamBranchStatus {
- changed: boolean;
-}
-
// Use centralized configuration data type
export type LsfgConfig = ConfigurationData;
@@ -130,7 +126,6 @@ export const installLsfgVk = callable<[], InstallationResult>("install_lsfg_vk")
export const uninstallLsfgVk = callable<[], InstallationResult>("uninstall_lsfg_vk");
export const checkLsfgVkInstalled = callable<[], InstallationStatus>("check_lsfg_vk_installed");
export const getLosslessScalingBranchStatus = callable<[], SteamBranchStatus>("get_lossless_scaling_branch_status");
-export const selectLosslessScalingBranch = callable<[], SteamBranchOperationResult>("select_lossless_scaling_branch");
export const getLsfgConfig = callable<[], ConfigResult>("get_lsfg_config");
export const getConfigSchema = callable<[], ConfigSchemaResult>("get_config_schema");
export const getLaunchOption = callable<[], LaunchOptionResult>("get_launch_option");
diff --git a/src/components/Content.tsx b/src/components/Content.tsx
index 4e4e33a..01f94c9 100644
--- a/src/components/Content.tsx
+++ b/src/components/Content.tsx
@@ -15,7 +15,6 @@ import { NerdStuffModal } from "./NerdStuffModal";
import { FlatpaksModal } from "./FlatpaksModal";
import { ConfigurationData } from "../config/configSchema";
import t from '../i18n/i18n';
-import { showErrorToast, showSuccessToast } from "../utils/toastUtils";
export function Content() {
const {
@@ -26,8 +25,6 @@ export function Content() {
losslessScalingInstalled,
losslessScalingStatus,
steamBranchStatus,
- isSwitchingSteamBranch,
- selectLosslessScalingBranch,
checkInstallation
} = useInstallationStatus();
@@ -71,18 +68,6 @@ export function Content() {
handleUninstall(setIsInstalled, setInstallationStatus, checkInstallation);
};
- const onSelectLosslessScalingBranch = async () => {
- const result = await selectLosslessScalingBranch();
- if (result.success) {
- showSuccessToast("Steam branch selected", result.message);
- } else {
- showErrorToast(
- "Steam branch selection failed",
- result.error || "Unable to select the lsfg-vk Steam branch"
- );
- }
- };
-
const handleShowNerdStuff = () => {
showModal( void;
}
export function StatusDisplay({
@@ -16,9 +14,7 @@ export function StatusDisplay({
installationStatus,
losslessScalingInstalled,
losslessScalingStatus,
- steamBranchStatus,
- isSwitchingSteamBranch,
- onSelectLosslessScalingBranch
+ steamBranchStatus
}: StatusDisplayProps) {
const losslessScalingAppInstalled = losslessScalingInstalled || steamBranchStatus?.installed === true;
@@ -36,9 +32,6 @@ export function StatusDisplay({
gap: "6px"
}}
>
-
- {losslessScalingAppInstalled ? "✅" : "❌"}
-
{losslessScalingAppInstalled ? "Lossless Scaling Installed" : "Lossless Scaling Not Installed"}
{!losslessScalingAppInstalled && losslessScalingStatus && (
@@ -55,9 +48,6 @@ export function StatusDisplay({
gap: "6px"
}}
>
-
- {isInstalled ? "✅" : "❌"}
-
{installationStatus}
- {t('CONFIG_SECTION_TITLE', 'Config')}
-
-
- setConfigCollapsed(!configCollapsed)}
- >
- {configCollapsed ? (
-
-
-
- {t('CONFIG_WORKAROUNDS_TITLE', 'Workarounds')}
-
-
- setWorkaroundsCollapsed(!workaroundsCollapsed)}
- >
- {workaroundsCollapsed ? (
-
-
-
-
-
- {cancelText}
-
-
- {okText}
-
-
-
- {title}
-{description}
- -
-
- setValue(e?.target?.value || "")}
- style={{ width: "100%" }}
- />
-
-
-
-
- {mainRunningApp.display_name} running. {t('PROFILE_CLOSE_GAME', 'Close game to change profile.')}
-
-
- {t('PROFILE_SECTION_TITLE', 'Profile:')} {selectedProfile === "decky-lsfg-vk" ? t('PROFILE_DEFAULT', 'Default') : selectedProfile}
-
-
- setProfilesCollapsed(!profilesCollapsed)}
- >
- {profilesCollapsed ? (
-
-
-
+ {result.content}
+
+
- {t('CONTENT_FPS_MULTIPLIER', 'FPS Multiplier')}
-
-
+
+
);
}
diff --git a/src/components/FlatpaksModal.tsx b/src/components/FlatpaksModal.tsx
deleted file mode 100644
index 8245160..0000000
--- a/src/components/FlatpaksModal.tsx
+++ /dev/null
@@ -1,460 +0,0 @@
-import { FC, useState, useEffect, CSSProperties } from 'react';
-import {
- ModalRoot,
- DialogBody,
- DialogHeader,
- DialogControlsSection,
- DialogControlsSectionHeader,
- ButtonItem,
- PanelSectionRow,
- Field,
- Toggle,
- Spinner,
- Focusable,
- showModal,
- ConfirmModal
-} from '@decky/ui';
-import { FaCheck, FaTimes, FaDownload, FaTrash, FaCog } from 'react-icons/fa';
-import flatpakTargetImage from '../../assets/flatpak-target.png';
-import {
- checkFlatpakExtensionStatus,
- installFlatpakExtension,
- uninstallFlatpakExtension,
- getFlatpakApps,
- setFlatpakAppOverride,
- removeFlatpakAppOverride,
- FlatpakExtensionStatus,
- FlatpakApp,
- FlatpakAppInfo
-} from '../api/lsfgApi';
-import t from '../i18n/i18n';
-import { showErrorToast } from '../utils/toastUtils';
-
-interface FlatpaksModalProps {
- closeModal?: () => void;
-}
-
-export const FlatpaksModal: FC
-
-
- {}}
- style={focusableInstructionStyle}
- >
-
- ))}
-
- {}}
- style={{ marginTop: '4px' }}
- >
-
-
-
- {t('FLATPAK_STEAM_CONFIG_HEADER', 'Configure Steam Flatpak Shortcuts')}
-
-
- {t('FLATPAK_STEAM_CONFIG_DESC', 'In Steam, open your flatpak game and click the cog wheel.')}
-
-
- IMPORTANT: {t('FLATPAK_STEAM_CONFIG_IMPORTANT', 'Set this in TARGET (NOT LAUNCH OPTIONS)')}
-
-
- {instructionSteps.map((step) => (
- {step.title}
- {step.command}
-
- 
-
- {t('NERD_LOADING', 'Loading information...')}
- )}
-
- {error && (
- Error: {error}
- )}
-
- {!loading && !error && (
- <>
- {/* Launch Script Section */}
- {scriptContent && (
- {t('NERD_SCRIPT_NOT_FOUND_PREFIX', 'Script not found:')} {scriptContent.error}
- ) : (
-
- scriptContent.content && copyToClipboard(scriptContent.content)}
- onActivate={() => scriptContent.content && copyToClipboard(scriptContent.content)}
- >
-
-
- )}
-
- {t('NERD_PATH_PREFIX', 'Path:')} {scriptContent.path}
-
-
- {scriptContent.content || t('NERD_NO_CONTENT', 'No content')}
-
- {t('NERD_CONFIG_NOT_FOUND_PREFIX', 'Config not found:')} {configContent.error}
- ) : (
-
- configContent.content && copyToClipboard(configContent.content)}
- onActivate={() => configContent.content && copyToClipboard(configContent.content)}
- >
-
-
- )}
-
- {t('NERD_PATH_PREFIX', 'Path:')} {configContent.path}
-
-
- {configContent.content || t('NERD_NO_CONTENT', 'No content')}
-
-
- {showSuccess ? (
-
-
- {showSuccess ? t('CLIPBOARD_COPIED', 'Copied to clipboard') : isLoading ? t('CLIPBOARD_COPYING', 'Copying...') : t('CLIPBOARD_COPY_LAUNCH', 'Copy Launch Option')}
-
-
- {t('USAGE_TITLE', 'Usage Instructions')}
-
-
- {t('USAGE_DESC', 'Click "Copy Launch Option" button, then paste it into your Steam game\'s launch options to enable frame generation.')}
-
-
- ~/lsfg %command%
-
-
- {t('USAGE_CONFIG_NOTE', 'The configuration is stored in ~/.config/lsfg-vk/conf.toml and hot-reloads while games are running.')}
-
-
- {result.content}
-
-
+ {result.content}
+
+
-
- );
- }
-
- if (isUninstalling) {
- return (
- {t('INSTALL_INSTALLING', 'Installing...')}
-
-
- );
- }
-
- if (isInstalled) {
- return (
- {t('INSTALL_UNINSTALLING', 'Uninstalling...')}
-
-
- );
- }
-
- return (
- {t('INSTALL_UNINSTALL_BTN', 'Uninstall LSFG-VK')}
-
-
- );
- };
+ const label = isInstalling
+ ? t('INSTALL_INSTALLING', 'Installing...')
+ : isUninstalling
+ ? t('INSTALL_UNINSTALLING', 'Uninstalling...')
+ : isInstalled
+ ? t('INSTALL_UNINSTALL_BTN', 'Uninstall LSFG-VK')
+ : t('INSTALL_INSTALL_BTN', 'Install LSFG-VK');
return (
{t('INSTALL_INSTALL_BTN', 'Install LSFG-VK')}
-
-
+
- {losslessScalingAppInstalled ? "Lossless Scaling Installed" : "Lossless Scaling Not Installed"}
-
- {!losslessScalingAppInstalled && losslessScalingStatus && (
-
- {losslessScalingStatus}
-
- )}
-
- {installationStatus}
-
-
-
+
- Steam branch: {steamBranchStatus.current_branch || "public"}
- {steamBranchStatus.needs_switch && (
-
-
- {steamBranchStatus.message}
-
- )}
-
- {showSuccess ? (
-
-
- {showSuccess ? t('CLIPBOARD_COPIED', 'Copied to clipboard') : isLoading ? t('CLIPBOARD_COPYING', 'Copying...') : t('CLIPBOARD_LSFG_FGMOD', 'LSFG + DeckyFG')}
-
- 4 ? "red" : "white",
- minWidth: "60px",
- textAlign: "center"
- }}
- >
- {config.multiplier === 1 ? t('MULTIPLIER_OFF', 'OFF') : `${config.multiplier}X`}
-
- 4 ? "red" : "white",
+ minWidth: "60px",
+ textAlign: "center",
+ }}
+ >
+ {config.multiplier < 2 ? t("MULTIPLIER_OFF", "OFF") : `${config.multiplier}X`}
+
+
- {collapsed ?
+ {collapsed ? (
+
+
+
-
+
+
+ {profileLabel}
+
+
+ {t("CONFIG_WORKAROUNDS_TITLE", "Workarounds")}
+
+
+
+ {collapsed ?
+
+
@@ -86,7 +91,15 @@ function GameGroup({
);
}
-export function GameConfigurationSelector({ targets, runningGame, onSelect, onEnableAll, onResetAll }: Props) {
+export function GameConfigurationSelector({
+ targets,
+ runningGame,
+ onSelect,
+ onEnableAll,
+ onResetAll,
+ focusConfiguredToggle = false,
+ onConfiguredToggleFocused,
+}: Props) {
const sortGames = (games: GameTarget[]) => [...games].sort((a, b) => {
if (a.appid === runningGame?.appid) return -1;
if (b.appid === runningGame?.appid) return 1;
@@ -102,6 +115,17 @@ export function GameConfigurationSelector({ targets, runningGame, onSelect, onEn
const [configuredNonSteamCollapsed, toggleConfiguredNonSteam] = usePersistentCollapsed(`${CONFIGURED_COLLAPSED_KEY}-non-steam`);
const [availableCollapsed, toggleAvailable] = usePersistentCollapsed(AVAILABLE_COLLAPSED_KEY);
const [availableNonSteamCollapsed, toggleAvailableNonSteam] = usePersistentCollapsed(`${AVAILABLE_COLLAPSED_KEY}-non-steam`);
+ const configuredToggleRef = useRef(null);
+
+ useEffect(() => {
+ if (!focusConfiguredToggle) return;
+ const frame = requestAnimationFrame(() => {
+ configuredToggleRef.current?.querySelector('[role="button"], button')?.focus();
+ onConfiguredToggleFocused?.();
+ });
+ return () => cancelAnimationFrame(frame);
+ }, [configuredGames.length, focusConfiguredToggle, onConfiguredToggleFocused]);
+
const confirmResetAll = () => {
showModal(
setExpanded((value) => !value)}
>
- {expanded ?
-
)}
diff --git a/src/components/WorkaroundsSection.tsx b/src/components/WorkaroundsSection.tsx
index e990784..d783620 100644
--- a/src/components/WorkaroundsSection.tsx
+++ b/src/components/WorkaroundsSection.tsx
@@ -10,7 +10,7 @@ interface WorkaroundsSectionProps {
nonSteam: boolean;
}
-const WORKAROUNDS_COLLAPSED_KEY = "lsfg-workarounds-collapsed";
+const WORKAROUNDS_COLLAPSED_KEY = "lsfg-workarounds-collapsed-v2";
type ToggleWorkaroundField = Exclude;
const TOGGLE_ROWS: readonly {
@@ -20,19 +20,26 @@ const TOGGLE_ROWS: readonly {
descriptionKey: string;
description: string;
}[] = [
+ {
+ field: "disableSteamdeckMode",
+ labelKey: "CONFIG_DISABLE_STEAMDECK_MODE",
+ label: "Disable Steam Deck Mode",
+ descriptionKey: "CONFIG_DISABLE_STEAMDECK_MODE_DESC",
+ description: "Disables a game-specific Steam Deck compatibility switch. Requires game restart to apply.",
+ },
{
field: "disableGamescopeWsi",
labelKey: "CONFIG_DISABLE_GAMESCOPE_WSI",
label: "Disable Gamescope WSI",
descriptionKey: "CONFIG_DISABLE_GAMESCOPE_WSI_DESC",
- description: "Adds ENABLE_GAMESCOPE_WSI=0 without changing HDR. Requires game restart to apply.",
+ description: "Adds ENABLE_GAMESCOPE_WSI=0. Requires game restart to apply.",
},
{
- field: "disableSteamdeckMode",
- labelKey: "CONFIG_DISABLE_STEAMDECK_MODE",
- label: "Disable Steam Deck Mode",
- descriptionKey: "CONFIG_DISABLE_STEAMDECK_MODE_DESC",
- description: "Disables a game-specific Steam Deck compatibility switch. Requires game restart to apply.",
+ field: "disableHdr",
+ labelKey: "CONFIG_DISABLE_HDR",
+ label: "Disable HDR",
+ descriptionKey: "CONFIG_DISABLE_HDR_DESC",
+ description: "Prevents DXVK from exposing HDR to the game. Requires game restart to apply.",
},
{
field: "disableVkbasalt",
diff --git a/src/hooks/useGameConfiguration.ts b/src/hooks/useGameConfiguration.ts
index 46607cb..6d1fe6a 100644
--- a/src/hooks/useGameConfiguration.ts
+++ b/src/hooks/useGameConfiguration.ts
@@ -3,7 +3,7 @@ import { useQuickAccessVisible } from "@decky/api";
import { Router } from "@decky/ui";
import { getGameConfigs, getInstalledGames, updateGameConfig, resetGameConfig, resetAllGameConfigs, type GameConfigEntry, type GlobalConfig, type InstalledGame } from "../api/lsfgApi";
import { ConfigurationData, getDefaults } from "../config/configSchema";
-import { cleanupSteamLaunchOptions } from "../utils/steamLaunchOptions";
+import { applyWorkaroundState, cleanupLegacySteamLaunchOptions, cleanupSteamLaunchOptions, getDefaultWorkaroundState, updateSteamLaunchOptions } from "../utils/steamLaunchOptions";
import { showErrorToast } from "../utils/toastUtils";
export interface GameTarget extends InstalledGame { configured: boolean; }
@@ -98,7 +98,7 @@ export function useGameConfiguration() {
const cleanupTargetLaunchOptions = useCallback(async (target: GameTarget): Promise => {
if (!installedGames.some((game) => game.appid === target.appid)) return true;
try {
- await cleanupSteamLaunchOptions(Number(target.appid), target.nonSteam);
+ await cleanupLegacySteamLaunchOptions(Number(target.appid), target.nonSteam);
return true;
} catch (error) {
showErrorToast("Could not update Steam launch options", error instanceof Error ? error.message : String(error));
@@ -106,6 +106,32 @@ export function useGameConfiguration() {
}
}, [installedGames]);
+ const removeTargetLaunchOptions = useCallback(async (target: GameTarget): Promise => {
+ if (!installedGames.some((game) => game.appid === target.appid)) return true;
+ try {
+ await cleanupSteamLaunchOptions(Number(target.appid), target.nonSteam);
+ return true;
+ } catch (error) {
+ showErrorToast("Could not clean up Steam launch options", error instanceof Error ? error.message : String(error));
+ return false;
+ }
+ }, [installedGames]);
+
+ const initializeTargetLaunchOptions = useCallback(async (target: GameTarget): Promise => {
+ if (!installedGames.some((game) => game.appid === target.appid)) return true;
+ try {
+ await updateSteamLaunchOptions(
+ Number(target.appid),
+ target.nonSteam,
+ (options) => applyWorkaroundState(options, getDefaultWorkaroundState()),
+ );
+ return true;
+ } catch (error) {
+ showErrorToast("Could not initialize Steam launch options", error instanceof Error ? error.message : String(error));
+ return false;
+ }
+ }, [installedGames]);
+
const save = useCallback(async (next: ConfigurationData, cleanupLaunchOptions = false) => {
const selectedTarget = targets.find((target) => target.appid === selectedAppId);
if (!selectedTarget?.name) return;
@@ -117,16 +143,16 @@ export function useGameConfiguration() {
const enable = useCallback(async (appid: string) => {
const target = targets.find((item) => item.appid === appid);
if (!target?.name) return false;
- if (!(await cleanupTargetLaunchOptions(target))) return false;
+ if (!(await initializeTargetLaunchOptions(target))) return false;
const result = await updateGameConfig(appid, target.name, template);
if (result.success) await load();
return result.success;
- }, [cleanupTargetLaunchOptions, load, targets, template]);
+ }, [initializeTargetLaunchOptions, load, targets, template]);
const enableAll = useCallback(async (): Promise => {
const available = targets.filter((target) => !target.configured && target.name);
if (available.length === 0) return;
for (const target of available) {
- if (!(await cleanupTargetLaunchOptions(target))) return;
+ if (!(await initializeTargetLaunchOptions(target))) return;
const result = await updateGameConfig(target.appid, target.name, template);
if (!result.success) {
showErrorToast("Could not enable all games", result.error || "A game profile could not be created");
@@ -134,12 +160,12 @@ export function useGameConfiguration() {
}
}
await load();
- }, [cleanupTargetLaunchOptions, load, targets, template]);
+ }, [initializeTargetLaunchOptions, load, targets, template]);
const resetSelected = useCallback(async () => {
if (selectedAppId) {
const selectedTarget = targets.find((target) => target.appid === selectedAppId);
- if (selectedTarget && !(await cleanupTargetLaunchOptions(selectedTarget))) return;
+ if (selectedTarget && !(await removeTargetLaunchOptions(selectedTarget))) return;
const result = await resetGameConfig(selectedAppId);
if (result.success) {
setRunningGame((current) => current?.appid === selectedAppId ? { ...current, configured: false } : current);
@@ -147,10 +173,10 @@ export function useGameConfiguration() {
await load();
}
}
- }, [cleanupTargetLaunchOptions, load, selectedAppId, targets]);
+ }, [load, removeTargetLaunchOptions, selectedAppId, targets]);
const resetAll = useCallback(async () => {
for (const target of targets.filter((item) => item.configured)) {
- if (!(await cleanupTargetLaunchOptions(target))) return;
+ if (!(await removeTargetLaunchOptions(target))) return;
}
const result = await resetAllGameConfigs();
if (result.success) {
@@ -158,7 +184,7 @@ export function useGameConfiguration() {
setSelectedAppId("");
await load();
}
- }, [cleanupTargetLaunchOptions, load, targets]);
+ }, [load, removeTargetLaunchOptions, targets]);
return { config, games, targets, runningGame, selectedAppId, setSelectedAppId, save, enable, enableAll, resetSelected, resetAll, reload: load };
}
diff --git a/src/i18n/languages.json b/src/i18n/languages.json
index 3f1992c..7e5676b 100644
--- a/src/i18n/languages.json
+++ b/src/i18n/languages.json
@@ -22,7 +22,9 @@
"CONFIG_ENABLE_WSI": "WSIを有効化",
"CONFIG_ENABLE_WSI_DESC": "Gamescope WSIレイヤーを再有効化します。ゲームの再起動が必要。",
"CONFIG_DISABLE_GAMESCOPE_WSI": "Gamescope WSIを無効化",
- "CONFIG_DISABLE_GAMESCOPE_WSI_DESC": "HDRを変更せずENABLE_GAMESCOPE_WSI=0を追加します。ゲームの再起動が必要です。",
+ "CONFIG_DISABLE_GAMESCOPE_WSI_DESC": "ENABLE_GAMESCOPE_WSI=0を追加します。ゲームの再起動が必要です。",
+ "CONFIG_DISABLE_HDR": "HDRを無効化",
+ "CONFIG_DISABLE_HDR_DESC": "DXVKがゲームにHDRを公開しないようにします。ゲームの再起動が必要です。",
"CONFIG_DISABLE_STEAMDECK_MODE": "Steam Deckモードを無効化",
"CONFIG_DISABLE_STEAMDECK_MODE_DESC": "ゲーム固有のSteam Deck互換スイッチを無効化します。ゲームの再起動が必要です。",
"CONFIG_DISABLE_VKBASALT": "vkBasaltを無効化",
@@ -109,7 +111,9 @@
"CONFIG_ENABLE_WSI": "WSI 활성화",
"CONFIG_ENABLE_WSI_DESC": "Gamescope WSI 레이어를 다시 활성화합니다. 게임 재시작 필요.",
"CONFIG_DISABLE_GAMESCOPE_WSI": "Gamescope WSI 비활성화",
- "CONFIG_DISABLE_GAMESCOPE_WSI_DESC": "HDR을 변경하지 않고 ENABLE_GAMESCOPE_WSI=0을 추가합니다. 게임 재시작 필요.",
+ "CONFIG_DISABLE_GAMESCOPE_WSI_DESC": "ENABLE_GAMESCOPE_WSI=0을 추가합니다. 게임 재시작 필요.",
+ "CONFIG_DISABLE_HDR": "HDR 비활성화",
+ "CONFIG_DISABLE_HDR_DESC": "DXVK가 게임에 HDR을 노출하지 않도록 합니다. 게임 재시작 필요.",
"CONFIG_DISABLE_STEAMDECK_MODE": "Steam Deck 모드 비활성화",
"CONFIG_DISABLE_STEAMDECK_MODE_DESC": "게임별 Steam Deck 호환 스위치를 비활성화합니다. 게임 재시작 필요.",
"CONFIG_DISABLE_VKBASALT": "vkBasalt 비활성화",
@@ -224,7 +228,9 @@
"CONFIG_ENABLE_WSI": "Enable WSI",
"CONFIG_ENABLE_WSI_DESC": "Re-Enable Gamescope WSI Layer. Requires game restart to apply.",
"CONFIG_DISABLE_GAMESCOPE_WSI": "Disable Gamescope WSI",
- "CONFIG_DISABLE_GAMESCOPE_WSI_DESC": "Adds ENABLE_GAMESCOPE_WSI=0 without changing HDR. Requires game restart to apply.",
+ "CONFIG_DISABLE_GAMESCOPE_WSI_DESC": "Adds ENABLE_GAMESCOPE_WSI=0. Requires game restart to apply.",
+ "CONFIG_DISABLE_HDR": "Disable HDR",
+ "CONFIG_DISABLE_HDR_DESC": "Prevents DXVK from exposing HDR to the game. Requires game restart to apply.",
"CONFIG_DISABLE_STEAMDECK_MODE": "Disable Steam Deck Mode",
"CONFIG_DISABLE_STEAMDECK_MODE_DESC": "Disables a game-specific Steam Deck compatibility switch. Requires game restart to apply.",
"CONFIG_DISABLE_VKBASALT": "Disable vkBasalt",
diff --git a/src/utils/steamLaunchOptionParser.ts b/src/utils/steamLaunchOptionParser.ts
index 5b8156c..9449b33 100644
--- a/src/utils/steamLaunchOptionParser.ts
+++ b/src/utils/steamLaunchOptionParser.ts
@@ -1,6 +1,7 @@
export interface WorkaroundState {
dxvkFrameRate: number;
disableGamescopeWsi: boolean;
+ disableHdr: boolean;
disableSteamdeckMode: boolean;
disableVkbasalt: boolean;
enableZink: boolean;
@@ -41,8 +42,10 @@ const LEGACY_WRAPPER_TOKENS = new Set([
"/home/deck/.local/bin/lsfg-vk-experimental",
"~/.local/bin/mako-run",
"/home/deck/.local/bin/mako-run",
+ "mako-run",
"~/.local/bin/mako-launch",
"/home/deck/.local/bin/mako-launch",
+ "mako-launch",
]);
const DXVK_FRAME_RATE_KEYS: readonly DxvkFrameRateKey[] = [
"dxvk.maxFrameRate",
@@ -53,7 +56,12 @@ const DXVK_MANAGED_KEYS = new Set(["DXVK_CONFIG", "DXVK_FRAME_RATE"]);
const WORKAROUND_DEFINITIONS = {
disableGamescopeWsi: {
spec: ["ENABLE_GAMESCOPE_WSI", "0"],
- clear: ["DISABLE_GAMESCOPE_WSI", "ENABLE_GAMESCOPE_WSI", "DXVK_HDR"],
+ clear: ["DISABLE_GAMESCOPE_WSI", "ENABLE_GAMESCOPE_WSI"],
+ },
+ disableHdr: {
+ spec: ["DXVK_HDR", "0"],
+ clear: ["DXVK_HDR"],
+ label: "Disable HDR",
},
disableSteamdeckMode: {
spec: ["SteamDeck", "0"],
@@ -72,24 +80,34 @@ const WORKAROUND_DEFINITIONS = {
} as const satisfies Record;
const BOOLEAN_WORKAROUND_FIELDS: readonly BooleanWorkaroundField[] = [
"disableGamescopeWsi",
+ "disableHdr",
"disableSteamdeckMode",
"disableVkbasalt",
"enableZink",
];
const WSI_DISABLE_KEY = "DISABLE_GAMESCOPE_WSI";
const WSI_ENABLE_KEY = "ENABLE_GAMESCOPE_WSI";
+const WORKAROUND_ENV_KEYS = new Set(
+ BOOLEAN_WORKAROUND_FIELDS.flatMap((field) => WORKAROUND_DEFINITIONS[field].clear),
+);
const MANAGED_ENV_KEYS = new Set([
...DXVK_MANAGED_KEYS,
- ...BOOLEAN_WORKAROUND_FIELDS.flatMap((field) => WORKAROUND_DEFINITIONS[field].clear),
+ ...WORKAROUND_ENV_KEYS,
]);
-const DEFAULT_WORKAROUND_STATE: WorkaroundState = {
+const EMPTY_WORKAROUND_STATE: WorkaroundState = {
dxvkFrameRate: 0,
disableGamescopeWsi: false,
+ disableHdr: false,
disableSteamdeckMode: false,
disableVkbasalt: false,
enableZink: false,
};
+const DEFAULT_WORKAROUND_STATE: WorkaroundState = {
+ ...EMPTY_WORKAROUND_STATE,
+ disableGamescopeWsi: true,
+ disableHdr: true,
+};
export function getDefaultWorkaroundState(): WorkaroundState {
return { ...DEFAULT_WORKAROUND_STATE };
@@ -117,8 +135,6 @@ function decodeToken(raw: string): string {
return value;
}
-// Steam stores one shell-like line. Keep each token's raw spelling beside its
-// decoded value so managed edits leave unrelated quoting and arguments alone.
function tokenize(options: string): LaunchToken[] {
const tokens: LaunchToken[] = [];
let start = -1;
@@ -358,7 +374,7 @@ function readBoolean(
export function parseWorkaroundOptions(options: string): ParsedWorkaroundOptions {
const tokens = tokenize(options);
const entries = effectiveEnvironmentEntries(tokens);
- const state = getDefaultWorkaroundState();
+ const state = { ...EMPTY_WORKAROUND_STATE };
const issues: string[] = [];
for (const [key, entry] of entries) {
@@ -418,7 +434,7 @@ export function parseWorkaroundOptions(options: string): ParsedWorkaroundOptions
state.disableGamescopeWsi = wsiSignals.some(Boolean);
}
- for (const field of ["disableSteamdeckMode", "disableVkbasalt"] as const) {
+ for (const field of ["disableHdr", "disableSteamdeckMode", "disableVkbasalt"] as const) {
const { spec, label } = WORKAROUND_DEFINITIONS[field];
state[field] = readBoolean(entries, spec[0], label || field, spec[1], issues);
}
@@ -455,7 +471,7 @@ export function applyWorkaroundState(options: string, state: WorkaroundState): s
removeLegacyWrapperFromTokens(tokens);
rewriteDxvkFrameRate(tokens, state.dxvkFrameRate);
const keysToClear = new Set(
- BOOLEAN_WORKAROUND_FIELDS.flatMap((field) => WORKAROUND_DEFINITIONS[field].clear),
+ WORKAROUND_ENV_KEYS,
);
if (state.disableVkbasalt) keysToClear.add("ENABLE_VKBASALT");
removeAllAssignments(tokens, keysToClear);
@@ -496,6 +512,14 @@ export function cleanupLegacyLaunchOptions(options: string): string {
return serialize(tokens);
}
+export function cleanupPluginLaunchOptions(options: string): string {
+ const tokens = tokenize(options);
+ removeLegacyWrapperFromTokens(tokens);
+ rewriteDxvkFrameRate(tokens, 0);
+ removeAllAssignments(tokens, WORKAROUND_ENV_KEYS);
+ return serialize(tokens);
+}
+
export function cleanupLegacyWrapper(options: string): string {
return cleanupLegacyLaunchOptions(options);
}
diff --git a/src/utils/steamLaunchOptions.ts b/src/utils/steamLaunchOptions.ts
index 39125bd..82ff94b 100644
--- a/src/utils/steamLaunchOptions.ts
+++ b/src/utils/steamLaunchOptions.ts
@@ -1,5 +1,5 @@
// @ts-expect-error Node's built-in TypeScript loader requires explicit source extensions in tests.
-import { cleanupLegacyLaunchOptions, isLegacyWrapperToken, normalizeLaunchOptions } from "./steamLaunchOptionParser.ts";
+import { cleanupLegacyLaunchOptions, cleanupPluginLaunchOptions, isLegacyWrapperToken, normalizeLaunchOptions } from "./steamLaunchOptionParser.ts";
// @ts-expect-error Node's built-in TypeScript loader requires explicit source extensions in tests.
export * from "./steamLaunchOptionParser.ts";
@@ -200,6 +200,19 @@ export function updateSteamLaunchOptions(
export function cleanupSteamLaunchOptions(
appId: number,
nonSteam: boolean,
+): Promise {
+ return queueSteamAppOperation(appId, nonSteam, async () => {
+ const current = await readSteamLaunchOptions(appId, nonSteam);
+ const next = cleanupPluginLaunchOptions(current.options);
+ if (next === current.options) return current;
+ await setSteamLaunchOptions(appId, nonSteam, next);
+ return waitForLaunchOptions(appId, nonSteam, next);
+ });
+}
+
+export function cleanupLegacySteamLaunchOptions(
+ appId: number,
+ nonSteam: boolean,
): Promise {
return queueSteamAppOperation(appId, nonSteam, async () => {
const current = await readSteamLaunchOptions(appId, nonSteam);
diff --git a/tests/steamLaunchOptions.test.ts b/tests/steamLaunchOptions.test.ts
index 0662fbb..c4dede3 100644
--- a/tests/steamLaunchOptions.test.ts
+++ b/tests/steamLaunchOptions.test.ts
@@ -4,6 +4,7 @@ import {
applyWorkaroundChange,
applyWorkaroundState,
cleanupLegacyLaunchOptions,
+ cleanupPluginLaunchOptions,
cleanupLegacyWrapper,
getDefaultWorkaroundState,
isLegacyWrapperToken,
@@ -17,6 +18,7 @@ test("maps the supported workarounds to current launch variables", () => {
const options = applyWorkaroundState('gamemoderun %command% --profile "high quality"', {
dxvkFrameRate: 30,
disableGamescopeWsi: true,
+ disableHdr: true,
disableSteamdeckMode: true,
disableVkbasalt: true,
enableZink: true,
@@ -24,12 +26,13 @@ test("maps the supported workarounds to current launch variables", () => {
assert.equal(
options,
- 'ENABLE_GAMESCOPE_WSI=0 SteamDeck=0 DISABLE_VKBASALT=1 MESA_LOADER_DRIVER_OVERRIDE=zink DXVK_CONFIG="dxvk.maxFrameRate = 30" gamemoderun %command% --profile "high quality"',
+ 'ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 SteamDeck=0 DISABLE_VKBASALT=1 MESA_LOADER_DRIVER_OVERRIDE=zink DXVK_CONFIG="dxvk.maxFrameRate = 30" gamemoderun %command% --profile "high quality"',
);
assert.deepEqual(parseWorkaroundOptions(options), {
state: {
dxvkFrameRate: 30,
disableGamescopeWsi: true,
+ disableHdr: true,
disableSteamdeckMode: true,
disableVkbasalt: true,
enableZink: true,
@@ -45,10 +48,24 @@ test("uses SteamDeck=0 before %command% without a wrapper", () => {
);
});
-test("keeps WSI disable opt-in and does not add HDR assignments", () => {
+test("defaults new profiles to disable Gamescope WSI and HDR", () => {
const defaults = getDefaultWorkaroundState();
- assert.equal(applyWorkaroundState("%command%", defaults), "");
+ assert.equal(defaults.disableGamescopeWsi, true);
+ assert.equal(defaults.disableHdr, true);
+ assert.equal(
+ applyWorkaroundState("%command%", defaults),
+ "ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 %command%",
+ );
assert.equal(parseWorkaroundOptions("%command%").state.disableGamescopeWsi, false);
+ assert.equal(parseWorkaroundOptions("%command%").state.disableHdr, false);
+ assert.equal(
+ parseWorkaroundOptions(applyWorkaroundState("%command%", defaults)).state.disableGamescopeWsi,
+ true,
+ );
+ assert.equal(
+ parseWorkaroundOptions(applyWorkaroundState("%command%", defaults)).state.disableHdr,
+ true,
+ );
assert.equal(
applyWorkaroundChange("%command%", "disableGamescopeWsi", true),
"ENABLE_GAMESCOPE_WSI=0 %command%",
@@ -58,14 +75,6 @@ test("keeps WSI disable opt-in and does not add HDR assignments", () => {
"",
);
- const legacy = parseWorkaroundOptions("ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 %command%");
- assert.equal(legacy.state.disableGamescopeWsi, true);
- assert.deepEqual(legacy.issues, []);
- assert.equal(
- applyWorkaroundChange("ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 %command%", "disableGamescopeWsi", false),
- "",
- );
-
const invalid = parseWorkaroundOptions("ENABLE_GAMESCOPE_WSI=maybe %command%");
assert.equal(invalid.state.disableGamescopeWsi, false);
assert.equal(invalid.issues.length, 1);
@@ -74,6 +83,27 @@ test("keeps WSI disable opt-in and does not add HDR assignments", () => {
assert.match(conflicting.issues.join(" "), /conflicting/);
});
+test("manages DXVK HDR independently from Gamescope WSI", () => {
+ assert.equal(
+ applyWorkaroundChange("%command%", "disableHdr", true),
+ "DXVK_HDR=0 %command%",
+ );
+ assert.equal(parseWorkaroundOptions("DXVK_HDR=0 %command%").state.disableHdr, true);
+ assert.equal(parseWorkaroundOptions("DXVK_HDR=1 %command%").state.disableHdr, false);
+ assert.equal(
+ applyWorkaroundChange("DXVK_HDR=0 %command%", "disableHdr", false),
+ "",
+ );
+ assert.equal(
+ applyWorkaroundChange("DXVK_HDR=0 %command%", "disableGamescopeWsi", true),
+ "ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 %command%",
+ );
+
+ const invalid = parseWorkaroundOptions("DXVK_HDR=maybe %command%");
+ assert.equal(invalid.state.disableHdr, false);
+ assert.match(invalid.issues.join(" "), /Disable HDR has an unsupported value/);
+});
+
test("preserves unrelated prefixes, quoted tokens, suffix arguments, and dropped variables", () => {
const options = applyWorkaroundChange(
'PROTON_USE_WOW64=1 MANGOHUD=1 MANGOHUD_CONFIG="alpha=0.01" ENABLE_VKBASALT=1 VK_INSTANCE_LAYERS="one:two" FOO="hello world" gamemoderun %command% --flag "two words"',
@@ -203,6 +233,8 @@ test("cleans only the known legacy wrapper and preserves launch options", () =>
'FOO=bar %command% --arg "~/lsfg"',
);
assert.equal(cleanupLegacyWrapper("/home/deck/lsfg %command%"), "");
+ assert.equal(cleanupLegacyWrapper("mako-run %command%"), "");
+ assert.equal(cleanupLegacyWrapper("mako-launch %command%"), "");
assert.equal(
cleanupLegacyWrapper("DXVK_FRAME_RATE=30 LSFG_PROCESS=decky-lsfg-vk %command%"),
"DXVK_FRAME_RATE=30 LSFG_PROCESS=decky-lsfg-vk %command%",
@@ -214,6 +246,25 @@ test("cleans only the known legacy wrapper and preserves launch options", () =>
assert.equal(isLegacyWrapperToken("/home/kurt/lsfg"), false);
});
+test("removes plugin-managed launch options when a profile is removed", () => {
+ assert.equal(
+ cleanupPluginLaunchOptions(
+ 'FOO="keep this" ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 SteamDeck=0 DISABLE_VKBASALT=1 MESA_LOADER_DRIVER_OVERRIDE=zink DXVK_CONFIG="dxgi.syncInterval = 0; dxvk.maxFrameRate = 30" ~/lsfg %command% --windowed',
+ ),
+ 'DXVK_CONFIG="dxgi.syncInterval = 0" FOO="keep this" %command% --windowed',
+ );
+ assert.equal(
+ cleanupPluginLaunchOptions(
+ 'PROTON_USE_WOW64=1 MANGOHUD=1 MANGOHUD_CONFIG="alpha=0.01" LSFG_PROCESS=decky-lsfg-vk %command%',
+ ),
+ 'PROTON_USE_WOW64=1 MANGOHUD=1 MANGOHUD_CONFIG="alpha=0.01" LSFG_PROCESS=decky-lsfg-vk %command%',
+ );
+ assert.equal(
+ cleanupPluginLaunchOptions('DXVK_CONFIG="dxvk.maxFrameRate = 30" %command%'),
+ "",
+ );
+});
+
test("canonicalizes a bare command token without removing real arguments", () => {
assert.equal(normalizeLaunchOptions("%command%"), "");
assert.equal(normalizeLaunchOptions("%COMMAND%"), "");
diff --git a/tests/test_flatpak_overrides.py b/tests/test_flatpak_overrides.py
new file mode 100644
index 0000000..ed3ef6a
--- /dev/null
+++ b/tests/test_flatpak_overrides.py
@@ -0,0 +1,158 @@
+import sys
+import tempfile
+import types
+import unittest
+from pathlib import Path
+from unittest.mock import Mock
+
+
+sys.modules.setdefault(
+ "decky",
+ types.SimpleNamespace(DECKY_USER_HOME="/home/deck", logger=Mock()),
+)
+sys.modules.setdefault("tomllib", types.SimpleNamespace(loads=Mock()))
+sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "py_modules"))
+
+from lsfg_vk.flatpak_service import FlatpakService
+
+
+class FlatpakOverrideTests(unittest.TestCase):
+ def setUp(self):
+ self.tempdir = tempfile.TemporaryDirectory()
+ home = Path(self.tempdir.name) / "home" / "deck"
+ home.mkdir(parents=True)
+ self.service = FlatpakService()
+ self.service.user_home = home
+ self.service.config_dir = home / ".config/lsfg-vk"
+ self.service.config_file_path = self.service.config_dir / "conf.toml"
+ self.service.legacy_script_path = home / "lsfg"
+ self.service.check_flatpak_available = Mock(return_value=True)
+ self.service._run_flatpak_command = Mock(
+ return_value=types.SimpleNamespace(returncode=0, stderr="", stdout="")
+ )
+ self.app_id = "com.example.Game"
+ self.override_path = self.service._override_file_path(self.app_id)
+
+ def tearDown(self):
+ self.tempdir.cleanup()
+ sys.modules.pop("lsfg_vk.plugin", None)
+ sys.modules.pop("lsfg_vk", None)
+
+ def _paths(self):
+ return self.service._override_paths()
+
+ def _write_override(self, content):
+ self.override_path.parent.mkdir(parents=True, exist_ok=True)
+ self.override_path.write_text(content, encoding="utf-8")
+
+ def _show_response(self, content):
+ return types.SimpleNamespace(returncode=0, stderr="", stdout=content)
+
+ def test_set_cleans_legacy_entries_and_verifies_readback(self):
+ paths = self._paths()
+ self._write_override(
+ "[Context]\n"
+ f"filesystems=/home/deck/keep;{paths['config_dir']}:rw;!{paths['legacy_home']};"
+ f"{paths['legacy_script']};{paths['legacy_dll']}:ro;{paths['dll_dir']}:ro;\n"
+ "unset-environment=KEEP_UNSET;LSFG_CONFIG;\n\n"
+ "[Environment]\n"
+ "KEEP_ENV=1\n"
+ "LSFG_CONFIG=\n"
+ "LSFGVK_CONFIG=old\n"
+ "ENABLE_GAMESCOPE_WSI=1\n"
+ "DXVK_HDR=1\n"
+ )
+ expected = (
+ "[Context]\n"
+ f"filesystems={paths['config_dir']}:rw;{paths['dll_dir']}:ro\n"
+ "[Environment]\n"
+ f"LSFGVK_CONFIG={paths['config_file']}\n"
+ "ENABLE_GAMESCOPE_WSI=0\n"
+ "DXVK_HDR=0\n"
+ )
+ self.service._run_flatpak_command.side_effect = [
+ self._show_response(""),
+ self._show_response(expected),
+ ]
+
+ response = self.service.set_app_override(self.app_id)
+ command_args = self.service._run_flatpak_command.call_args_list[0].args[0]
+ cleaned = self.override_path.read_text(encoding="utf-8")
+
+ self.assertTrue(response["success"])
+ self.assertIn("--env=ENABLE_GAMESCOPE_WSI=0", command_args)
+ self.assertIn("--env=DXVK_HDR=0", command_args)
+ self.assertNotIn("--nofilesystem=/home/deck", command_args)
+ self.assertNotIn("--unset-env=LSFG_CONFIG", command_args)
+ self.assertIn("/home/deck/keep", cleaned)
+ self.assertIn("KEEP_ENV=1", cleaned)
+ self.assertNotIn("LSFG_CONFIG", cleaned)
+ self.assertNotIn(paths["legacy_home"], cleaned)
+
+ def test_set_reports_failed_readback(self):
+ paths = self._paths()
+ self.service._run_flatpak_command.side_effect = [
+ self._show_response(""),
+ self._show_response(
+ f"[Context]\nfilesystems={paths['config_dir']};{paths['dll_dir']}\n"
+ f"[Environment]\nLSFGVK_CONFIG={paths['config_file']}\n"
+ ),
+ ]
+
+ response = self.service.set_app_override(self.app_id)
+
+ self.assertFalse(response["success"])
+ self.assertIn("verified", response["error"])
+
+ def test_remove_cleans_known_entries_preserves_unrelated_and_verifies(self):
+ paths = self._paths()
+ self._write_override(
+ "[Context]\n"
+ f"filesystems=/home/deck/keep;{paths['config_dir']};!{paths['legacy_home']};"
+ f"{paths['legacy_dll']};{paths['legacy_script']}\n"
+ "unset-environment=KEEP_UNSET;LSFG_CONFIG;ENABLE_GAMESCOPE_WSI\n\n"
+ "[Environment]\n"
+ "KEEP_ENV=1\n"
+ "LSFGVK_CONFIG=/old/path\n"
+ "DXVK_HDR=0\n"
+ )
+ self.service._run_flatpak_command.side_effect = [
+ self._show_response(
+ "[Context]\nfilesystems=/home/deck/keep\n"
+ "[Environment]\nKEEP_ENV=1\n"
+ )
+ ]
+
+ response = self.service.remove_app_override(self.app_id)
+ cleaned = self.override_path.read_text(encoding="utf-8")
+
+ self.assertTrue(response["success"])
+ self.assertEqual(self.service._run_flatpak_command.call_count, 1)
+ self.assertIn("/home/deck/keep", cleaned)
+ self.assertIn("KEEP_UNSET", cleaned)
+ self.assertIn("KEEP_ENV", cleaned)
+ for name in ("LSFGVK_CONFIG", "LSFG_CONFIG", "ENABLE_GAMESCOPE_WSI", "DXVK_HDR"):
+ self.assertNotIn(name, cleaned)
+ for path in paths.values():
+ if path != paths["config_file"]:
+ self.assertNotIn(path, cleaned)
+
+ def test_remove_reports_failed_readback(self):
+ self._write_override("[Context]\nfilesystems=/home/deck/keep\n")
+ paths = self._paths()
+ self.service._run_flatpak_command.side_effect = [
+ self._show_response(
+ f"[Context]\nfilesystems={paths['config_dir']};{paths['dll_dir']}\n"
+ f"[Environment]\nLSFGVK_CONFIG={paths['config_file']}\n"
+ "ENABLE_GAMESCOPE_WSI=0\nDXVK_HDR=0\n"
+ )
+ ]
+
+ response = self.service.remove_app_override(self.app_id)
+
+ self.assertFalse(response["success"])
+ self.assertIn("verified", response["error"])
+
+
+if __name__ == "__main__":
+ unittest.main()
--
cgit v1.2.3
From 1b932fd69c3dba925e0cbf027e05508b2daf5e8c Mon Sep 17 00:00:00 2001
From: xXJSONDeruloXx
Date: Wed, 9 Sep 2026 01:01:42 -0400
Subject: add back launcher script and correct pathing
---
py_modules/lsfg_vk/constants.py | 1 +
py_modules/lsfg_vk/installation.py | 1 -
py_modules/lsfg_vk/plugin.py | 25 +-
py_modules/lsfg_vk/wrapper_service.py | 428 ++++++++++++++++++++++
src/api/lsfgApi.ts | 29 ++
src/components/ConfigurationTab.tsx | 3 +
src/components/Content.tsx | 2 +
src/components/GameConfigurationControls.tsx | 8 +-
src/components/WorkaroundsSection.tsx | 41 ++-
src/hooks/useGameConfiguration.ts | 158 ++++++--
src/hooks/usePerAppWorkarounds.ts | 234 +++++++++---
src/types.d.ts | 1 +
src/utils/steamLaunchOptionParser.ts | 525 ---------------------------
src/utils/steamLaunchOptions.ts | 472 +++++++++++++++++++++---
tests/steamLaunchOptions.test.ts | 434 ++++++++--------------
tests/test_wrapper_service.py | 170 +++++++++
16 files changed, 1566 insertions(+), 966 deletions(-)
create mode 100644 py_modules/lsfg_vk/wrapper_service.py
delete mode 100644 src/utils/steamLaunchOptionParser.ts
create mode 100644 tests/test_wrapper_service.py
diff --git a/py_modules/lsfg_vk/constants.py b/py_modules/lsfg_vk/constants.py
index 19df278..960d230 100644
--- a/py_modules/lsfg_vk/constants.py
+++ b/py_modules/lsfg_vk/constants.py
@@ -5,6 +5,7 @@ VULKAN_LAYER_DIR = ".local/share/vulkan/implicit_layer.d"
CONFIG_DIR = ".config/lsfg-vk"
SCRIPT_NAME = "lsfg"
+WRAPPER_FILENAME = ".lsfg"
CONFIG_FILENAME = "conf.toml"
ARCHIVE_FILENAME = "lsfg-vk-2.0.0.tar.xz"
LIB_FILENAME = "liblsfg-vk-layer.so"
diff --git a/py_modules/lsfg_vk/installation.py b/py_modules/lsfg_vk/installation.py
index b583cc7..8a3094d 100644
--- a/py_modules/lsfg_vk/installation.py
+++ b/py_modules/lsfg_vk/installation.py
@@ -209,7 +209,6 @@ class InstallationService(BaseService):
self.user_home / LOCAL_SHARE / "icons" / "hicolor" / "256x256" / "apps" / UI_ICON_FILENAME,
self.legacy_lib_file,
self.legacy_json_file,
- self.legacy_script_path,
):
if self._remove_if_exists(path):
removed.append(str(path))
diff --git a/py_modules/lsfg_vk/plugin.py b/py_modules/lsfg_vk/plugin.py
index 0472e42..f80c635 100644
--- a/py_modules/lsfg_vk/plugin.py
+++ b/py_modules/lsfg_vk/plugin.py
@@ -6,7 +6,7 @@ Vulkan layer for frame generation on Steam Deck.
"""
import os
-from typing import Dict, Any
+from typing import Any, Dict, Optional
import decky
@@ -15,6 +15,7 @@ from .configuration import ConfigurationService
from .flatpak_service import FlatpakService
from .runtime_service import RuntimeService
from .steam_service import SteamService
+from .wrapper_service import WrapperService
class Plugin:
@@ -36,6 +37,7 @@ class Plugin:
)
self.configuration_service = ConfigurationService(runtime_service=self.runtime_service)
self.flatpak_service = FlatpakService()
+ self.wrapper_service = WrapperService()
async def install_lsfg_vk(self) -> Dict[str, Any]:
"""Install the bundled lsfg-vk runtime to ~/.local
@@ -76,6 +78,21 @@ class Plugin:
async def reset_all_game_configs(self) -> Dict[str, Any]:
return self.configuration_service.reset_all_game_configs()
+ async def get_workaround_state(self, appid: str) -> Dict[str, Any]:
+ return self.wrapper_service.get(appid)
+
+ async def set_workaround_state(
+ self,
+ appid: str,
+ state: Dict[str, Any],
+ shortcut_exe: Optional[str] = None,
+ command_token_added: bool = False,
+ ) -> Dict[str, Any]:
+ return self.wrapper_service.set(appid, state, shortcut_exe, command_token_added)
+
+ async def remove_workaround_state(self, appid: str) -> Dict[str, Any]:
+ return self.wrapper_service.remove(appid)
+
async def get_config_file_content(self) -> Dict[str, Any]:
"""Get the current config file content
@@ -177,6 +194,9 @@ class Plugin:
This method is called by Decky Loader when the plugin is loaded.
Any initialization code should go here.
"""
+ repair = self.wrapper_service.repair()
+ if not repair.get("success"):
+ decky.logger.error(f"Could not repair lsfg workaround wrapper: {repair.get('error')}")
decky.logger.info("decky-lsfg-vk plugin loaded")
async def _unload(self):
@@ -198,6 +218,9 @@ class Plugin:
decky.logger.info("decky-lsfg-vk plugin being uninstalled")
# Clean up lsfg-vk files when the plugin is uninstalled
+ # Launch integrations are removed with their profiles. Keep the
+ # generated pass-through wrapper if it is still referenced elsewhere;
+ # InstallationService only removes files owned by the runtime bundle.
self.installation_service.cleanup_on_uninstall()
try:
diff --git a/py_modules/lsfg_vk/wrapper_service.py b/py_modules/lsfg_vk/wrapper_service.py
new file mode 100644
index 0000000..a3cba6e
--- /dev/null
+++ b/py_modules/lsfg_vk/wrapper_service.py
@@ -0,0 +1,428 @@
+"""Own the small per-AppID workaround dispatcher used by Steam launches."""
+
+from __future__ import annotations
+
+import json
+import re
+import shlex
+import threading
+from pathlib import Path
+from typing import Any, Dict, Optional, Tuple
+
+from .base_service import BaseService
+from .constants import WRAPPER_FILENAME
+
+
+class WrapperService(BaseService):
+ """Persist workaround state and compile it into a safe POSIX wrapper."""
+
+ FORMAT_VERSION = 1
+ MARKER = "# lsfg-vk-wrapper-format: 1"
+ WRAPPER_TOKEN = "~/.lsfg"
+ STATE_FIELDS = (
+ "dxvkFrameRate",
+ "disableGamescopeWsi",
+ "disableHdr",
+ "disableSteamdeckMode",
+ "disableVkbasalt",
+ "enableZink",
+ )
+ BOOLEAN_FIELDS = STATE_FIELDS[1:]
+ MANAGED_ENV_KEYS = (
+ "ENABLE_GAMESCOPE_WSI",
+ "DISABLE_GAMESCOPE_WSI",
+ "DXVK_HDR",
+ "SteamDeck",
+ "DISABLE_VKBASALT",
+ "ENABLE_VKBASALT",
+ "MESA_LOADER_DRIVER_OVERRIDE",
+ "__GLX_VENDOR_LIBRARY_NAME",
+ "GALLIUM_DRIVER",
+ "DXVK_FRAME_RATE",
+ )
+
+ def __init__(self, logger=None):
+ super().__init__(logger)
+ self.sidecar_path = self.config_dir / "workarounds.json"
+ self.wrapper_path = self.user_home / WRAPPER_FILENAME
+ self._lock = threading.RLock()
+
+ @classmethod
+ def default_state(cls) -> Dict[str, Any]:
+ return {
+ "dxvkFrameRate": 0,
+ "disableGamescopeWsi": True,
+ "disableHdr": True,
+ "disableSteamdeckMode": False,
+ "disableVkbasalt": False,
+ "enableZink": False,
+ }
+
+ @staticmethod
+ def _valid_appid(appid: Any) -> str:
+ value = str(appid)
+ if not re.fullmatch(r"[1-9][0-9]*", value):
+ raise ValueError("Invalid Steam App ID")
+ return value
+
+ @classmethod
+ def _validate_state(cls, raw: Any) -> Dict[str, Any]:
+ if not isinstance(raw, dict):
+ raise ValueError("Workaround state must be an object")
+ missing = [field for field in cls.STATE_FIELDS if field not in raw]
+ if missing:
+ raise ValueError("Workaround state is missing: " + ", ".join(missing))
+ state = {field: raw[field] for field in cls.STATE_FIELDS}
+ frame_rate = state["dxvkFrameRate"]
+ if isinstance(frame_rate, bool) or not isinstance(frame_rate, int) or not 0 <= frame_rate <= 60:
+ raise ValueError("Base FPS Cap must be an integer from 0 to 60")
+ for field in cls.BOOLEAN_FIELDS:
+ if type(state[field]) is not bool:
+ raise ValueError(f"{field} must be a boolean")
+ return state
+
+ @classmethod
+ def _validate_entry(cls, raw: Any) -> Dict[str, Any]:
+ if not isinstance(raw, dict):
+ raise ValueError("Workaround AppID entry must be an object")
+ entry = {
+ "state": cls._validate_state(raw.get("state")),
+ "command_token_added": raw.get("command_token_added", False),
+ }
+ if type(entry["command_token_added"]) is not bool:
+ raise ValueError("command_token_added must be a boolean")
+ if "shortcut_exe" in raw and raw["shortcut_exe"] is not None:
+ shortcut_exe = raw["shortcut_exe"]
+ if (
+ not isinstance(shortcut_exe, str)
+ or not shortcut_exe.startswith("/")
+ or "\x00" in shortcut_exe
+ or not shortcut_exe.strip()
+ ):
+ raise ValueError("shortcut_exe must be an absolute executable path")
+ entry["shortcut_exe"] = shortcut_exe
+ return entry
+
+ @classmethod
+ def _validate_document(cls, raw: Any) -> Dict[str, Any]:
+ if not isinstance(raw, dict) or raw.get("version") != cls.FORMAT_VERSION:
+ raise ValueError("Unsupported lsfg-vk workaround state version")
+ apps = raw.get("apps")
+ if not isinstance(apps, dict):
+ raise ValueError("Workaround state apps must be an object")
+ validated_apps: Dict[str, Any] = {}
+ for appid, entry in apps.items():
+ normalized = cls._valid_appid(appid)
+ if normalized != str(appid):
+ raise ValueError("Workaround AppIDs must not contain leading zeroes")
+ validated_apps[normalized] = cls._validate_entry(entry)
+ return {"version": cls.FORMAT_VERSION, "apps": validated_apps}
+
+ def _empty_document(self) -> Dict[str, Any]:
+ return {"version": self.FORMAT_VERSION, "apps": {}}
+
+ def _read_document(self) -> Tuple[Dict[str, Any], bool, Optional[str]]:
+ if not self.sidecar_path.exists():
+ return self._empty_document(), False, None
+ if self.sidecar_path.is_symlink() or not self.sidecar_path.is_file():
+ raise RuntimeError("Workaround state path is not a regular file")
+ try:
+ raw = json.loads(self.sidecar_path.read_text(encoding="utf-8"))
+ except (OSError, json.JSONDecodeError) as error:
+ raise RuntimeError(f"Could not read workaround state: {error}") from error
+ document = self._validate_document(raw)
+ return document, True, self.sidecar_path.read_text(encoding="utf-8")
+
+ def _wrapper_marker(self) -> bool:
+ if self.wrapper_path.is_symlink() or not self.wrapper_path.exists():
+ return False
+ if not self.wrapper_path.is_file():
+ raise RuntimeError("lsfg wrapper path is not a regular file")
+ try:
+ prefix = "\n".join(self.wrapper_path.read_text(encoding="utf-8").splitlines()[:8])
+ except OSError as error:
+ raise RuntimeError(f"Could not read lsfg wrapper: {error}") from error
+ return self.MARKER in prefix
+
+ def _assert_wrapper_owned_or_absent(self) -> bool:
+ if not self.wrapper_path.exists() and not self.wrapper_path.is_symlink():
+ return False
+ if self.wrapper_path.is_symlink() or not self._wrapper_marker():
+ raise RuntimeError(
+ f"Refusing to replace unowned wrapper at {self.wrapper_path}"
+ )
+ return True
+
+ @staticmethod
+ def _shell(value: str) -> str:
+ return shlex.quote(value)
+
+ @classmethod
+ def _state_lines(cls, state: Dict[str, Any], shortcut_exe: Optional[str]) -> list[str]:
+ lines = [" unset " + " ".join(cls.MANAGED_ENV_KEYS)]
+ if state["disableGamescopeWsi"]:
+ lines.extend([" ENABLE_GAMESCOPE_WSI=0", " export ENABLE_GAMESCOPE_WSI"])
+ if state["disableHdr"]:
+ lines.extend([" DXVK_HDR=0", " export DXVK_HDR"])
+ if state["disableSteamdeckMode"]:
+ lines.extend([" SteamDeck=0", " export SteamDeck"])
+ if state["disableVkbasalt"]:
+ lines.extend([" DISABLE_VKBASALT=1", " export DISABLE_VKBASALT"])
+ if state["enableZink"]:
+ lines.extend([
+ " __GLX_VENDOR_LIBRARY_NAME=mesa",
+ " export __GLX_VENDOR_LIBRARY_NAME",
+ " MESA_LOADER_DRIVER_OVERRIDE=zink",
+ " export MESA_LOADER_DRIVER_OVERRIDE",
+ " GALLIUM_DRIVER=zink",
+ " export GALLIUM_DRIVER",
+ ])
+ frame_rate = state["dxvkFrameRate"]
+ if frame_rate > 0:
+ lines.extend([
+ ' if [ -n "${DXVK_CONFIG+x}" ]; then',
+ ' if [ -n "${DXVK_CONFIG}" ]; then',
+ f' DXVK_CONFIG="${{DXVK_CONFIG}}; dxvk.maxFrameRate = {frame_rate}"',
+ " else",
+ f' DXVK_CONFIG="dxvk.maxFrameRate = {frame_rate}"',
+ " fi",
+ " else",
+ f' DXVK_CONFIG="dxvk.maxFrameRate = {frame_rate}"',
+ " fi",
+ " export DXVK_CONFIG",
+ ])
+ lines.append(f" shortcut_exe={cls._shell(shortcut_exe or '')}")
+ return lines
+
+ @classmethod
+ def _flatpak_args(cls, state: Dict[str, Any]) -> list[str]:
+ args = [
+ '"--env=SteamAppId=$appid"',
+ '"--unset-env=DISABLE_GAMESCOPE_WSI"',
+ '"--unset-env=ENABLE_GAMESCOPE_WSI"' if not state["disableGamescopeWsi"] else
+ '"--env=ENABLE_GAMESCOPE_WSI=0"',
+ '"--unset-env=DXVK_HDR"' if not state["disableHdr"] else
+ '"--env=DXVK_HDR=0"',
+ '"--unset-env=SteamDeck"' if not state["disableSteamdeckMode"] else
+ '"--env=SteamDeck=0"',
+ '"--unset-env=DISABLE_VKBASALT" "--unset-env=ENABLE_VKBASALT"',
+ ]
+ if state["disableVkbasalt"]:
+ args.append('"--env=DISABLE_VKBASALT=1"')
+ args.extend([
+ '"--unset-env=MESA_LOADER_DRIVER_OVERRIDE" "--unset-env=__GLX_VENDOR_LIBRARY_NAME" "--unset-env=GALLIUM_DRIVER"',
+ ])
+ if state["enableZink"]:
+ args.extend([
+ '"--env=__GLX_VENDOR_LIBRARY_NAME=mesa"',
+ '"--env=MESA_LOADER_DRIVER_OVERRIDE=zink"',
+ '"--env=GALLIUM_DRIVER=zink"',
+ ])
+ args.extend([
+ '"--unset-env=DXVK_FRAME_RATE"',
+ ])
+ static_args = " ".join(args)
+ return [
+ ' if [ -n "${DXVK_CONFIG+x}" ]; then',
+ f' set -- "$flatpak_command" {static_args} "--env=DXVK_CONFIG=$DXVK_CONFIG" "$@"',
+ " else",
+ f' set -- "$flatpak_command" {static_args} "$@"',
+ " fi",
+ ]
+
+ @classmethod
+ def _render_wrapper(cls, document: Dict[str, Any]) -> str:
+ lines = [
+ "#!/bin/sh",
+ cls.MARKER,
+ "# Generated by Decky LSFG-VK; edits will be rejected on the next update.",
+ "",
+ "appid=",
+ 'case "${SteamAppId-}" in',
+ " ''|*[!0-9]*) ;;",
+ ' *) appid="${SteamAppId}" ;;',
+ "esac",
+ 'if [ -z "$appid" ]; then',
+ ' case "${SteamGameId-}" in',
+ " ''|*[!0-9]*) ;;",
+ ' *) appid="${SteamGameId}" ;;',
+ " esac",
+ "fi",
+ 'if [ -z "$appid" ]; then',
+ ' case "${STEAM_COMPAT_APP_ID-}" in',
+ " ''|*[!0-9]*) ;;",
+ ' *) appid="${STEAM_COMPAT_APP_ID}" ;;',
+ " esac",
+ "fi",
+ "shortcut_exe=",
+ 'case "$appid" in',
+ ]
+ for appid in sorted(document["apps"], key=lambda value: int(value)):
+ entry = document["apps"][appid]
+ lines.append(f" {appid})")
+ lines.extend(cls._state_lines(entry["state"], entry.get("shortcut_exe")))
+ lines.append(" ;;")
+ lines.extend([
+ "esac",
+ "",
+ 'if [ -n "$shortcut_exe" ]; then',
+ ' if [ "${1-}" = "run" ]; then',
+ ' flatpak_command="$1"',
+ " shift",
+ ])
+ # The arguments are emitted per branch below so the values are static and
+ # the wrapper never needs a JSON parser or another helper executable.
+ lines.append(' case "$appid" in')
+ for appid in sorted(document["apps"], key=lambda value: int(value)):
+ entry = document["apps"][appid]
+ if not entry.get("shortcut_exe", "").endswith("/flatpak"):
+ continue
+ lines.append(f" {appid})")
+ lines.extend(cls._flatpak_args(entry["state"]))
+ lines.append(" ;;")
+ lines.extend([
+ " esac",
+ " fi",
+ ' exec "$shortcut_exe" "$@"',
+ "fi",
+ 'exec "$@"',
+ "",
+ ])
+ return "\n".join(lines)
+
+ def _write_document(self, document: Dict[str, Any]) -> None:
+ content = json.dumps(document, indent=2, sort_keys=True) + "\n"
+ self._write_file(self.sidecar_path, content, 0o644)
+
+ def _write_pair(self, document: Dict[str, Any]) -> None:
+ old_sidecar_exists = self.sidecar_path.exists()
+ old_sidecar = self.sidecar_path.read_text(encoding="utf-8") if old_sidecar_exists else None
+ old_wrapper_exists = self.wrapper_path.exists() or self.wrapper_path.is_symlink()
+ old_wrapper = self.wrapper_path.read_text(encoding="utf-8") if old_wrapper_exists and not self.wrapper_path.is_symlink() else None
+ try:
+ self._write_document(document)
+ self._write_file(self.wrapper_path, self._render_wrapper(document), 0o755)
+ except Exception:
+ try:
+ if old_sidecar_exists and old_sidecar is not None:
+ self._write_file(self.sidecar_path, old_sidecar, 0o644)
+ elif self.sidecar_path.exists():
+ self.sidecar_path.unlink()
+ if old_wrapper_exists and old_wrapper is not None:
+ self._write_file(self.wrapper_path, old_wrapper, 0o755)
+ elif not old_wrapper_exists and self.wrapper_path.exists():
+ self.wrapper_path.unlink()
+ except Exception as rollback_error:
+ self.log.error(f"Could not roll back workaround wrapper update: {rollback_error}")
+ raise
+
+ def _response(self, document: Dict[str, Any], appid: str = "") -> Dict[str, Any]:
+ entry = document["apps"].get(appid)
+ return {
+ "success": True,
+ "message": "",
+ "error": None,
+ "appid": appid or None,
+ "state": dict(entry["state"]) if entry else None,
+ "wrapper_path": self.WRAPPER_TOKEN,
+ "wrapper_owned": self._wrapper_marker() if document["apps"] else False,
+ "shortcut_exe": entry.get("shortcut_exe") if entry else None,
+ "command_token_added": entry.get("command_token_added", False) if entry else False,
+ }
+
+ def get(self, appid: str) -> Dict[str, Any]:
+ try:
+ normalized = self._valid_appid(appid)
+ with self._lock:
+ document, _, _ = self._read_document()
+ self._assert_wrapper_owned_or_absent()
+ return self._response(document, normalized)
+ except Exception as error:
+ return {
+ "success": False,
+ "message": "",
+ "error": str(error),
+ "appid": str(appid),
+ "state": None,
+ "wrapper_path": self.WRAPPER_TOKEN,
+ "wrapper_owned": False,
+ }
+
+ def set(
+ self,
+ appid: str,
+ state: Dict[str, Any],
+ shortcut_exe: Optional[str] = None,
+ command_token_added: bool = False,
+ ) -> Dict[str, Any]:
+ try:
+ normalized = self._valid_appid(appid)
+ validated_state = self._validate_state(state)
+ if type(command_token_added) is not bool:
+ raise ValueError("command_token_added must be a boolean")
+ with self._lock:
+ self._assert_wrapper_owned_or_absent()
+ document, _, _ = self._read_document()
+ previous_entry = document["apps"].get(normalized)
+ entry: Dict[str, Any] = {
+ "state": validated_state,
+ "command_token_added": bool(command_token_added),
+ }
+ if shortcut_exe is not None:
+ entry = self._validate_entry({**entry, "shortcut_exe": shortcut_exe})
+ elif previous_entry and "shortcut_exe" in previous_entry:
+ entry["shortcut_exe"] = previous_entry["shortcut_exe"]
+ document["apps"][normalized] = entry
+ self._write_pair(document)
+ return self._response(document, normalized)
+ except Exception as error:
+ return {
+ "success": False,
+ "message": "",
+ "error": str(error),
+ "appid": str(appid),
+ "state": None,
+ "wrapper_path": self.WRAPPER_TOKEN,
+ "wrapper_owned": False,
+ }
+
+ def remove(self, appid: str) -> Dict[str, Any]:
+ try:
+ normalized = self._valid_appid(appid)
+ with self._lock:
+ document, _, _ = self._read_document()
+ self._assert_wrapper_owned_or_absent()
+ if normalized not in document["apps"]:
+ return self._response(document, normalized)
+ document["apps"].pop(normalized, None)
+ self._write_pair(document)
+ return self._response(document, normalized)
+ except Exception as error:
+ return {
+ "success": False,
+ "message": "",
+ "error": str(error),
+ "appid": str(appid),
+ "state": None,
+ "wrapper_path": self.WRAPPER_TOKEN,
+ "wrapper_owned": False,
+ }
+
+ def repair(self) -> Dict[str, Any]:
+ """Regenerate a missing owned wrapper without importing old global state."""
+ try:
+ with self._lock:
+ document, _, _ = self._read_document()
+ self._assert_wrapper_owned_or_absent()
+ if not document["apps"]:
+ return self._response(document)
+ self._write_file(self.wrapper_path, self._render_wrapper(document), 0o755)
+ return self._response(document)
+ except Exception as error:
+ return {
+ "success": False,
+ "message": "",
+ "error": str(error),
+ "wrapper_path": self.WRAPPER_TOKEN,
+ "wrapper_owned": False,
+ }
diff --git a/src/api/lsfgApi.ts b/src/api/lsfgApi.ts
index 8eaad98..087228c 100644
--- a/src/api/lsfgApi.ts
+++ b/src/api/lsfgApi.ts
@@ -60,6 +60,27 @@ export interface GameConfigResult extends ConfigUpdateResult {
config?: LsfgConfig;
}
+export interface WorkaroundState {
+ dxvkFrameRate: number;
+ disableGamescopeWsi: boolean;
+ disableHdr: boolean;
+ disableSteamdeckMode: boolean;
+ disableVkbasalt: boolean;
+ enableZink: boolean;
+}
+
+export interface WorkaroundStateResult {
+ success: boolean;
+ message?: string;
+ error?: string;
+ appid?: string;
+ state?: WorkaroundState | null;
+ wrapper_path?: string;
+ wrapper_owned?: boolean;
+ shortcut_exe?: string | null;
+ command_token_added?: boolean;
+}
+
export interface FileContentResult {
success: boolean;
content?: string;
@@ -120,3 +141,11 @@ export const getInstalledGames = callable<[], InstalledGamesResult>("get_install
export const updateGameConfig = callable<[string, string, LsfgConfig], GameConfigResult>("update_game_config");
export const resetGameConfig = callable<[string], GameConfigResult>("reset_game_config");
export const resetAllGameConfigs = callable<[], GameConfigsResult>("reset_all_game_configs");
+export const getWorkaroundState = callable<[string], WorkaroundStateResult>("get_workaround_state");
+export const setWorkaroundState = callable<[
+ string,
+ WorkaroundState,
+ string | null | undefined,
+ boolean,
+], WorkaroundStateResult>("set_workaround_state");
+export const removeWorkaroundState = callable<[string], WorkaroundStateResult>("remove_workaround_state");
diff --git a/src/components/ConfigurationTab.tsx b/src/components/ConfigurationTab.tsx
index c41c941..62a971b 100644
--- a/src/components/ConfigurationTab.tsx
+++ b/src/components/ConfigurationTab.tsx
@@ -15,6 +15,7 @@ interface ConfigurationTabProps {
onConfigChange: (fieldName: keyof ConfigurationData, value: boolean | number | string | string[]) => Promise;
onEnable: (appid: string) => Promise;
onEnableAll: () => Promise;
+ onRepair: (appid: string) => Promise;
onReset: () => Promise;
onResetAll: () => Promise;
}
@@ -27,6 +28,7 @@ export function ConfigurationTab({
onConfigChange,
onEnable,
onEnableAll,
+ onRepair,
onReset,
onResetAll,
}: ConfigurationTabProps) {
@@ -157,6 +159,7 @@ export function ConfigurationTab({
onFpsMultiplierFocused={clearFpsFocusRequest}
showWorkarounds
workaroundTarget={selectedTarget || undefined}
+ onRepairWorkaround={selectedTarget ? () => onRepair(selectedTarget.appid) : undefined}
/>
)}
{selectedTarget?.configured && (
diff --git a/src/components/Content.tsx b/src/components/Content.tsx
index 1d7d2d1..59dc514 100644
--- a/src/components/Content.tsx
+++ b/src/components/Content.tsx
@@ -39,6 +39,7 @@ export function Content() {
save,
enable,
enableAll,
+ repair,
resetSelected,
resetAll,
reload,
@@ -132,6 +133,7 @@ export function Content() {
onConfigChange={(fieldName, value) => handleConfigChange(fieldName, value, true)}
onEnable={enable}
onEnableAll={enableAll}
+ onRepair={repair}
onReset={resetSelected}
onResetAll={resetAll}
/>
diff --git a/src/components/GameConfigurationControls.tsx b/src/components/GameConfigurationControls.tsx
index 58ccd02..7025f78 100644
--- a/src/components/GameConfigurationControls.tsx
+++ b/src/components/GameConfigurationControls.tsx
@@ -11,6 +11,7 @@ interface Props {
onFpsMultiplierFocused?: () => void;
showWorkarounds?: boolean;
workaroundTarget?: Pick;
+ onRepairWorkaround?: () => Promise;
}
export function GameConfigurationControls({
@@ -20,6 +21,7 @@ export function GameConfigurationControls({
onFpsMultiplierFocused,
showWorkarounds = false,
workaroundTarget,
+ onRepairWorkaround,
}: Props) {
return (
<>
@@ -31,7 +33,11 @@ export function GameConfigurationControls({
/>
;
}
const WORKAROUNDS_COLLAPSED_KEY = "lsfg-workarounds-collapsed-v2";
@@ -78,18 +79,28 @@ function usePersistentCollapsed() {
return [collapsed, () => setCollapsed((value) => !value)] as const;
}
-export function WorkaroundsSection({ appId, nonSteam }: WorkaroundsSectionProps) {
+export function WorkaroundsSection({ appId, nonSteam, onRepair }: WorkaroundsSectionProps) {
const [collapsed, toggleCollapsed] = usePersistentCollapsed();
const { status, snapshot, refresh, update, error } = usePerAppWorkarounds(appId, nonSteam);
- const state = snapshot?.parsed.state;
- const issues = snapshot?.parsed.issues || [];
- const controlsDisabled = status !== "ready" || state === undefined;
+ const [repairing, setRepairing] = useState(false);
+ const state = snapshot?.state;
+ const controlsDisabled = status !== "ready" || state === undefined || snapshot?.wrapperOwned !== true || snapshot.integrationInstalled !== true;
const [fpsValue, setFpsValue] = useState(null);
const effectiveFpsValue = fpsValue ?? state?.dxvkFrameRate ?? 0;
const fpsLabel = effectiveFpsValue > 0
? `${effectiveFpsValue} FPS`
: t("CONFIG_BASE_FPS_CAP_OFF", "Off");
+ const handleRepair = async () => {
+ if (!onRepair || repairing) return;
+ setRepairing(true);
+ try {
+ if (await onRepair()) await refresh();
+ } finally {
+ setRepairing(false);
+ }
+ };
+
useEffect(() => {
setFpsValue(state?.dxvkFrameRate ?? null);
}, [state?.dxvkFrameRate, status]);
@@ -155,13 +166,19 @@ export function WorkaroundsSection({ appId, nonSteam }: WorkaroundsSectionProps)
)}
- {status === "ready" && issues.length > 0 && (
-
-
+ {status === "ready" && snapshot && (!snapshot.wrapperOwned || !snapshot.integrationInstalled) && (
+ <>
+
+
+ {onRepair && (
+
+ void handleRepair()}>
+ {repairing ? "Reinstalling..." : "Reinstall wrapper"}
+
+
+ )}
+
)}
diff --git a/src/hooks/useGameConfiguration.ts b/src/hooks/useGameConfiguration.ts
index 6d1fe6a..c66596a 100644
--- a/src/hooks/useGameConfiguration.ts
+++ b/src/hooks/useGameConfiguration.ts
@@ -1,9 +1,9 @@
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import { useQuickAccessVisible } from "@decky/api";
import { Router } from "@decky/ui";
-import { getGameConfigs, getInstalledGames, updateGameConfig, resetGameConfig, resetAllGameConfigs, type GameConfigEntry, type GlobalConfig, type InstalledGame } from "../api/lsfgApi";
+import { getGameConfigs, getInstalledGames, getWorkaroundState, removeWorkaroundState, resetGameConfig, resetAllGameConfigs, setWorkaroundState, updateGameConfig, type GameConfigEntry, type GlobalConfig, type InstalledGame, type WorkaroundState } from "../api/lsfgApi";
import { ConfigurationData, getDefaults } from "../config/configSchema";
-import { applyWorkaroundState, cleanupLegacySteamLaunchOptions, cleanupSteamLaunchOptions, getDefaultWorkaroundState, updateSteamLaunchOptions } from "../utils/steamLaunchOptions";
+import { cleanupLegacySteamLaunchOptions, getDefaultWrapperPath, hasWrapperLaunchIntegration, installWrapperIntegration, isLegacyWrapperToken, readSteamLaunchOptions, removeWrapperIntegration } from "../utils/steamLaunchOptions";
import { showErrorToast } from "../utils/toastUtils";
export interface GameTarget extends InstalledGame { configured: boolean; }
@@ -32,6 +32,19 @@ function mergeInstalledGames(backendGames: InstalledGame[], shortcutGames: Insta
return Array.from(games.values());
}
+const DEFAULT_WORKAROUND_STATE: WorkaroundState = {
+ dxvkFrameRate: 0,
+ disableGamescopeWsi: true,
+ disableHdr: true,
+ disableSteamdeckMode: false,
+ disableVkbasalt: false,
+ enableZink: false,
+};
+
+function asError(error: unknown): Error {
+ return error instanceof Error ? error : new Error(String(error));
+}
+
export function useGameConfiguration() {
const [games, setGames] = useState([]);
const [globalConfig, setGlobalConfig] = useState({ dll: "", no_fp16: false });
@@ -95,39 +108,107 @@ export function useGameConfiguration() {
const template = useMemo(() => ({ ...getDefaults(), ...globalConfig }), [globalConfig]);
const config = games.find((game) => game.appid === selectedAppId)?.config || template;
- const cleanupTargetLaunchOptions = useCallback(async (target: GameTarget): Promise => {
+ const ensureTargetWorkarounds = useCallback(async (target: GameTarget): Promise => {
if (!installedGames.some((game) => game.appid === target.appid)) return true;
+ const appId = Number(target.appid);
try {
- await cleanupLegacySteamLaunchOptions(Number(target.appid), target.nonSteam);
- return true;
- } catch (error) {
- showErrorToast("Could not update Steam launch options", error instanceof Error ? error.message : String(error));
- return false;
- }
- }, [installedGames]);
+ const existing = await getWorkaroundState(target.appid);
+ if (!existing.success) throw new Error(existing.error || "Could not read workaround state");
+ const current = await readSteamLaunchOptions(appId, target.nonSteam);
+ const wrapperPath = existing.wrapper_path || getDefaultWrapperPath();
+ const oldState = existing.state;
+ const oldShortcutExe = existing.shortcut_exe || undefined;
+ const oldCommandTokenAdded = existing.command_token_added === true;
+ if (target.nonSteam && oldState && current.target === wrapperPath && !oldShortcutExe) {
+ throw new Error("Managed shortcut Target has no saved original executable");
+ }
+ if (target.nonSteam && oldState && current.target !== wrapperPath && current.target !== oldShortcutExe) {
+ throw new Error("Shortcut Target changed externally; refusing to replace it");
+ }
+ if (target.nonSteam && !oldState && current.target === wrapperPath) {
+ throw new Error("Shortcut Target is already the managed wrapper but its original Target is unknown");
+ }
+ const state = oldState || { ...DEFAULT_WORKAROUND_STATE };
+ const originalExecutable = target.nonSteam ? (oldShortcutExe || current.target) : undefined;
+ const initialIntegration = target.nonSteam
+ ? current.target === wrapperPath
+ : hasWrapperLaunchIntegration(current.options, wrapperPath);
+ const initialStateResult = await setWorkaroundState(
+ target.appid,
+ state,
+ originalExecutable || null,
+ oldCommandTokenAdded,
+ );
+ if (!initialStateResult.success) throw new Error(initialStateResult.error || "Could not create workaround state");
- const removeTargetLaunchOptions = useCallback(async (target: GameTarget): Promise => {
- if (!installedGames.some((game) => game.appid === target.appid)) return true;
- try {
- await cleanupSteamLaunchOptions(Number(target.appid), target.nonSteam);
- return true;
+ let integration: Awaited> | null = null;
+ try {
+ integration = await installWrapperIntegration(appId, target.nonSteam, wrapperPath, oldCommandTokenAdded);
+ const finalStateResult = await setWorkaroundState(
+ target.appid,
+ state,
+ target.nonSteam ? (integration.originalExecutable || originalExecutable || null) : null,
+ integration.commandTokenAdded,
+ );
+ if (!finalStateResult.success) throw new Error(finalStateResult.error || "Could not finalize workaround state");
+ return true;
+ } catch (error) {
+ let rollbackSucceeded = true;
+ if (!initialIntegration && integration) {
+ try {
+ await removeWrapperIntegration(
+ appId,
+ target.nonSteam,
+ wrapperPath,
+ target.nonSteam ? (integration?.originalExecutable || originalExecutable) : undefined,
+ integration?.commandTokenAdded ?? oldCommandTokenAdded,
+ );
+ } catch (rollbackError) {
+ showErrorToast("Workaround rollback failed", asError(rollbackError).message);
+ rollbackSucceeded = false;
+ }
+ }
+ if (rollbackSucceeded) {
+ const restored = oldState
+ ? await setWorkaroundState(target.appid, oldState, oldShortcutExe || null, oldCommandTokenAdded)
+ : await removeWorkaroundState(target.appid);
+ if (!restored.success) throw new Error(restored.error || "Could not roll back workaround state");
+ }
+ throw error;
+ }
} catch (error) {
- showErrorToast("Could not clean up Steam launch options", error instanceof Error ? error.message : String(error));
+ showErrorToast("Could not initialize workarounds", asError(error).message);
return false;
}
}, [installedGames]);
- const initializeTargetLaunchOptions = useCallback(async (target: GameTarget): Promise => {
+ const removeTargetWorkarounds = useCallback(async (target: GameTarget): Promise => {
if (!installedGames.some((game) => game.appid === target.appid)) return true;
+ const appId = Number(target.appid);
try {
- await updateSteamLaunchOptions(
- Number(target.appid),
- target.nonSteam,
- (options) => applyWorkaroundState(options, getDefaultWorkaroundState()),
- );
+ const existing = await getWorkaroundState(target.appid);
+ if (!existing.success) throw new Error(existing.error || "Could not read workaround state");
+ const wrapperPath = existing.wrapper_path || getDefaultWrapperPath();
+ if (existing.state) {
+ await removeWrapperIntegration(
+ appId,
+ target.nonSteam,
+ wrapperPath,
+ existing.shortcut_exe || undefined,
+ existing.command_token_added === true,
+ );
+ } else {
+ const current = await readSteamLaunchOptions(appId, target.nonSteam);
+ if (target.nonSteam && (current.target === wrapperPath || isLegacyWrapperToken(current.target))) {
+ throw new Error("Shortcut Target is a frame-generation wrapper but its original Target is unknown");
+ }
+ await cleanupLegacySteamLaunchOptions(appId, target.nonSteam, wrapperPath);
+ }
+ const removed = await removeWorkaroundState(target.appid);
+ if (!removed.success) throw new Error(removed.error || "Could not remove workaround state");
return true;
} catch (error) {
- showErrorToast("Could not initialize Steam launch options", error instanceof Error ? error.message : String(error));
+ showErrorToast("Could not clean up game workarounds", asError(error).message);
return false;
}
}, [installedGames]);
@@ -135,37 +216,46 @@ export function useGameConfiguration() {
const save = useCallback(async (next: ConfigurationData, cleanupLaunchOptions = false) => {
const selectedTarget = targets.find((target) => target.appid === selectedAppId);
if (!selectedTarget?.name) return;
- if (cleanupLaunchOptions && !(await cleanupTargetLaunchOptions(selectedTarget))) return;
+ // The profile owns its wrapper integration. Keep this check on every
+ // configuration save so an external edit is detected before the profile
+ // is changed; toggles update the sidecar only.
+ if (cleanupLaunchOptions && !(await ensureTargetWorkarounds(selectedTarget))) return;
const result = await updateGameConfig(selectedAppId, selectedTarget.name, next);
if (result.success) await load();
- }, [cleanupTargetLaunchOptions, load, selectedAppId, targets]);
+ }, [ensureTargetWorkarounds, load, selectedAppId, targets]);
const enable = useCallback(async (appid: string) => {
const target = targets.find((item) => item.appid === appid);
if (!target?.name) return false;
- if (!(await initializeTargetLaunchOptions(target))) return false;
+ if (!(await ensureTargetWorkarounds(target))) return false;
const result = await updateGameConfig(appid, target.name, template);
if (result.success) await load();
+ else await removeTargetWorkarounds(target);
return result.success;
- }, [initializeTargetLaunchOptions, load, targets, template]);
+ }, [ensureTargetWorkarounds, load, removeTargetWorkarounds, targets, template]);
const enableAll = useCallback(async (): Promise => {
const available = targets.filter((target) => !target.configured && target.name);
if (available.length === 0) return;
for (const target of available) {
- if (!(await initializeTargetLaunchOptions(target))) return;
+ if (!(await ensureTargetWorkarounds(target))) return;
const result = await updateGameConfig(target.appid, target.name, template);
if (!result.success) {
showErrorToast("Could not enable all games", result.error || "A game profile could not be created");
+ await removeTargetWorkarounds(target);
return;
}
}
await load();
- }, [initializeTargetLaunchOptions, load, targets, template]);
+ }, [ensureTargetWorkarounds, load, removeTargetWorkarounds, targets, template]);
+ const repair = useCallback(async (appid: string): Promise => {
+ const target = targets.find((item) => item.appid === appid);
+ return target ? ensureTargetWorkarounds(target) : false;
+ }, [ensureTargetWorkarounds, targets]);
const resetSelected = useCallback(async () => {
if (selectedAppId) {
const selectedTarget = targets.find((target) => target.appid === selectedAppId);
- if (selectedTarget && !(await removeTargetLaunchOptions(selectedTarget))) return;
+ if (selectedTarget && !(await removeTargetWorkarounds(selectedTarget))) return;
const result = await resetGameConfig(selectedAppId);
if (result.success) {
setRunningGame((current) => current?.appid === selectedAppId ? { ...current, configured: false } : current);
@@ -173,10 +263,10 @@ export function useGameConfiguration() {
await load();
}
}
- }, [load, removeTargetLaunchOptions, selectedAppId, targets]);
+ }, [load, removeTargetWorkarounds, selectedAppId, targets]);
const resetAll = useCallback(async () => {
for (const target of targets.filter((item) => item.configured)) {
- if (!(await removeTargetLaunchOptions(target))) return;
+ if (!(await removeTargetWorkarounds(target))) return;
}
const result = await resetAllGameConfigs();
if (result.success) {
@@ -184,7 +274,7 @@ export function useGameConfiguration() {
setSelectedAppId("");
await load();
}
- }, [load, removeTargetLaunchOptions, targets]);
+ }, [load, removeTargetWorkarounds, targets]);
- return { config, games, targets, runningGame, selectedAppId, setSelectedAppId, save, enable, enableAll, resetSelected, resetAll, reload: load };
+ return { config, games, targets, runningGame, selectedAppId, setSelectedAppId, save, enable, enableAll, repair, resetSelected, resetAll, reload: load };
}
diff --git a/src/hooks/usePerAppWorkarounds.ts b/src/hooks/usePerAppWorkarounds.ts
index a937780..9e283db 100644
--- a/src/hooks/usePerAppWorkarounds.ts
+++ b/src/hooks/usePerAppWorkarounds.ts
@@ -1,29 +1,50 @@
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import {
- applyWorkaroundChange,
- parseWorkaroundOptions,
+ getWorkaroundState,
+ removeWorkaroundState,
+ setWorkaroundState,
+ type WorkaroundState,
+} from "../api/lsfgApi";
+import {
+ getDefaultWrapperPath,
+ hasWrapperLaunchIntegration,
+ installWrapperIntegration,
+ isLegacyWrapperToken,
readSteamLaunchOptions,
+ removeWrapperIntegration,
subscribeSteamLaunchOptions,
- updateSteamLaunchOptions,
- type ParsedWorkaroundOptions,
type SteamLaunchOptionsSnapshot,
- type WorkaroundField,
} from "../utils/steamLaunchOptions";
import { showErrorToast } from "../utils/toastUtils";
+export type WorkaroundField = keyof WorkaroundState;
export type WorkaroundLoadStatus = "loading" | "ready" | "error";
const SLIDER_DEBOUNCE_MS = 250;
+const DEFAULT_WORKAROUND_STATE: WorkaroundState = {
+ dxvkFrameRate: 0,
+ disableGamescopeWsi: true,
+ disableHdr: true,
+ disableSteamdeckMode: false,
+ disableVkbasalt: false,
+ enableZink: false,
+};
+
interface PendingSliderUpdate {
timer: number;
value: number;
waiters: Array<(success: boolean) => void>;
}
-interface WorkaroundSnapshot {
+export interface WorkaroundSnapshot {
steam: SteamLaunchOptionsSnapshot;
- parsed: ParsedWorkaroundOptions;
+ state: WorkaroundState;
+ wrapperPath: string;
+ wrapperOwned: boolean;
+ integrationInstalled: boolean;
+ commandTokenAdded: boolean;
+ shortcutExe?: string | null;
}
interface PerAppWorkarounds {
@@ -38,8 +59,84 @@ function asError(error: unknown): Error {
return error instanceof Error ? error : new Error(String(error));
}
-function makeSnapshot(steam: SteamLaunchOptionsSnapshot): WorkaroundSnapshot {
- return { steam, parsed: parseWorkaroundOptions(steam.options) };
+function integrationIsInstalled(
+ steam: SteamLaunchOptionsSnapshot,
+ nonSteam: boolean,
+ wrapperPath: string,
+): boolean {
+ return nonSteam ? steam.target === wrapperPath : hasWrapperLaunchIntegration(steam.options, wrapperPath);
+}
+
+function makeSnapshot(
+ steam: SteamLaunchOptionsSnapshot,
+ result: Awaited>,
+ nonSteam: boolean,
+): WorkaroundSnapshot {
+ if (!result.state) throw new Error("Workaround state is not initialized for this profile");
+ const wrapperPath = result.wrapper_path || getDefaultWrapperPath();
+ if (nonSteam && steam.target === wrapperPath && !result.shortcut_exe) {
+ throw new Error("Managed shortcut Target has no saved original executable");
+ }
+ return {
+ steam,
+ state: result.state,
+ wrapperPath,
+ wrapperOwned: result.wrapper_owned === true,
+ integrationInstalled: integrationIsInstalled(steam, nonSteam, wrapperPath),
+ commandTokenAdded: result.command_token_added === true,
+ shortcutExe: result.shortcut_exe,
+ };
+}
+
+async function adoptWorkaroundState(
+ appId: string,
+ nonSteam: boolean,
+ steam: SteamLaunchOptionsSnapshot,
+ wrapperPath: string,
+): Promise {
+ if (nonSteam && (!steam.target || steam.target === wrapperPath || isLegacyWrapperToken(steam.target))) {
+ throw new Error("Shortcut Target is a wrapper but its original Target is unknown");
+ }
+ const originalExecutable = nonSteam ? steam.target : null;
+ const initial = await setWorkaroundState(appId, DEFAULT_WORKAROUND_STATE, originalExecutable, false);
+ if (!initial.success) throw new Error(initial.error || "Could not create workaround state");
+ let integration: Awaited> | null = null;
+ try {
+ integration = await installWrapperIntegration(
+ Number(appId),
+ nonSteam,
+ wrapperPath,
+ );
+ const finalized = await setWorkaroundState(
+ appId,
+ DEFAULT_WORKAROUND_STATE,
+ nonSteam ? (integration.originalExecutable || originalExecutable) : null,
+ integration.commandTokenAdded,
+ );
+ if (!finalized.success) throw new Error(finalized.error || "Could not finalize workaround state");
+ return makeSnapshot(integration.snapshot, finalized, nonSteam);
+ } catch (error) {
+ let rollbackSucceeded = true;
+ if (integration) {
+ try {
+ await removeWrapperIntegration(
+ Number(appId),
+ nonSteam,
+ wrapperPath,
+ nonSteam ? (integration?.originalExecutable || originalExecutable || undefined) : undefined,
+ integration?.commandTokenAdded ?? false,
+ );
+ } catch {
+ // Leave the owned integration in place rather than guessing at cleanup.
+ rollbackSucceeded = false;
+ }
+ }
+ if (rollbackSucceeded) {
+ const removed = await removeWorkaroundState(appId);
+ if (!removed.success) throw new Error(removed.error || "Could not roll back workaround state");
+ }
+ throw error;
+ }
}
export function usePerAppWorkarounds(appId: string, nonSteam: boolean): PerAppWorkarounds {
@@ -49,8 +146,25 @@ export function usePerAppWorkarounds(appId: string, nonSteam: boolean): PerAppWo
const pendingSliderUpdate = useRef(null);
const numericAppId = Number(appId);
- const applySnapshot = useCallback((steam: SteamLaunchOptionsSnapshot) => {
- setSnapshot(makeSnapshot(steam));
+ const loadSnapshot = useCallback(async () => {
+ const [result, steam] = await Promise.all([
+ getWorkaroundState(appId),
+ readSteamLaunchOptions(numericAppId, nonSteam),
+ ]);
+ if (!result.success) throw new Error(result.error || "Could not read workaround state");
+ if (!result.state) {
+ return adoptWorkaroundState(
+ appId,
+ nonSteam,
+ steam,
+ result.wrapper_path || getDefaultWrapperPath(),
+ );
+ }
+ return makeSnapshot(steam, result, nonSteam);
+ }, [appId, nonSteam, numericAppId]);
+
+ const applySnapshot = useCallback((next: WorkaroundSnapshot) => {
+ setSnapshot(next);
setStatus("ready");
setError(null);
}, []);
@@ -59,65 +173,79 @@ export function usePerAppWorkarounds(appId: string, nonSteam: boolean): PerAppWo
setStatus("loading");
setError(null);
try {
- applySnapshot(await readSteamLaunchOptions(numericAppId, nonSteam));
+ applySnapshot(await loadSnapshot());
} catch (refreshError) {
const nextError = asError(refreshError);
setStatus("error");
setError(nextError.message);
}
- }, [applySnapshot, nonSteam, numericAppId]);
+ }, [applySnapshot, loadSnapshot]);
useEffect(() => {
let active = true;
setStatus("loading");
setSnapshot(null);
setError(null);
-
- const handleSnapshot = (nextSnapshot: SteamLaunchOptionsSnapshot) => {
- if (!active) return;
- applySnapshot(nextSnapshot);
- };
- const handleSubscriptionError = (subscriptionError: Error) => {
- if (!active) return;
- setStatus("error");
- setError(subscriptionError.message);
- };
-
let unsubscribe = () => {};
try {
unsubscribe = subscribeSteamLaunchOptions(
numericAppId,
nonSteam,
- handleSnapshot,
- handleSubscriptionError,
+ (steam) => {
+ if (!active) return;
+ setSnapshot((current) => current ? {
+ ...current,
+ steam,
+ integrationInstalled: integrationIsInstalled(steam, nonSteam, current.wrapperPath),
+ } : current);
+ },
+ (subscriptionError) => {
+ if (!active) return;
+ setStatus("error");
+ setError(subscriptionError.message);
+ },
);
} catch (subscriptionError) {
- handleSubscriptionError(asError(subscriptionError));
+ if (active) {
+ setStatus("error");
+ setError(asError(subscriptionError).message);
+ }
}
-
- void readSteamLaunchOptions(numericAppId, nonSteam)
- .then((nextSnapshot) => {
- if (active) applySnapshot(nextSnapshot);
- })
+ void loadSnapshot()
+ .then((next) => { if (active) applySnapshot(next); })
.catch((readError) => {
- if (active) handleSubscriptionError(asError(readError));
+ if (active) {
+ setStatus("error");
+ setError(asError(readError).message);
+ }
});
-
return () => {
active = false;
unsubscribe();
};
- }, [applySnapshot, nonSteam, numericAppId]);
+ }, [applySnapshot, loadSnapshot, nonSteam, numericAppId]);
const persistUpdate = useCallback(async (field: WorkaroundField, value: boolean | number): Promise => {
+ const current = snapshot;
+ if (!current) return false;
setError(null);
+ const nextState = { ...current.state, [field]: value } as WorkaroundState;
try {
- const nextSnapshot = await updateSteamLaunchOptions(
- numericAppId,
- nonSteam,
- (options) => applyWorkaroundChange(options, field, value),
+ const result = await setWorkaroundState(
+ appId,
+ nextState,
+ current.shortcutExe ?? null,
+ current.commandTokenAdded,
);
- applySnapshot(nextSnapshot);
+ if (!result.success || !result.state) throw new Error(result.error || "Could not save workaround state");
+ applySnapshot({
+ ...current,
+ state: result.state,
+ wrapperPath: result.wrapper_path || current.wrapperPath,
+ wrapperOwned: result.wrapper_owned === true,
+ shortcutExe: result.shortcut_exe,
+ commandTokenAdded: result.command_token_added === true,
+ });
return true;
} catch (updateError) {
const nextError = asError(updateError);
@@ -126,14 +254,13 @@ export function usePerAppWorkarounds(appId: string, nonSteam: boolean): PerAppWo
showErrorToast("Workaround update failed", nextError.message);
return false;
}
- }, [applySnapshot, nonSteam, numericAppId]);
+ }, [appId, applySnapshot, snapshot]);
const flushSliderUpdate = useCallback(async (): Promise => {
const pending = pendingSliderUpdate.current;
if (!pending) return true;
-
pendingSliderUpdate.current = null;
- window.clearTimeout(pending.timer);
+ clearTimeout(pending.timer);
const success = await persistUpdate("dxvkFrameRate", pending.value);
pending.waiters.forEach((resolve) => resolve(success));
return success;
@@ -143,30 +270,25 @@ export function usePerAppWorkarounds(appId: string, nonSteam: boolean): PerAppWo
if (field === "dxvkFrameRate") {
setError(null);
return new Promise((resolve) => {
- const pending = pendingSliderUpdate.current ?? { timer: 0, value: 0, waiters: [] };
+ const pending = pendingSliderUpdate.current || { timer: 0, value: 0, waiters: [] };
window.clearTimeout(pending.timer);
pending.value = Number(value);
pending.waiters.push(resolve);
- pending.timer = window.setTimeout(() => {
- void flushSliderUpdate();
- }, SLIDER_DEBOUNCE_MS);
+ pending.timer = window.setTimeout(() => { void flushSliderUpdate(); }, SLIDER_DEBOUNCE_MS);
pendingSliderUpdate.current = pending;
});
}
-
const sliderSuccess = await flushSliderUpdate();
if (!sliderSuccess) return false;
return persistUpdate(field, value);
}, [flushSliderUpdate, persistUpdate]);
- useEffect(() => {
- return () => {
- const pending = pendingSliderUpdate.current;
- if (!pending) return;
- window.clearTimeout(pending.timer);
- pendingSliderUpdate.current = null;
- pending.waiters.forEach((resolve) => resolve(false));
- };
+ useEffect(() => () => {
+ const pending = pendingSliderUpdate.current;
+ if (!pending) return;
+ window.clearTimeout(pending.timer);
+ pendingSliderUpdate.current = null;
+ pending.waiters.forEach((resolve) => resolve(false));
}, [numericAppId, nonSteam]);
return useMemo(() => ({ status, snapshot, refresh, update, error }), [error, refresh, snapshot, status, update]);
diff --git a/src/types.d.ts b/src/types.d.ts
index 4b88d3d..7b5d055 100644
--- a/src/types.d.ts
+++ b/src/types.d.ts
@@ -30,6 +30,7 @@ interface SteamApps {
): SteamAppDetailsRegistration;
SetAppLaunchOptions(appId: number, options: string): void | Promise;
SetShortcutLaunchOptions(appId: number, options: string): void | Promise;
+ SetShortcutExe(appId: number, executable: string): void | Promise;
GetAllShortcuts?(): Promise;
}
diff --git a/src/utils/steamLaunchOptionParser.ts b/src/utils/steamLaunchOptionParser.ts
deleted file mode 100644
index 9449b33..0000000
--- a/src/utils/steamLaunchOptionParser.ts
+++ /dev/null
@@ -1,525 +0,0 @@
-export interface WorkaroundState {
- dxvkFrameRate: number;
- disableGamescopeWsi: boolean;
- disableHdr: boolean;
- disableSteamdeckMode: boolean;
- disableVkbasalt: boolean;
- enableZink: boolean;
-}
-
-export type WorkaroundField = keyof WorkaroundState;
-
-export interface ParsedWorkaroundOptions {
- state: WorkaroundState;
- issues: string[];
-}
-
-interface LaunchToken {
- raw: string;
- value: string;
-}
-
-interface EnvironmentEntry {
- value: string;
- count: number;
-}
-
-type BooleanWorkaroundField = Exclude;
-type EnvironmentSpec = readonly [key: string, value: string];
-type DxvkFrameRateKey = "dxvk.maxFrameRate" | "dxgi.maxFrameRate" | "d3d9.maxFrameRate";
-
-interface WorkaroundDefinition {
- spec: EnvironmentSpec;
- clear: readonly string[];
- label?: string;
-}
-
-const COMMAND_TOKEN = "%command%";
-const LEGACY_WRAPPER_TOKENS = new Set([
- "~/lsfg",
- "/home/deck/lsfg",
- "~/.local/bin/lsfg-vk-experimental",
- "/home/deck/.local/bin/lsfg-vk-experimental",
- "~/.local/bin/mako-run",
- "/home/deck/.local/bin/mako-run",
- "mako-run",
- "~/.local/bin/mako-launch",
- "/home/deck/.local/bin/mako-launch",
- "mako-launch",
-]);
-const DXVK_FRAME_RATE_KEYS: readonly DxvkFrameRateKey[] = [
- "dxvk.maxFrameRate",
- "dxgi.maxFrameRate",
- "d3d9.maxFrameRate",
-];
-const DXVK_MANAGED_KEYS = new Set(["DXVK_CONFIG", "DXVK_FRAME_RATE"]);
-const WORKAROUND_DEFINITIONS = {
- disableGamescopeWsi: {
- spec: ["ENABLE_GAMESCOPE_WSI", "0"],
- clear: ["DISABLE_GAMESCOPE_WSI", "ENABLE_GAMESCOPE_WSI"],
- },
- disableHdr: {
- spec: ["DXVK_HDR", "0"],
- clear: ["DXVK_HDR"],
- label: "Disable HDR",
- },
- disableSteamdeckMode: {
- spec: ["SteamDeck", "0"],
- clear: ["SteamDeck"],
- label: "Steam Deck mode",
- },
- disableVkbasalt: {
- spec: ["DISABLE_VKBASALT", "1"],
- clear: ["DISABLE_VKBASALT"],
- label: "Disable vkBasalt",
- },
- enableZink: {
- spec: ["MESA_LOADER_DRIVER_OVERRIDE", "zink"],
- clear: ["__GLX_VENDOR_LIBRARY_NAME", "MESA_LOADER_DRIVER_OVERRIDE", "GALLIUM_DRIVER"],
- },
-} as const satisfies Record;
-const BOOLEAN_WORKAROUND_FIELDS: readonly BooleanWorkaroundField[] = [
- "disableGamescopeWsi",
- "disableHdr",
- "disableSteamdeckMode",
- "disableVkbasalt",
- "enableZink",
-];
-const WSI_DISABLE_KEY = "DISABLE_GAMESCOPE_WSI";
-const WSI_ENABLE_KEY = "ENABLE_GAMESCOPE_WSI";
-const WORKAROUND_ENV_KEYS = new Set(
- BOOLEAN_WORKAROUND_FIELDS.flatMap((field) => WORKAROUND_DEFINITIONS[field].clear),
-);
-const MANAGED_ENV_KEYS = new Set([
- ...DXVK_MANAGED_KEYS,
- ...WORKAROUND_ENV_KEYS,
-]);
-
-const EMPTY_WORKAROUND_STATE: WorkaroundState = {
- dxvkFrameRate: 0,
- disableGamescopeWsi: false,
- disableHdr: false,
- disableSteamdeckMode: false,
- disableVkbasalt: false,
- enableZink: false,
-};
-const DEFAULT_WORKAROUND_STATE: WorkaroundState = {
- ...EMPTY_WORKAROUND_STATE,
- disableGamescopeWsi: true,
- disableHdr: true,
-};
-
-export function getDefaultWorkaroundState(): WorkaroundState {
- return { ...DEFAULT_WORKAROUND_STATE };
-}
-
-function decodeToken(raw: string): string {
- let value = "";
- let quote: "'" | '"' | null = null;
-
- for (let index = 0; index < raw.length; index += 1) {
- const character = raw[index];
- if (character === "\\" && quote !== "'" && index + 1 < raw.length) {
- value += raw[index + 1];
- index += 1;
- } else if (quote !== null) {
- if (character === quote) quote = null;
- else value += character;
- } else if (character === "'" || character === '"') {
- quote = character;
- } else {
- value += character;
- }
- }
-
- return value;
-}
-
-function tokenize(options: string): LaunchToken[] {
- const tokens: LaunchToken[] = [];
- let start = -1;
- let quote: "'" | '"' | null = null;
- let escaped = false;
-
- for (let index = 0; index < options.length; index += 1) {
- const character = options[index];
- if (start < 0) {
- if (/\s/.test(character)) continue;
- start = index;
- }
-
- if (escaped) {
- escaped = false;
- } else if (character === "\\" && quote !== "'") {
- escaped = true;
- } else if (quote !== null) {
- if (character === quote) quote = null;
- } else if (character === "'" || character === '"') {
- quote = character;
- } else if (/\s/.test(character)) {
- const raw = options.slice(start, index);
- tokens.push({ raw, value: decodeToken(raw) });
- start = -1;
- }
- }
-
- if (start >= 0) {
- const raw = options.slice(start);
- tokens.push({ raw, value: decodeToken(raw) });
- }
- return tokens;
-}
-
-function serialize(tokens: readonly LaunchToken[]): string {
- if (tokens.length === 1 && tokens[0].raw.toLowerCase() === COMMAND_TOKEN) return "";
- return tokens.map((token) => token.raw).join(" ");
-}
-
-export function normalizeLaunchOptions(options: string): string {
- return serialize(tokenize(options));
-}
-
-function parseEnvironmentToken(token: LaunchToken): [string, string] | null {
- const separator = token.value.indexOf("=");
- if (separator < 1) return null;
- const key = token.value.slice(0, separator);
- if (!/^[A-Za-z_][A-Za-z0-9_]*$/.test(key)) return null;
- return [key, token.value.slice(separator + 1)];
-}
-
-function findCommandIndex(tokens: readonly LaunchToken[]): number {
- return tokens.findIndex((token) => token.raw.toLowerCase() === COMMAND_TOKEN);
-}
-
-function leadingEnvironmentCount(tokens: readonly LaunchToken[]): number {
- let count = 0;
- while (count < tokens.length && parseEnvironmentToken(tokens[count]) !== null) count += 1;
- return count;
-}
-
-function effectivePrefixLimit(tokens: readonly LaunchToken[]): number {
- return leadingEnvironmentCount(tokens);
-}
-
-function effectiveEnvironmentEntries(tokens: readonly LaunchToken[]): Map {
- const entries = new Map();
- for (let index = 0; index < effectivePrefixLimit(tokens); index += 1) {
- const parsed = parseEnvironmentToken(tokens[index]);
- if (!parsed) continue;
- const [key, value] = parsed;
- const previous = entries.get(key);
- entries.set(key, { value, count: (previous?.count || 0) + 1 });
- }
- return entries;
-}
-
-function removePrefixAssignments(tokens: LaunchToken[], predicate: (token: LaunchToken) => boolean): boolean {
- const limit = effectivePrefixLimit(tokens);
- const retained = tokens.filter((token, index) => index >= limit || !predicate(token));
- if (retained.length === tokens.length) return false;
- tokens.splice(0, tokens.length, ...retained);
- return true;
-}
-
-function removeAllAssignments(tokens: LaunchToken[], keys: ReadonlySet): boolean {
- return removePrefixAssignments(tokens, (token) => {
- const parsed = parseEnvironmentToken(token);
- return parsed !== null && keys.has(parsed[0]);
- });
-}
-
-function encodeEnvironmentValue(value: string): string {
- if (/^[A-Za-z0-9_./:+,%=-]+$/.test(value)) return value;
- return `"${value.replace(/\\/g, "\\\\").replace(/"/g, '\\"')}"`;
-}
-
-function insertEnvironmentSpecs(tokens: LaunchToken[], specs: readonly EnvironmentSpec[]): void {
- tokens.unshift(...specs.map(([key, value]) => ({
- raw: `${key}=${encodeEnvironmentValue(value)}`,
- value: `${key}=${value}`,
- })));
-}
-
-function ensureCommandToken(tokens: LaunchToken[]): void {
- if (findCommandIndex(tokens) >= 0) return;
- tokens.splice(leadingEnvironmentCount(tokens), 0, { raw: COMMAND_TOKEN, value: COMMAND_TOKEN });
-}
-
-export function isLegacyWrapperToken(value: string): boolean {
- const path = decodeToken(value);
- return LEGACY_WRAPPER_TOKENS.has(path);
-}
-
-function removeLegacyWrapperFromTokens(tokens: LaunchToken[]): boolean {
- const commandIndex = findCommandIndex(tokens);
- const prefixEnd = commandIndex >= 0 ? commandIndex : tokens.length;
- const retained = tokens.filter((token, index) => index >= prefixEnd || !isLegacyWrapperToken(token.raw));
- if (retained.length === tokens.length) return false;
- tokens.splice(0, tokens.length, ...retained);
- return true;
-}
-
-interface DxvkConfigAssignment {
- values: string[];
- malformed: number;
-}
-
-interface ParsedDxvkConfig {
- segments: string[];
- assignments: Map;
-}
-
-function splitDxvkConfig(value: string): string[] {
- const segments: string[] = [];
- let start = 0;
- let quote: "'" | '"' | null = null;
- let escaped = false;
-
- for (let index = 0; index < value.length; index += 1) {
- const character = value[index];
- if (escaped) escaped = false;
- else if (character === "\\" && quote !== "'") escaped = true;
- else if (quote !== null) {
- if (character === quote) quote = null;
- } else if (character === "'" || character === '"') quote = character;
- else if (character === ";") {
- segments.push(value.slice(start, index));
- start = index + 1;
- }
- }
-
- segments.push(value.slice(start));
- return segments;
-}
-
-function knownDxvkKey(value: string): DxvkFrameRateKey | null {
- const key = value.match(/^([A-Za-z][A-Za-z0-9.]*)/)?.[1];
- return key && DXVK_FRAME_RATE_KEYS.includes(key as DxvkFrameRateKey)
- ? key as DxvkFrameRateKey
- : null;
-}
-
-function parseDxvkConfig(value: string): ParsedDxvkConfig {
- const segments = splitDxvkConfig(value);
- const assignments = new Map();
- for (const segment of segments) {
- const trimmed = segment.trim();
- const key = knownDxvkKey(trimmed);
- if (!key) continue;
- const match = trimmed.match(/^[A-Za-z][A-Za-z0-9.]*\s*=\s*(.*?)\s*$/);
- const entry = assignments.get(key) || { values: [], malformed: 0 };
- if (match) entry.values.push(match[1]);
- else entry.malformed += 1;
- assignments.set(key, entry);
- }
- return { segments, assignments };
-}
-
-function isDxvkFrameRateSegment(segment: string): boolean {
- return knownDxvkKey(segment.trim()) !== null;
-}
-
-function parseSupportedFrameRate(value: string): number | null {
- if (!/^\d+$/.test(value)) return null;
- const numericValue = Number(value);
- return Number.isSafeInteger(numericValue) && numericValue <= 60 ? numericValue : null;
-}
-
-function rewriteDxvkFrameRate(tokens: LaunchToken[], frameRate: number): void {
- const config = effectiveEnvironmentEntries(tokens).get("DXVK_CONFIG");
- const parsed = parseDxvkConfig(config?.value || "");
- const retained = parsed.segments
- .filter((segment) => !isDxvkFrameRateSegment(segment))
- .filter((segment) => segment.trim().length > 0)
- .join(";");
- const nextConfig = frameRate > 0
- ? [`dxvk.maxFrameRate = ${frameRate}`, ...(retained ? [retained] : [])].join(";")
- : retained;
-
- removeAllAssignments(tokens, DXVK_MANAGED_KEYS);
- if (nextConfig) {
- ensureCommandToken(tokens);
- insertEnvironmentSpecs(tokens, [["DXVK_CONFIG", nextConfig]]);
- }
-}
-
-function environmentSpecsForState(state: WorkaroundState): EnvironmentSpec[] {
- return BOOLEAN_WORKAROUND_FIELDS
- .filter((field) => state[field])
- .map((field) => WORKAROUND_DEFINITIONS[field].spec);
-}
-
-function validateFrameRate(frameRate: number): void {
- if (!Number.isInteger(frameRate) || frameRate < 0 || frameRate > 60) {
- throw new Error("Base FPS Cap must be an integer from 0 to 60");
- }
-}
-
-function readBoolean(
- entries: Map,
- key: string,
- label: string,
- trueValue: string,
- issues: string[],
-): boolean {
- const entry = entries.get(key);
- if (!entry) return false;
- const falseValue = trueValue === "1" ? "0" : "1";
- if (entry.value === trueValue) return true;
- if (entry.value === falseValue) return false;
- issues.push(`${label} has an unsupported value.`);
- return false;
-}
-
-export function parseWorkaroundOptions(options: string): ParsedWorkaroundOptions {
- const tokens = tokenize(options);
- const entries = effectiveEnvironmentEntries(tokens);
- const state = { ...EMPTY_WORKAROUND_STATE };
- const issues: string[] = [];
-
- for (const [key, entry] of entries) {
- if (MANAGED_ENV_KEYS.has(key) && entry.count > 1) {
- issues.push(`${key} appears more than once; Steam uses the last value.`);
- }
- }
-
- const dxvkConfig = parseDxvkConfig(entries.get("DXVK_CONFIG")?.value || "");
- const effectiveDxvkValues = new Map();
- for (const key of DXVK_FRAME_RATE_KEYS) {
- const assignment = dxvkConfig.assignments.get(key);
- if (!assignment) continue;
- if (assignment.malformed > 0) issues.push(`${key} in DXVK_CONFIG is malformed.`);
- if (assignment.values.length > 1) {
- issues.push(`${key} appears more than once in DXVK_CONFIG; DXVK uses the last value.`);
- }
- if (assignment.values.length === 0) continue;
- const value = parseSupportedFrameRate(assignment.values[assignment.values.length - 1]);
- effectiveDxvkValues.set(key, value);
- if (value === null) issues.push(`${key} in DXVK_CONFIG is outside the supported 0-60 range.`);
- }
-
- const unifiedFrameRate = effectiveDxvkValues.get("dxvk.maxFrameRate");
- const dxgiFrameRate = effectiveDxvkValues.get("dxgi.maxFrameRate");
- const d3d9FrameRate = effectiveDxvkValues.get("d3d9.maxFrameRate");
- if (unifiedFrameRate !== undefined) {
- if (unifiedFrameRate !== null) state.dxvkFrameRate = unifiedFrameRate;
- } else if (dxgiFrameRate !== undefined && d3d9FrameRate !== undefined) {
- if (dxgiFrameRate !== null && dxgiFrameRate === d3d9FrameRate) state.dxvkFrameRate = dxgiFrameRate;
- else issues.push("DXVK_CONFIG has conflicting or invalid DirectX frame caps.");
- } else if (dxgiFrameRate !== undefined || d3d9FrameRate !== undefined) {
- const partial = dxgiFrameRate ?? d3d9FrameRate;
- if (partial !== null && partial !== undefined) state.dxvkFrameRate = partial;
- issues.push("DXVK_CONFIG only caps one DirectX API; adjust the cap to normalize it.");
- }
-
- if (entries.has("DXVK_FRAME_RATE")) {
- issues.push("DXVK_FRAME_RATE is obsolete on current DXVK; adjust the cap to migrate it.");
- }
-
- const wsiSignals: boolean[] = [];
- const wsiDisable = entries.get(WSI_DISABLE_KEY);
- if (wsiDisable) {
- if (wsiDisable.value !== "0" && wsiDisable.value !== "1") issues.push("Disable Gamescope WSI has an unsupported value.");
- else wsiSignals.push(wsiDisable.value === "1");
- }
- const wsiEnable = entries.get(WSI_ENABLE_KEY);
- if (wsiEnable) {
- if (wsiEnable.value !== "0" && wsiEnable.value !== "1") issues.push("Enable Gamescope WSI has an unsupported value.");
- else wsiSignals.push(wsiEnable.value === "0");
- }
- if (wsiSignals.length > 0) {
- if (wsiSignals.length === 2 && wsiSignals[0] !== wsiSignals[1]) {
- issues.push("Gamescope WSI has conflicting enable and disable assignments.");
- }
- state.disableGamescopeWsi = wsiSignals.some(Boolean);
- }
-
- for (const field of ["disableHdr", "disableSteamdeckMode", "disableVkbasalt"] as const) {
- const { spec, label } = WORKAROUND_DEFINITIONS[field];
- state[field] = readBoolean(entries, spec[0], label || field, spec[1], issues);
- }
-
- const vkBasaltEnable = entries.get("ENABLE_VKBASALT");
- const vkBasaltDisable = entries.get("DISABLE_VKBASALT");
- if (vkBasaltEnable?.value === "1" && vkBasaltDisable?.value === "1") {
- issues.push("vkBasalt has conflicting enable and disable assignments.");
- }
-
- const zink = entries.get(WORKAROUND_DEFINITIONS.enableZink.spec[0]);
- const glxVendor = entries.get("__GLX_VENDOR_LIBRARY_NAME");
- const galliumDriver = entries.get("GALLIUM_DRIVER");
- const hasLegacyZink = glxVendor !== undefined || galliumDriver !== undefined;
- if (zink || hasLegacyZink) {
- state.enableZink = zink?.value === WORKAROUND_DEFINITIONS.enableZink.spec[1];
- if (hasLegacyZink && (
- glxVendor?.value !== "mesa" ||
- zink?.value !== WORKAROUND_DEFINITIONS.enableZink.spec[1] ||
- galliumDriver?.value !== "zink"
- )) {
- issues.push("Zink workaround is only partially configured.");
- } else if (!state.enableZink) {
- issues.push("Zink workaround has an unsupported driver value.");
- }
- }
-
- return { state, issues };
-}
-
-export function applyWorkaroundState(options: string, state: WorkaroundState): string {
- validateFrameRate(state.dxvkFrameRate);
- const tokens = tokenize(options);
- removeLegacyWrapperFromTokens(tokens);
- rewriteDxvkFrameRate(tokens, state.dxvkFrameRate);
- const keysToClear = new Set(
- WORKAROUND_ENV_KEYS,
- );
- if (state.disableVkbasalt) keysToClear.add("ENABLE_VKBASALT");
- removeAllAssignments(tokens, keysToClear);
- const specs = environmentSpecsForState(state);
- if (specs.length > 0) {
- ensureCommandToken(tokens);
- insertEnvironmentSpecs(tokens, specs);
- }
- return serialize(tokens);
-}
-
-export function applyWorkaroundChange(options: string, field: WorkaroundField, value: boolean | number): string {
- const tokens = tokenize(options);
- removeLegacyWrapperFromTokens(tokens);
-
- if (field === "dxvkFrameRate") {
- if (typeof value !== "number") throw new Error("Base FPS Cap must be an integer from 0 to 60");
- validateFrameRate(value);
- rewriteDxvkFrameRate(tokens, value);
- return serialize(tokens);
- }
-
- if (typeof value !== "boolean") throw new Error(`${field} must be a boolean`);
- const definition = WORKAROUND_DEFINITIONS[field];
- const keysToClear = new Set(definition.clear);
- if (value && field === "disableVkbasalt") keysToClear.add("ENABLE_VKBASALT");
- removeAllAssignments(tokens, keysToClear);
- if (value) {
- ensureCommandToken(tokens);
- insertEnvironmentSpecs(tokens, [definition.spec]);
- }
- return serialize(tokens);
-}
-
-export function cleanupLegacyLaunchOptions(options: string): string {
- const tokens = tokenize(options);
- removeLegacyWrapperFromTokens(tokens);
- return serialize(tokens);
-}
-
-export function cleanupPluginLaunchOptions(options: string): string {
- const tokens = tokenize(options);
- removeLegacyWrapperFromTokens(tokens);
- rewriteDxvkFrameRate(tokens, 0);
- removeAllAssignments(tokens, WORKAROUND_ENV_KEYS);
- return serialize(tokens);
-}
-
-export function cleanupLegacyWrapper(options: string): string {
- return cleanupLegacyLaunchOptions(options);
-}
diff --git a/src/utils/steamLaunchOptions.ts b/src/utils/steamLaunchOptions.ts
index 82ff94b..e00b32d 100644
--- a/src/utils/steamLaunchOptions.ts
+++ b/src/utils/steamLaunchOptions.ts
@@ -1,16 +1,52 @@
-// @ts-expect-error Node's built-in TypeScript loader requires explicit source extensions in tests.
-import { cleanupLegacyLaunchOptions, cleanupPluginLaunchOptions, isLegacyWrapperToken, normalizeLaunchOptions } from "./steamLaunchOptionParser.ts";
+const DEFAULT_WRAPPER_PATH = "~/.lsfg";
+const COMMAND_TOKEN = "%command%";
-// @ts-expect-error Node's built-in TypeScript loader requires explicit source extensions in tests.
-export * from "./steamLaunchOptionParser.ts";
+export const LEGACY_WRAPPER_TOKENS = new Set([
+ "~/lsfg",
+ "~/.local/bin/lsfg",
+ "~/.local/bin/lsfg-vk-experimental",
+ "~/.local/bin/mako-run",
+ "mako-run",
+ "~/.local/bin/mako-launch",
+ "mako-launch",
+]);
+
+const LEGACY_ABSOLUTE_WRAPPER = /^\/(?:home|Users)\/[^/]+\/(?:lsfg|\.local\/bin\/(?:lsfg|lsfg-vk-experimental|mako-run|mako-launch))$/;
+
+const MANAGED_ENV_KEYS = new Set([
+ "ENABLE_GAMESCOPE_WSI",
+ "DISABLE_GAMESCOPE_WSI",
+ "DXVK_HDR",
+ "SteamDeck",
+ "DISABLE_VKBASALT",
+ "ENABLE_VKBASALT",
+ "MESA_LOADER_DRIVER_OVERRIDE",
+ "__GLX_VENDOR_LIBRARY_NAME",
+ "GALLIUM_DRIVER",
+ "DXVK_FRAME_RATE",
+]);
+
+const DXVK_FRAME_RATE_SEGMENT = /^(?:dxvk\.maxFrameRate|dxgi\.maxFrameRate|d3d9\.maxFrameRate)\s*=/i;
+
+interface LaunchToken {
+ raw: string;
+ value: string;
+}
export interface SteamLaunchOptionsSnapshot {
appId: number;
nonSteam: boolean;
options: string;
+ target: string;
details: SteamAppDetails;
}
+export interface WrapperIntegrationResult {
+ snapshot: SteamLaunchOptionsSnapshot;
+ originalExecutable?: string;
+ commandTokenAdded: boolean;
+}
+
function validateAppId(appId: number): void {
if (!Number.isSafeInteger(appId) || appId <= 0) throw new Error("Invalid Steam App ID");
}
@@ -21,14 +57,30 @@ function getSteamApps(): Partial | undefined {
}).SteamClient?.Apps;
}
-function snapshotFromDetails(appId: number, nonSteam: boolean, details: SteamAppDetails): SteamLaunchOptionsSnapshot {
- if (nonSteam && isLegacyWrapperToken(details.strShortcutExe || "")) {
- throw new Error("The shortcut Target still points to a legacy frame-generation wrapper; restore its original executable first");
+interface TimerHost {
+ setTimeout(handler: () => void, timeout: number): number;
+ clearTimeout(timeout: number): void;
+}
+
+function timerHost(): TimerHost {
+ if (typeof window !== "undefined") {
+ return {
+ setTimeout: (handler, timeout) => window.setTimeout(handler, timeout),
+ clearTimeout: (timeout) => window.clearTimeout(timeout),
+ };
}
+ return {
+ setTimeout: (handler, timeout) => globalThis.setTimeout(handler, timeout) as unknown as number,
+ clearTimeout: (timeout) => globalThis.clearTimeout(timeout),
+ };
+}
+
+function snapshotFromDetails(appId: number, nonSteam: boolean, details: SteamAppDetails): SteamLaunchOptionsSnapshot {
return {
appId,
nonSteam,
options: nonSteam ? details.strShortcutLaunchOptions || "" : details.strLaunchOptions || "",
+ target: nonSteam ? details.strShortcutExe || "" : "",
details,
};
}
@@ -44,7 +96,7 @@ function registerSteamAppDetails(
validateAppId(appId);
const apps = getSteamApps();
const registerForAppDetails = apps?.RegisterForAppDetails;
- if (!registerForAppDetails) throw new Error("Steam launch options API is unavailable");
+ if (!registerForAppDetails) throw new Error("Steam app-details API is unavailable");
let active = true;
let unregisterPending = false;
@@ -58,7 +110,7 @@ function registerSteamAppDetails(
try {
registration.unregister();
} catch {
- // Steam may invalidate registrations during a details refresh.
+ // Steam can invalidate a registration while details are refreshing.
}
};
@@ -71,7 +123,7 @@ function registerSteamAppDetails(
try {
registration.unregister();
} catch {
- // The registration can be invalidated before a synchronous callback returns.
+ // A synchronous callback can invalidate the registration before return.
}
}
} catch (error) {
@@ -83,25 +135,21 @@ function registerSteamAppDetails(
export async function readSteamLaunchOptions(appId: number, nonSteam: boolean): Promise {
return new Promise((resolve, reject) => {
let settled = false;
- let timeout = 0;
+ let timeout: number | undefined;
let unsubscribe = () => {};
const finish = (error?: unknown, details?: SteamAppDetails) => {
if (settled) return;
settled = true;
- window.clearTimeout(timeout);
+ if (timeout !== undefined) timerHost().clearTimeout(timeout);
unsubscribe();
if (error) {
reject(asError(error));
return;
}
- try {
- resolve(snapshotFromDetails(appId, nonSteam, details || {}));
- } catch (snapshotError) {
- reject(asError(snapshotError));
- }
+ resolve(snapshotFromDetails(appId, nonSteam, details || {}));
};
- timeout = window.setTimeout(() => finish(new Error("Timed out reading Steam launch options")), 5000);
+ timeout = timerHost().setTimeout(() => finish(new Error("Timed out reading Steam app details")), 5000);
try {
unsubscribe = registerSteamAppDetails(appId, (details) => {
finish(undefined, details);
@@ -128,6 +176,224 @@ export function subscribeSteamLaunchOptions(
});
}
+function decodeToken(raw: string): string {
+ let value = "";
+ let quote: "'" | '"' | null = null;
+ for (let index = 0; index < raw.length; index += 1) {
+ const character = raw[index];
+ if (character === "\\" && quote !== "'" && index + 1 < raw.length) {
+ value += raw[index + 1];
+ index += 1;
+ } else if (quote !== null) {
+ if (character === quote) quote = null;
+ else value += character;
+ } else if (character === "'" || character === '"') {
+ quote = character;
+ } else {
+ value += character;
+ }
+ }
+ return value;
+}
+
+function tokenize(options: string): LaunchToken[] {
+ const tokens: LaunchToken[] = [];
+ let start = -1;
+ let quote: "'" | '"' | null = null;
+ let escaped = false;
+ for (let index = 0; index < options.length; index += 1) {
+ const character = options[index];
+ if (start < 0) {
+ if (/\s/.test(character)) continue;
+ start = index;
+ }
+ if (escaped) escaped = false;
+ else if (character === "\\" && quote !== "'") escaped = true;
+ else if (quote !== null) {
+ if (character === quote) quote = null;
+ } else if (character === "'" || character === '"') quote = character;
+ else if (/\s/.test(character)) {
+ const raw = options.slice(start, index);
+ tokens.push({ raw, value: decodeToken(raw) });
+ start = -1;
+ }
+ }
+ if (start >= 0) {
+ const raw = options.slice(start);
+ tokens.push({ raw, value: decodeToken(raw) });
+ }
+ return tokens;
+}
+
+function serialize(tokens: readonly LaunchToken[]): string {
+ return tokens.map((token) => token.raw).join(" ");
+}
+
+export function normalizeLaunchOptions(options: string): string {
+ return serialize(tokenize(options));
+}
+
+function isCommandToken(token: LaunchToken): boolean {
+ return token.raw.toLowerCase() === COMMAND_TOKEN;
+}
+
+function commandIndex(tokens: readonly LaunchToken[]): number {
+ return tokens.findIndex(isCommandToken);
+}
+
+function isAssignment(token: LaunchToken): boolean {
+ return /^[A-Za-z_][A-Za-z0-9_]*=/.test(token.value);
+}
+
+function isLegacyToken(value: string): boolean {
+ return LEGACY_WRAPPER_TOKENS.has(value) || LEGACY_ABSOLUTE_WRAPPER.test(value);
+}
+
+export function isLegacyWrapperToken(value: string): boolean {
+ return isLegacyToken(decodeToken(value));
+}
+
+function isWrapperToken(value: string, wrapperPath: string): boolean {
+ return decodeToken(value) === wrapperPath || isLegacyWrapperToken(value);
+}
+
+function removeWrapperTokens(tokens: LaunchToken[], wrapperPath: string): boolean {
+ const index = commandIndex(tokens);
+ const prefixEnd = index >= 0 ? index : tokens.length;
+ const retained = tokens.filter((token, tokenIndex) => tokenIndex >= prefixEnd || !isWrapperToken(token.value, wrapperPath));
+ if (retained.length === tokens.length) return false;
+ tokens.splice(0, tokens.length, ...retained);
+ return true;
+}
+
+function removeLegacyTokens(tokens: LaunchToken[]): boolean {
+ const index = commandIndex(tokens);
+ const prefixEnd = index >= 0 ? index : tokens.length;
+ const retained = tokens.filter((token, tokenIndex) => tokenIndex >= prefixEnd || !isLegacyToken(token.value));
+ if (retained.length === tokens.length) return false;
+ tokens.splice(0, tokens.length, ...retained);
+ return true;
+}
+
+function leadingAssignments(tokens: readonly LaunchToken[]): number {
+ let count = 0;
+ while (count < tokens.length && isAssignment(tokens[count])) count += 1;
+ return count;
+}
+
+function wrapperToken(wrapperPath: string): LaunchToken {
+ return { raw: wrapperPath, value: wrapperPath };
+}
+
+export interface LaunchOptionRewrite {
+ options: string;
+ commandTokenAdded: boolean;
+}
+
+/** Add one exact wrapper token immediately before Steam's command macro. */
+export function installWrapperLaunchOption(options: string, wrapperPath = DEFAULT_WRAPPER_PATH): LaunchOptionRewrite {
+ const tokens = tokenize(options);
+ removeLegacyTokens(tokens);
+ let index = commandIndex(tokens);
+ if (index >= 0) {
+ const currentWrapper = tokens[index - 1];
+ if (currentWrapper && currentWrapper.value === wrapperPath) {
+ return { options: serialize(tokens), commandTokenAdded: false };
+ }
+ const retained = tokens.filter((token, tokenIndex) => tokenIndex >= index || token.value !== wrapperPath);
+ tokens.splice(0, tokens.length, ...retained);
+ index = commandIndex(tokens);
+ tokens.splice(index, 0, wrapperToken(wrapperPath));
+ return { options: serialize(tokens), commandTokenAdded: false };
+ }
+
+ const insertion = leadingAssignments(tokens);
+ const argumentsOnly = insertion === tokens.length || tokens[insertion]?.value.startsWith("-");
+ if (tokens.length !== insertion && !argumentsOnly) {
+ throw new Error("Launch options do not contain %command%; refusing to guess a launcher command");
+ }
+ tokens.splice(insertion, 0, wrapperToken(wrapperPath), { raw: COMMAND_TOKEN, value: COMMAND_TOKEN });
+ return { options: serialize(tokens), commandTokenAdded: true };
+}
+
+/** Remove the wrapper and known legacy tokens, preserving the user's arguments. */
+export function removeWrapperLaunchOption(
+ options: string,
+ wrapperPath = DEFAULT_WRAPPER_PATH,
+ commandTokenAdded = false,
+): string {
+ const tokens = tokenize(options);
+ const removed = removeWrapperTokens(tokens, wrapperPath);
+ if (removed && commandTokenAdded) {
+ const index = commandIndex(tokens);
+ if (index >= 0) tokens.splice(index, 1);
+ }
+ return serialize(tokens);
+}
+
+function encodeAssignmentValue(value: string): string {
+ if (/^[A-Za-z0-9_./:+,%=-]+$/.test(value)) return value;
+ return `"${value.replace(/\\/g, "\\\\").replace(/"/g, '\\"')}"`;
+}
+
+function cleanDxvkConfigValue(value: string): string | null {
+ const retained = value
+ .split(";")
+ .map((segment) => segment.trim())
+ .filter((segment) => segment && !DXVK_FRAME_RATE_SEGMENT.test(segment));
+ return retained.length > 0 ? retained.join("; ") : null;
+}
+
+/** Remove only the old plugin's direct assignments; unrelated prefixes remain. */
+export function cleanupPluginAssignments(options: string): string {
+ const tokens = tokenize(options);
+ const index = commandIndex(tokens);
+ const prefixEnd = index >= 0 ? index : tokens.length;
+ const retained: LaunchToken[] = [];
+ for (let tokenIndex = 0; tokenIndex < tokens.length; tokenIndex += 1) {
+ const token = tokens[tokenIndex];
+ if (tokenIndex >= prefixEnd || !isAssignment(token)) {
+ retained.push(token);
+ continue;
+ }
+ const separator = token.value.indexOf("=");
+ const key = token.value.slice(0, separator);
+ if (key === "DXVK_CONFIG") {
+ const cleaned = cleanDxvkConfigValue(token.value.slice(separator + 1));
+ if (cleaned) retained.push({ raw: `DXVK_CONFIG=${encodeAssignmentValue(cleaned)}`, value: `DXVK_CONFIG=${cleaned}` });
+ continue;
+ }
+ if (!MANAGED_ENV_KEYS.has(key)) retained.push(token);
+ }
+ return serialize(retained);
+}
+
+export function cleanupLegacyLaunchOptions(options: string): string {
+ const tokens = tokenize(options);
+ removeLegacyTokens(tokens);
+ return serialize(tokens);
+}
+
+export function cleanupPluginLaunchOptions(options: string, wrapperPath = DEFAULT_WRAPPER_PATH): string {
+ const tokens = tokenize(options);
+ removeWrapperTokens(tokens, wrapperPath);
+ return cleanupPluginAssignments(serialize(tokens));
+}
+
+export function cleanupLegacyWrapper(options: string, wrapperPath = DEFAULT_WRAPPER_PATH): string {
+ return cleanupPluginLaunchOptions(options, wrapperPath);
+}
+
+export function hasWrapperLaunchIntegration(options: string, wrapperPath = DEFAULT_WRAPPER_PATH): boolean {
+ const tokens = tokenize(options);
+ const index = commandIndex(tokens);
+ return index > 0 && tokens[index - 1].value === wrapperPath;
+}
+
+function delay(milliseconds: number): Promise {
+ return new Promise((resolve) => timerHost().setTimeout(resolve, milliseconds));
+}
+
async function setSteamLaunchOptions(appId: number, nonSteam: boolean, options: string): Promise {
const apps = getSteamApps();
const setter = nonSteam ? apps?.SetShortcutLaunchOptions : apps?.SetAppLaunchOptions;
@@ -135,49 +401,96 @@ async function setSteamLaunchOptions(appId: number, nonSteam: boolean, options:
await Promise.resolve(setter.call(apps, appId, options));
}
-function delay(milliseconds: number): Promise {
- return new Promise((resolve) => window.setTimeout(resolve, milliseconds));
+async function setShortcutExecutable(appId: number, executable: string): Promise {
+ const apps = getSteamApps();
+ if (!apps?.SetShortcutExe) throw new Error("Steam shortcut Target API is unavailable");
+ await Promise.resolve(apps.SetShortcutExe.call(apps, appId, executable));
}
-async function waitForLaunchOptions(
+async function waitForSnapshot(
appId: number,
nonSteam: boolean,
- expected: string,
+ matches: (snapshot: SteamLaunchOptionsSnapshot) => boolean,
+ message: string,
): Promise {
const deadline = Date.now() + 5000;
let lastError: Error | null = null;
while (Date.now() <= deadline) {
try {
const snapshot = await readSteamLaunchOptions(appId, nonSteam);
- if (normalizeLaunchOptions(snapshot.options) === normalizeLaunchOptions(expected)) return snapshot;
+ if (matches(snapshot)) return snapshot;
} catch (error) {
lastError = asError(error);
}
if (Date.now() >= deadline) break;
await delay(100);
}
- if (lastError) throw new Error(`Steam did not accept the launch options: ${lastError.message}`);
- throw new Error("Steam did not accept the launch options before the readback timeout");
+ if (lastError) throw new Error(`${message}: ${lastError.message}`);
+ throw new Error(`${message} before the readback timeout`);
}
-const operationQueues = new Map>();
+async function writeLaunchOptionsAndVerify(
+ appId: number,
+ nonSteam: boolean,
+ previous: string,
+ next: string,
+ message: string,
+): Promise {
+ try {
+ await setSteamLaunchOptions(appId, nonSteam, next);
+ return await waitForSnapshot(
+ appId,
+ nonSteam,
+ (snapshot) => normalizeLaunchOptions(snapshot.options) === normalizeLaunchOptions(next),
+ message,
+ );
+ } catch (error) {
+ const failure = asError(error);
+ try {
+ await setSteamLaunchOptions(appId, nonSteam, previous);
+ await waitForSnapshot(
+ appId,
+ nonSteam,
+ (snapshot) => normalizeLaunchOptions(snapshot.options) === normalizeLaunchOptions(previous),
+ "Steam did not restore the previous launch options",
+ );
+ } catch (rollbackError) {
+ throw new Error(`${failure.message}; rollback also failed: ${asError(rollbackError).message}`);
+ }
+ throw failure;
+ }
+}
-function queueKey(appId: number, nonSteam: boolean): string {
- return `${nonSteam ? "shortcut" : "app"}:${appId}`;
+async function writeShortcutExecutableAndVerify(
+ appId: number,
+ previous: string,
+ next: string,
+ message: string,
+): Promise {
+ try {
+ await setShortcutExecutable(appId, next);
+ return await waitForSnapshot(appId, true, (snapshot) => snapshot.target === next, message);
+ } catch (error) {
+ const failure = asError(error);
+ try {
+ await setShortcutExecutable(appId, previous);
+ await waitForSnapshot(appId, true, (snapshot) => snapshot.target === previous, "Steam did not restore the previous shortcut Target");
+ } catch (rollbackError) {
+ throw new Error(`${failure.message}; rollback also failed: ${asError(rollbackError).message}`);
+ }
+ throw failure;
+ }
}
-function queueSteamAppOperation(appId: number, nonSteam: boolean, operation: () => Promise): Promise {
- const key = queueKey(appId, nonSteam);
+const operationQueues = new Map>();
+
+function queueSteamOperation(appId: number, nonSteam: boolean, operation: () => Promise): Promise {
+ const key = `${nonSteam ? "shortcut" : "app"}:${appId}`;
const previous = operationQueues.get(key) || Promise.resolve();
const queued = previous.catch(() => undefined).then(operation);
- let cleanup: Promise;
- cleanup = queued.then(
- () => {
- if (operationQueues.get(key) === cleanup) operationQueues.delete(key);
- },
- () => {
- if (operationQueues.get(key) === cleanup) operationQueues.delete(key);
- },
+ const cleanup = queued.then(
+ () => { if (operationQueues.get(key) === cleanup) operationQueues.delete(key); },
+ () => { if (operationQueues.get(key) === cleanup) operationQueues.delete(key); },
);
operationQueues.set(key, cleanup);
return queued;
@@ -188,37 +501,96 @@ export function updateSteamLaunchOptions(
nonSteam: boolean,
transform: (options: string) => string,
): Promise {
- return queueSteamAppOperation(appId, nonSteam, async () => {
+ return queueSteamOperation(appId, nonSteam, async () => {
const current = await readSteamLaunchOptions(appId, nonSteam);
const next = transform(current.options);
if (next === current.options) return current;
- await setSteamLaunchOptions(appId, nonSteam, next);
- return waitForLaunchOptions(appId, nonSteam, next);
+ return writeLaunchOptionsAndVerify(appId, nonSteam, current.options, next, "Steam did not accept the launch options");
});
}
-export function cleanupSteamLaunchOptions(
+export function installWrapperIntegration(
appId: number,
nonSteam: boolean,
+ wrapperPath: string,
+ commandTokenAdded = false,
+): Promise {
+ return queueSteamOperation(appId, nonSteam, async () => {
+ const current = await readSteamLaunchOptions(appId, nonSteam);
+ if (nonSteam) {
+ if (!current.target) throw new Error("Steam shortcut Target is empty; refusing to replace it");
+ if (current.target !== wrapperPath && isWrapperToken(current.target, wrapperPath)) {
+ throw new Error("The shortcut Target points to a legacy frame-generation wrapper; restore it first");
+ }
+ const cleanedOptions = cleanupPluginLaunchOptions(current.options, wrapperPath);
+ if (cleanedOptions !== current.options) {
+ await writeLaunchOptionsAndVerify(appId, true, current.options, cleanedOptions, "Steam did not accept shortcut launch options");
+ }
+ if (current.target === wrapperPath) {
+ return { snapshot: await readSteamLaunchOptions(appId, true), originalExecutable: undefined, commandTokenAdded: false };
+ }
+ const originalExecutable = current.target;
+ const snapshot = await writeShortcutExecutableAndVerify(appId, originalExecutable, wrapperPath, "Steam did not accept the shortcut Target");
+ return { snapshot, originalExecutable, commandTokenAdded: false };
+ }
+
+ const cleaned = cleanupPluginAssignments(cleanupLegacyLaunchOptions(current.options));
+ const alreadyInstalled = hasWrapperLaunchIntegration(current.options, wrapperPath);
+ const rewrite = installWrapperLaunchOption(cleaned, wrapperPath);
+ if (rewrite.options === current.options) {
+ return { snapshot: current, commandTokenAdded };
+ }
+ const snapshot = await writeLaunchOptionsAndVerify(appId, false, current.options, rewrite.options, "Steam did not accept the launch options");
+ return { snapshot, commandTokenAdded: alreadyInstalled ? commandTokenAdded : rewrite.commandTokenAdded };
+ });
+}
+
+export function removeWrapperIntegration(
+ appId: number,
+ nonSteam: boolean,
+ wrapperPath: string,
+ originalExecutable?: string,
+ commandTokenAdded = false,
): Promise {
- return queueSteamAppOperation(appId, nonSteam, async () => {
+ return queueSteamOperation(appId, nonSteam, async () => {
const current = await readSteamLaunchOptions(appId, nonSteam);
- const next = cleanupPluginLaunchOptions(current.options);
+ if (nonSteam) {
+ if (!originalExecutable || isWrapperToken(originalExecutable, wrapperPath)) {
+ throw new Error("Original shortcut Target is unavailable; refusing to overwrite the current Target");
+ }
+ if (current.target !== wrapperPath && current.target !== originalExecutable) {
+ throw new Error("Shortcut Target changed externally; refusing to restore it");
+ }
+ const cleaned = cleanupPluginLaunchOptions(current.options, wrapperPath);
+ if (cleaned !== current.options) {
+ await writeLaunchOptionsAndVerify(appId, true, current.options, cleaned, "Steam did not clean shortcut launch options");
+ }
+ if (current.target === originalExecutable) {
+ return readSteamLaunchOptions(appId, true);
+ }
+ return writeShortcutExecutableAndVerify(appId, wrapperPath, originalExecutable, "Steam did not restore the shortcut Target");
+ }
+
+ const withoutWrapper = removeWrapperLaunchOption(current.options, wrapperPath, commandTokenAdded);
+ const next = cleanupPluginAssignments(withoutWrapper);
if (next === current.options) return current;
- await setSteamLaunchOptions(appId, nonSteam, next);
- return waitForLaunchOptions(appId, nonSteam, next);
+ return writeLaunchOptionsAndVerify(appId, false, current.options, next, "Steam did not clean the launch options");
});
}
export function cleanupLegacySteamLaunchOptions(
appId: number,
nonSteam: boolean,
+ wrapperPath = DEFAULT_WRAPPER_PATH,
): Promise {
- return queueSteamAppOperation(appId, nonSteam, async () => {
+ return queueSteamOperation(appId, nonSteam, async () => {
const current = await readSteamLaunchOptions(appId, nonSteam);
- const next = cleanupLegacyLaunchOptions(current.options);
+ const next = cleanupPluginLaunchOptions(current.options, wrapperPath);
if (next === current.options) return current;
- await setSteamLaunchOptions(appId, nonSteam, next);
- return waitForLaunchOptions(appId, nonSteam, next);
+ return writeLaunchOptionsAndVerify(appId, nonSteam, current.options, next, "Steam did not clean legacy launch options");
});
}
+
+export function getDefaultWrapperPath(): string {
+ return DEFAULT_WRAPPER_PATH;
+}
diff --git a/tests/steamLaunchOptions.test.ts b/tests/steamLaunchOptions.test.ts
index c4dede3..3170fe8 100644
--- a/tests/steamLaunchOptions.test.ts
+++ b/tests/steamLaunchOptions.test.ts
@@ -1,342 +1,138 @@
import assert from "node:assert/strict";
import test from "node:test";
import {
- applyWorkaroundChange,
- applyWorkaroundState,
- cleanupLegacyLaunchOptions,
+ cleanupPluginAssignments,
cleanupPluginLaunchOptions,
cleanupLegacyWrapper,
- getDefaultWorkaroundState,
+ hasWrapperLaunchIntegration,
+ installWrapperIntegration,
+ installWrapperLaunchOption,
isLegacyWrapperToken,
normalizeLaunchOptions,
- parseWorkaroundOptions,
readSteamLaunchOptions,
- updateSteamLaunchOptions,
+ removeWrapperIntegration,
+ removeWrapperLaunchOption,
} from "../src/utils/steamLaunchOptions.ts";
-test("maps the supported workarounds to current launch variables", () => {
- const options = applyWorkaroundState('gamemoderun %command% --profile "high quality"', {
- dxvkFrameRate: 30,
- disableGamescopeWsi: true,
- disableHdr: true,
- disableSteamdeckMode: true,
- disableVkbasalt: true,
- enableZink: true,
- });
+const wrapper = "~/.lsfg";
- assert.equal(
- options,
- 'ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 SteamDeck=0 DISABLE_VKBASALT=1 MESA_LOADER_DRIVER_OVERRIDE=zink DXVK_CONFIG="dxvk.maxFrameRate = 30" gamemoderun %command% --profile "high quality"',
- );
- assert.deepEqual(parseWorkaroundOptions(options), {
- state: {
- dxvkFrameRate: 30,
- disableGamescopeWsi: true,
- disableHdr: true,
- disableSteamdeckMode: true,
- disableVkbasalt: true,
- enableZink: true,
- },
- issues: [],
+test("inserts one wrapper immediately before an existing command macro", () => {
+ assert.deepEqual(installWrapperLaunchOption('gamemoderun %command% --profile "high quality"', wrapper), {
+ options: 'gamemoderun ~/.lsfg %command% --profile "high quality"',
+ commandTokenAdded: false,
+ });
+ assert.equal(hasWrapperLaunchIntegration(`gamemoderun ${wrapper} %command%`, wrapper), true);
+ assert.deepEqual(installWrapperLaunchOption(`gamemoderun ${wrapper} %command%`, wrapper), {
+ options: `gamemoderun ${wrapper} %command%`,
+ commandTokenAdded: false,
});
});
-test("uses SteamDeck=0 before %command% without a wrapper", () => {
- assert.equal(
- applyWorkaroundChange("", "disableSteamdeckMode", true),
- "SteamDeck=0 %command%",
- );
-});
-
-test("defaults new profiles to disable Gamescope WSI and HDR", () => {
- const defaults = getDefaultWorkaroundState();
- assert.equal(defaults.disableGamescopeWsi, true);
- assert.equal(defaults.disableHdr, true);
- assert.equal(
- applyWorkaroundState("%command%", defaults),
- "ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 %command%",
- );
- assert.equal(parseWorkaroundOptions("%command%").state.disableGamescopeWsi, false);
- assert.equal(parseWorkaroundOptions("%command%").state.disableHdr, false);
- assert.equal(
- parseWorkaroundOptions(applyWorkaroundState("%command%", defaults)).state.disableGamescopeWsi,
- true,
- );
- assert.equal(
- parseWorkaroundOptions(applyWorkaroundState("%command%", defaults)).state.disableHdr,
- true,
- );
- assert.equal(
- applyWorkaroundChange("%command%", "disableGamescopeWsi", true),
- "ENABLE_GAMESCOPE_WSI=0 %command%",
- );
- assert.equal(
- applyWorkaroundChange("ENABLE_GAMESCOPE_WSI=0 %command%", "disableGamescopeWsi", false),
- "",
- );
-
- const invalid = parseWorkaroundOptions("ENABLE_GAMESCOPE_WSI=maybe %command%");
- assert.equal(invalid.state.disableGamescopeWsi, false);
- assert.equal(invalid.issues.length, 1);
- const conflicting = parseWorkaroundOptions("DISABLE_GAMESCOPE_WSI=1 ENABLE_GAMESCOPE_WSI=1 %command%");
- assert.equal(conflicting.state.disableGamescopeWsi, true);
- assert.match(conflicting.issues.join(" "), /conflicting/);
-});
-
-test("manages DXVK HDR independently from Gamescope WSI", () => {
- assert.equal(
- applyWorkaroundChange("%command%", "disableHdr", true),
- "DXVK_HDR=0 %command%",
- );
- assert.equal(parseWorkaroundOptions("DXVK_HDR=0 %command%").state.disableHdr, true);
- assert.equal(parseWorkaroundOptions("DXVK_HDR=1 %command%").state.disableHdr, false);
- assert.equal(
- applyWorkaroundChange("DXVK_HDR=0 %command%", "disableHdr", false),
- "",
- );
- assert.equal(
- applyWorkaroundChange("DXVK_HDR=0 %command%", "disableGamescopeWsi", true),
- "ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 %command%",
- );
-
- const invalid = parseWorkaroundOptions("DXVK_HDR=maybe %command%");
- assert.equal(invalid.state.disableHdr, false);
- assert.match(invalid.issues.join(" "), /Disable HDR has an unsupported value/);
-});
-
-test("preserves unrelated prefixes, quoted tokens, suffix arguments, and dropped variables", () => {
- const options = applyWorkaroundChange(
- 'PROTON_USE_WOW64=1 MANGOHUD=1 MANGOHUD_CONFIG="alpha=0.01" ENABLE_VKBASALT=1 VK_INSTANCE_LAYERS="one:two" FOO="hello world" gamemoderun %command% --flag "two words"',
- "disableSteamdeckMode",
- true,
- );
- assert.equal(
- options,
- 'SteamDeck=0 PROTON_USE_WOW64=1 MANGOHUD=1 MANGOHUD_CONFIG="alpha=0.01" ENABLE_VKBASALT=1 VK_INSTANCE_LAYERS="one:two" FOO="hello world" gamemoderun %command% --flag "two words"',
- );
- assert.deepEqual(parseWorkaroundOptions(options).issues, []);
-
- assert.equal(
- applyWorkaroundChange("FOO=bar --flag", "disableSteamdeckMode", true),
- "SteamDeck=0 FOO=bar %command% --flag",
- );
- assert.equal(
- applyWorkaroundChange("FOO=1 %command% MANGOHUD=1", "disableSteamdeckMode", false),
- "FOO=1 %command% MANGOHUD=1",
- );
- assert.equal(
- applyWorkaroundChange('FOO=bar --literal "%command%"', "disableSteamdeckMode", true),
- 'SteamDeck=0 FOO=bar %command% --literal "%command%"',
- );
- assert.equal(
- applyWorkaroundChange("gamemoderun SteamDeck=1 %command%", "disableSteamdeckMode", true),
- "SteamDeck=0 gamemoderun SteamDeck=1 %command%",
- );
- assert.equal(parseWorkaroundOptions("gamemoderun SteamDeck=0 %command%").state.disableSteamdeckMode, false);
-});
-
-test("uses DXVK_CONFIG for the base cap and preserves other DXVK settings", () => {
- assert.equal(
- applyWorkaroundChange("%command%", "dxvkFrameRate", 60),
- 'DXVK_CONFIG="dxvk.maxFrameRate = 60" %command%',
- );
- assert.equal(parseWorkaroundOptions('DXVK_CONFIG="dxvk.maxFrameRate = 60" %command%').state.dxvkFrameRate, 60);
- assert.equal(
- applyWorkaroundChange(
- 'DXVK_CONFIG="dxgi.syncInterval = 0; dxvk.maxFrameRate = 30" %command%',
- "dxvkFrameRate",
- 0,
- ),
- 'DXVK_CONFIG="dxgi.syncInterval = 0" %command%',
- );
- assert.equal(
- applyWorkaroundChange("DXVK_FRAME_RATE=30 %command%", "dxvkFrameRate", 45),
- 'DXVK_CONFIG="dxvk.maxFrameRate = 45" %command%',
- );
- assert.equal(
- applyWorkaroundChange("DXVK_FRAME_RATE=30 %command%", "dxvkFrameRate", 0),
- "",
- );
-
- const apiSpecific = parseWorkaroundOptions(
- 'DXVK_CONFIG="dxgi.maxFrameRate = 30; d3d9.maxFrameRate = 30" %command%',
- );
- assert.equal(apiSpecific.state.dxvkFrameRate, 30);
- assert.deepEqual(apiSpecific.issues, []);
- const partial = parseWorkaroundOptions('DXVK_CONFIG="dxgi.maxFrameRate = 30" %command%');
- assert.equal(partial.state.dxvkFrameRate, 30);
- assert.match(partial.issues.join(" "), /only caps one DirectX API/);
- const conflicting = parseWorkaroundOptions(
- 'DXVK_CONFIG="dxgi.maxFrameRate = 30; d3d9.maxFrameRate = 60" %command%',
- );
- assert.equal(conflicting.state.dxvkFrameRate, 0);
- assert.match(conflicting.issues.join(" "), /conflicting/);
-});
-
-test("reports invalid and malformed FPS values instead of treating them as off", () => {
- const invalid = parseWorkaroundOptions('DXVK_CONFIG="dxvk.maxFrameRate = 61" %command%');
- assert.equal(invalid.state.dxvkFrameRate, 0);
- assert.match(invalid.issues.join(" "), /outside the supported 0-60 range/);
- const malformed = parseWorkaroundOptions('DXVK_CONFIG="dxvk.maxFrameRate" %command%');
- assert.equal(malformed.state.dxvkFrameRate, 0);
- assert.match(malformed.issues.join(" "), /malformed/);
- const obsolete = parseWorkaroundOptions("DXVK_FRAME_RATE=wat %command%");
- assert.equal(obsolete.state.dxvkFrameRate, 0);
- assert.match(obsolete.issues.join(" "), /obsolete/);
- assert.throws(() => applyWorkaroundChange("%command%", "dxvkFrameRate", 61), /0 to 60/);
- assert.throws(() => applyWorkaroundChange("%command%", "dxvkFrameRate", 1.5), /0 to 60/);
-});
-
-test("keeps vkBasalt disable mutually exclusive while preserving the dropped enable flag otherwise", () => {
- assert.equal(
- applyWorkaroundChange("ENABLE_VKBASALT=1 %command%", "disableSteamdeckMode", true),
- "SteamDeck=0 ENABLE_VKBASALT=1 %command%",
- );
- const disabled = applyWorkaroundChange("ENABLE_VKBASALT=1 %command%", "disableVkbasalt", true);
- assert.equal(disabled, "DISABLE_VKBASALT=1 %command%");
- assert.equal(
- applyWorkaroundChange(disabled, "disableVkbasalt", false),
- "",
- );
- const conflict = parseWorkaroundOptions("ENABLE_VKBASALT=1 DISABLE_VKBASALT=1 %command%");
- assert.equal(conflict.state.disableVkbasalt, true);
- assert.match(conflict.issues.join(" "), /conflicting/);
+test("normalizes blank and argument-only fields while refusing ambiguous launchers", () => {
+ assert.deepEqual(installWrapperLaunchOption("", wrapper), {
+ options: `${wrapper} %command%`,
+ commandTokenAdded: true,
+ });
+ assert.deepEqual(installWrapperLaunchOption("FOO=bar --windowed", wrapper), {
+ options: `FOO=bar ${wrapper} %command% --windowed`,
+ commandTokenAdded: true,
+ });
+ assert.throws(() => installWrapperLaunchOption("gamemoderun --windowed", wrapper), /refusing to guess/);
+ assert.throws(() => installWrapperLaunchOption('"%command%"', wrapper), /refusing to guess/);
});
-test("handles current and legacy Zink forms and reports partial state", () => {
- const enabled = applyWorkaroundChange("%command%", "enableZink", true);
- assert.equal(enabled, "MESA_LOADER_DRIVER_OVERRIDE=zink %command%");
- assert.equal(parseWorkaroundOptions(enabled).state.enableZink, true);
-
- const legacy = parseWorkaroundOptions(
- "__GLX_VENDOR_LIBRARY_NAME=mesa MESA_LOADER_DRIVER_OVERRIDE=zink GALLIUM_DRIVER=zink %command%",
- );
- assert.equal(legacy.state.enableZink, true);
- assert.deepEqual(legacy.issues, []);
-
- const partial = parseWorkaroundOptions("__GLX_VENDOR_LIBRARY_NAME=mesa MESA_LOADER_DRIVER_OVERRIDE=zink %command%");
- assert.equal(partial.state.enableZink, true);
- assert.match(partial.issues.join(" "), /partially configured/);
+test("preserves assignments, quoting, suffixes, and unrelated values", () => {
+ const options = 'FOO="hello world" VK_INSTANCE_LAYERS="one:two" gamemoderun %command% --flag "two words"';
assert.equal(
- applyWorkaroundChange(
- "__GLX_VENDOR_LIBRARY_NAME=mesa MESA_LOADER_DRIVER_OVERRIDE=zink GALLIUM_DRIVER=zink %command%",
- "enableZink",
- false,
- ),
- "",
+ installWrapperLaunchOption(options, wrapper).options,
+ 'FOO="hello world" VK_INSTANCE_LAYERS="one:two" gamemoderun ~/.lsfg %command% --flag "two words"',
);
+ assert.equal(removeWrapperLaunchOption(`${wrapper} %command% --arg "${wrapper}"`, wrapper, true), `--arg "${wrapper}"`);
+ assert.equal(normalizeLaunchOptions(" FOO=bar %COMMAND% --flag "), "FOO=bar %COMMAND% --flag");
});
-test("cleans only the known legacy wrapper and preserves launch options", () => {
- assert.equal(
- cleanupLegacyWrapper('FOO=bar ~/lsfg %command% --arg "~/lsfg"'),
- 'FOO=bar %command% --arg "~/lsfg"',
- );
- assert.equal(cleanupLegacyWrapper("/home/deck/lsfg %command%"), "");
- assert.equal(cleanupLegacyWrapper("mako-run %command%"), "");
- assert.equal(cleanupLegacyWrapper("mako-launch %command%"), "");
- assert.equal(
- cleanupLegacyWrapper("DXVK_FRAME_RATE=30 LSFG_PROCESS=decky-lsfg-vk %command%"),
- "DXVK_FRAME_RATE=30 LSFG_PROCESS=decky-lsfg-vk %command%",
- );
- assert.equal(
- cleanupLegacyWrapper("LSFG_PROCESS=decky-lsfg-vk %command%"),
- "LSFG_PROCESS=decky-lsfg-vk %command%",
- );
- assert.equal(isLegacyWrapperToken("/home/kurt/lsfg"), false);
+test("cleans current, legacy, and bare Mako wrappers without touching suffix arguments", () => {
+ for (const token of ["~/lsfg", "/home/deck/lsfg", "mako-run", "mako-launch"]) {
+ assert.equal(cleanupLegacyWrapper(`FOO=bar ${token} %command% --arg "${token}"`), `FOO=bar %command% --arg "${token}"`);
+ }
+ assert.equal(cleanupLegacyWrapper(`FOO=bar ${wrapper} %command%`), "FOO=bar %command%");
+ assert.equal(isLegacyWrapperToken("/home/kurt/lsfg"), true);
+ assert.equal(isLegacyWrapperToken("/opt/tools/lsfg"), false);
+ assert.equal(removeWrapperLaunchOption(`FOO=bar ${wrapper} %command% --arg`, wrapper), "FOO=bar %command% --arg");
});
-test("removes plugin-managed launch options when a profile is removed", () => {
+test("removes only old plugin assignments and preserves DXVK settings", () => {
assert.equal(
- cleanupPluginLaunchOptions(
- 'FOO="keep this" ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 SteamDeck=0 DISABLE_VKBASALT=1 MESA_LOADER_DRIVER_OVERRIDE=zink DXVK_CONFIG="dxgi.syncInterval = 0; dxvk.maxFrameRate = 30" ~/lsfg %command% --windowed',
+ cleanupPluginAssignments(
+ 'FOO="keep this" ENABLE_GAMESCOPE_WSI=0 DXVK_HDR=0 SteamDeck=0 DISABLE_VKBASALT=1 MESA_LOADER_DRIVER_OVERRIDE=zink DXVK_CONFIG="dxgi.syncInterval = 0; dxvk.maxFrameRate = 30" %command%',
),
- 'DXVK_CONFIG="dxgi.syncInterval = 0" FOO="keep this" %command% --windowed',
+ 'FOO="keep this" DXVK_CONFIG="dxgi.syncInterval = 0" %command%',
);
assert.equal(
- cleanupPluginLaunchOptions(
- 'PROTON_USE_WOW64=1 MANGOHUD=1 MANGOHUD_CONFIG="alpha=0.01" LSFG_PROCESS=decky-lsfg-vk %command%',
- ),
- 'PROTON_USE_WOW64=1 MANGOHUD=1 MANGOHUD_CONFIG="alpha=0.01" LSFG_PROCESS=decky-lsfg-vk %command%',
+ cleanupPluginLaunchOptions(`DXVK_FRAME_RATE=30 ${wrapper} %command%`, wrapper),
+ "%command%",
);
assert.equal(
- cleanupPluginLaunchOptions('DXVK_CONFIG="dxvk.maxFrameRate = 30" %command%'),
- "",
+ cleanupPluginAssignments("PROTON_USE_WOW64=1 MANGOHUD=1 MANGOHUD_CONFIG=alpha %command%"),
+ "PROTON_USE_WOW64=1 MANGOHUD=1 MANGOHUD_CONFIG=alpha %command%",
);
});
-test("canonicalizes a bare command token without removing real arguments", () => {
- assert.equal(normalizeLaunchOptions("%command%"), "");
- assert.equal(normalizeLaunchOptions("%COMMAND%"), "");
- assert.equal(normalizeLaunchOptions("FOO=bar %command%"), "FOO=bar %command%");
- assert.equal(normalizeLaunchOptions("%command% --windowed"), "%command% --windowed");
-});
-
-test("is idempotent", () => {
- const first = applyWorkaroundChange("gamemoderun %command%", "enableZink", true);
- assert.equal(applyWorkaroundState(first, parseWorkaroundOptions(first).state), first);
- assert.equal(applyWorkaroundChange(first, "enableZink", true), first);
- const capped = applyWorkaroundChange(first, "dxvkFrameRate", 30);
- assert.equal(applyWorkaroundChange(capped, "dxvkFrameRate", 30), capped);
-});
-
-test("reads and writes the matching Steam app-details launch-option field", async () => {
+test("reads the matching app-details field and installs/removes Steam integration", async () => {
const previousWindow = (globalThis as Record).window;
const previousSteamClient = (globalThis as Record).SteamClient;
- let normalOptions = "FOO=bar %command%";
+ let appOptions = "FOO=bar %command%";
let shortcutOptions = "--windowed";
- const normalWrites: string[] = [];
+ let shortcutTarget = "/usr/bin/example-game";
+ const appWrites: string[] = [];
const shortcutWrites: string[] = [];
+ const targetWrites: string[] = [];
const unregisters: number[] = [];
-
- const windowShim = { setTimeout, clearTimeout };
const apps = {
RegisterForAppDetails(appId: number, callback: (details: SteamAppDetails) => void) {
- if (appId === 42) {
- callback({ strLaunchOptions: normalOptions, strShortcutLaunchOptions: "must-not-be-read" });
- } else {
- callback({
- strShortcutExe: "/usr/bin/example-game",
- strShortcutLaunchOptions: shortcutOptions,
- strLaunchOptions: "must-not-be-read",
- });
- }
+ callback(appId === 42
+ ? { strLaunchOptions: appOptions, strShortcutLaunchOptions: "wrong-field" }
+ : { strShortcutExe: shortcutTarget, strShortcutLaunchOptions: shortcutOptions, strLaunchOptions: "wrong-field" });
return { unregister: () => unregisters.push(appId) };
},
SetAppLaunchOptions(appId: number, options: string) {
assert.equal(appId, 42);
- normalWrites.push(options);
- normalOptions = options.replaceAll(" ", " ");
+ appWrites.push(options);
+ appOptions = options.replaceAll(" ", " ");
},
SetShortcutLaunchOptions(appId: number, options: string) {
assert.equal(appId, 43);
shortcutWrites.push(options);
shortcutOptions = options;
},
+ SetShortcutExe(appId: number, executable: string) {
+ assert.equal(appId, 43);
+ targetWrites.push(executable);
+ shortcutTarget = executable;
+ },
};
-
- (globalThis as Record).window = windowShim;
+ (globalThis as Record).window = { setTimeout, clearTimeout };
(globalThis as Record).SteamClient = { Apps: apps };
try {
- const normalBefore = await readSteamLaunchOptions(42, false);
- assert.equal(normalBefore.options, "FOO=bar %command%");
- const normalAfter = await updateSteamLaunchOptions(
- 42,
- false,
- (options) => applyWorkaroundChange(options, "disableSteamdeckMode", true),
- );
- assert.equal(normalWrites.length, 1);
+ const normal = await readSteamLaunchOptions(42, false);
+ assert.equal(normal.options, "FOO=bar %command%");
+ const installed = await installWrapperIntegration(42, false, wrapper);
+ assert.equal(installed.snapshot.options, `FOO=bar ${wrapper} %command%`.replaceAll(" ", " "));
+ assert.equal(installed.commandTokenAdded, false);
+ assert.equal(appWrites.length, 1);
assert.equal(shortcutWrites.length, 0);
- assert.equal(normalAfter.options, "SteamDeck=0 FOO=bar %command%");
- const shortcutAfter = await updateSteamLaunchOptions(
- 43,
- true,
- (options) => applyWorkaroundChange(options, "disableGamescopeWsi", true),
- );
- assert.equal(shortcutWrites.length, 1);
- assert.equal(shortcutWrites[0], "ENABLE_GAMESCOPE_WSI=0 %command% --windowed");
- assert.equal(shortcutAfter.options, shortcutWrites[0]);
+ const shortcut = await installWrapperIntegration(43, true, wrapper);
+ assert.equal(shortcut.originalExecutable, "/usr/bin/example-game");
+ assert.equal(shortcut.snapshot.target, wrapper);
+ assert.deepEqual(targetWrites, [wrapper]);
+ const restored = await removeWrapperIntegration(43, true, wrapper, shortcut.originalExecutable);
+ assert.equal(restored.target, "/usr/bin/example-game");
+ assert.deepEqual(targetWrites, [wrapper, "/usr/bin/example-game"]);
+ assert.equal(shortcutWrites.length, 0);
+
+ const cleaned = await removeWrapperIntegration(42, false, wrapper, undefined, installed.commandTokenAdded);
+ assert.equal(cleaned.options, "FOO=bar %command%".replaceAll(" ", " "));
assert.ok(unregisters.includes(42));
assert.ok(unregisters.includes(43));
} finally {
@@ -346,3 +142,69 @@ test("reads and writes the matching Steam app-details launch-option field", asyn
else (globalThis as Record).SteamClient = previousSteamClient;
}
});
+
+test("fails closed when shortcut Target ownership or setters are unavailable", async () => {
+ const previousWindow = (globalThis as Record).window;
+ const previousSteamClient = (globalThis as Record).SteamClient;
+ (globalThis as Record).window = { setTimeout, clearTimeout };
+ (globalThis as Record).SteamClient = {
+ Apps: {
+ RegisterForAppDetails(_appId: number, callback: (details: SteamAppDetails) => void) {
+ callback({ strShortcutExe: "/usr/bin/other", strShortcutLaunchOptions: "" });
+ return { unregister() {} };
+ },
+ },
+ };
+ try {
+ await assert.rejects(installWrapperIntegration(99, true, wrapper), /Target API is unavailable/);
+ await assert.rejects(removeWrapperIntegration(99, true, wrapper, "/usr/bin/original"), /Target changed externally/);
+ } finally {
+ if (previousWindow === undefined) delete (globalThis as Record).window;
+ else (globalThis as Record).window = previousWindow;
+ if (previousSteamClient === undefined) delete (globalThis as Record).SteamClient;
+ else (globalThis as Record).SteamClient = previousSteamClient;
+ }
+});
+
+test("restores launch options and shortcut Target when a setter fails after changing them", async () => {
+ const previousWindow = (globalThis as Record).window;
+ const previousSteamClient = (globalThis as Record).SteamClient;
+ let appOptions = "FOO=bar %command%";
+ let shortcutTarget = "/usr/bin/original";
+ const appWrites: string[] = [];
+ const targetWrites: string[] = [];
+ const apps = {
+ RegisterForAppDetails(appId: number, callback: (details: SteamAppDetails) => void) {
+ callback(appId === 42
+ ? { strLaunchOptions: appOptions }
+ : { strShortcutExe: shortcutTarget, strShortcutLaunchOptions: "" });
+ return { unregister() {} };
+ },
+ SetAppLaunchOptions(_appId: number, options: string) {
+ appWrites.push(options);
+ appOptions = options;
+ if (options.includes(wrapper)) throw new Error("simulated launch-option write failure");
+ },
+ SetShortcutExe(_appId: number, executable: string) {
+ targetWrites.push(executable);
+ shortcutTarget = executable;
+ if (executable === wrapper) throw new Error("simulated Target write failure");
+ },
+ };
+ (globalThis as Record).window = { setTimeout, clearTimeout };
+ (globalThis as Record).SteamClient = { Apps: apps };
+ try {
+ await assert.rejects(installWrapperIntegration(42, false, wrapper), /simulated launch-option write failure/);
+ assert.equal(appOptions, "FOO=bar %command%");
+ assert.deepEqual(appWrites, [`FOO=bar ${wrapper} %command%`, "FOO=bar %command%"]);
+
+ await assert.rejects(installWrapperIntegration(43, true, wrapper), /simulated Target write failure/);
+ assert.equal(shortcutTarget, "/usr/bin/original");
+ assert.deepEqual(targetWrites, [wrapper, "/usr/bin/original"]);
+ } finally {
+ if (previousWindow === undefined) delete (globalThis as Record).window;
+ else (globalThis as Record).window = previousWindow;
+ if (previousSteamClient === undefined) delete (globalThis as Record).SteamClient;
+ else (globalThis as Record).SteamClient = previousSteamClient;
+ }
+});
diff --git a/tests/test_wrapper_service.py b/tests/test_wrapper_service.py
new file mode 100644
index 0000000..f17a944
--- /dev/null
+++ b/tests/test_wrapper_service.py
@@ -0,0 +1,170 @@
+import os
+import subprocess
+import sys
+import tempfile
+import types
+import unittest
+from pathlib import Path
+from unittest.mock import Mock
+
+
+sys.modules.setdefault(
+ "decky",
+ types.SimpleNamespace(DECKY_USER_HOME="/home/deck", logger=Mock()),
+)
+sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "py_modules"))
+
+from lsfg_vk.wrapper_service import WrapperService
+
+
+class WrapperServiceTests(unittest.TestCase):
+ def setUp(self):
+ self.tempdir = tempfile.TemporaryDirectory()
+ self.home = Path(self.tempdir.name) / "home" / "deck"
+ self.home.mkdir(parents=True)
+ self.service = WrapperService()
+ self.service.user_home = self.home
+ self.service.local_bin_dir = self.home / ".local/bin"
+ self.service.config_dir = self.home / ".config/lsfg-vk"
+ self.service.sidecar_path = self.service.config_dir / "workarounds.json"
+ self.service.wrapper_path = self.service.local_bin_dir / "lsfg"
+
+ def tearDown(self):
+ self.tempdir.cleanup()
+
+ def _state(self, **changes):
+ state = self.service.default_state()
+ state.update(changes)
+ return state
+
+ def _run(self, appid, *args, env=None):
+ process_env = {"PATH": "/usr/bin:/bin", "SteamAppId": str(appid)}
+ if env:
+ process_env.update(env)
+ return subprocess.run(
+ [str(self.service.wrapper_path), *args],
+ env=process_env,
+ capture_output=True,
+ text=True,
+ check=True,
+ )
+
+ def test_writes_owned_dispatcher_and_validates_shell(self):
+ response = self.service.set("123", self._state(dxvkFrameRate=60, enableZink=True))
+ self.assertTrue(response["success"])
+ self.assertEqual(response["wrapper_path"], "~/.lsfg")
+ self.assertTrue(response["wrapper_owned"])
+ self.assertEqual(response["state"]["dxvkFrameRate"], 60)
+ self.assertEqual(subprocess.run(["/bin/sh", "-n", str(self.service.wrapper_path)]).returncode, 0)
+ self.assertIn(self.service.MARKER, self.service.wrapper_path.read_text(encoding="utf-8"))
+ self.assertEqual(self.service.get("123")["state"], self._state(dxvkFrameRate=60, enableZink=True))
+
+ def test_dispatch_clears_managed_values_preserves_other_environment_and_appends_config(self):
+ self.service.set(
+ "123",
+ self._state(dxvkFrameRate=30, disableSteamdeckMode=True, disableVkbasalt=True, enableZink=True),
+ )
+ result = self._run(
+ 123,
+ "/usr/bin/env",
+ env={
+ "DXVK_CONFIG": "dxgi.syncInterval = 0",
+ "DXVK_FRAME_RATE": "5",
+ "ENABLE_GAMESCOPE_WSI": "1",
+ "DISABLE_VKBASALT": "0",
+ "MESA_LOADER_DRIVER_OVERRIDE": "llvmpipe",
+ "MANGOHUD": "1",
+ },
+ )
+ values = dict(line.split("=", 1) for line in result.stdout.splitlines() if "=" in line)
+ self.assertEqual(values["ENABLE_GAMESCOPE_WSI"], "0")
+ self.assertEqual(values["DXVK_HDR"], "0")
+ self.assertEqual(values["SteamDeck"], "0")
+ self.assertEqual(values["DISABLE_VKBASALT"], "1")
+ self.assertEqual(values["__GLX_VENDOR_LIBRARY_NAME"], "mesa")
+ self.assertEqual(values["MESA_LOADER_DRIVER_OVERRIDE"], "zink")
+ self.assertEqual(values["GALLIUM_DRIVER"], "zink")
+ self.assertEqual(values["DXVK_CONFIG"], "dxgi.syncInterval = 0; dxvk.maxFrameRate = 30")
+ self.assertEqual(values["MANGOHUD"], "1")
+ self.assertNotIn("DXVK_FRAME_RATE", values)
+ self.assertNotIn("ENABLE_VKBASALT", values)
+
+ def test_appid_fallback_and_unmatched_passthrough(self):
+ self.service.set("123", self._state(disableGamescopeWsi=False, disableHdr=False))
+ self.service.set("456", self._state(disableSteamdeckMode=True))
+ fallback = subprocess.run(
+ [str(self.service.wrapper_path), "/usr/bin/env"],
+ env={"PATH": "/usr/bin:/bin", "SteamAppId": "bad", "SteamGameId": "456"},
+ capture_output=True,
+ text=True,
+ check=True,
+ )
+ fallback_values = dict(line.split("=", 1) for line in fallback.stdout.splitlines() if "=" in line)
+ self.assertEqual(fallback_values["SteamDeck"], "0")
+ self.assertEqual(fallback_values["SteamGameId"], "456")
+
+ passthrough = subprocess.run(
+ [str(self.service.wrapper_path), "/usr/bin/env"],
+ env={"PATH": "/usr/bin:/bin", "SteamAppId": "999", "KEEP": "yes", "DXVK_HDR": "1"},
+ capture_output=True,
+ text=True,
+ check=True,
+ )
+ passthrough_values = dict(line.split("=", 1) for line in passthrough.stdout.splitlines() if "=" in line)
+ self.assertEqual(passthrough_values["KEEP"], "yes")
+ self.assertEqual(passthrough_values["DXVK_HDR"], "1")
+
+ def test_flatpak_shortcut_receives_env_arguments_and_original_target(self):
+ fake_flatpak = self.home / ".local/bin/flatpak"
+ fake_flatpak.parent.mkdir(parents=True, exist_ok=True)
+ fake_flatpak.write_text(
+ "#!/bin/sh\n"
+ "printf 'ARG:%s\\n' \"$@\"\n",
+ encoding="utf-8",
+ )
+ fake_flatpak.chmod(0o755)
+ self.service.set("123", self._state(dxvkFrameRate=20, enableZink=True), str(fake_flatpak))
+ result = self._run(123, "run", "com.example.Game", "--windowed", env={"DXVK_CONFIG": "foo=1"})
+ args = result.stdout.splitlines()
+ self.assertEqual(args[0], "ARG:run")
+ self.assertIn("ARG:--env=SteamAppId=123", args)
+ self.assertIn("ARG:--env=ENABLE_GAMESCOPE_WSI=0", args)
+ self.assertIn("ARG:--env=DXVK_HDR=0", args)
+ self.assertIn("ARG:--env=__GLX_VENDOR_LIBRARY_NAME=mesa", args)
+ self.assertIn("ARG:--env=MESA_LOADER_DRIVER_OVERRIDE=zink", args)
+ self.assertIn("ARG:--env=GALLIUM_DRIVER=zink", args)
+ self.assertIn("ARG:--env=DXVK_CONFIG=foo=1; dxvk.maxFrameRate = 20", args)
+ self.assertIn("ARG:com.example.Game", args)
+ self.assertIn("ARG:--windowed", args)
+
+ def test_invalid_state_and_foreign_wrapper_fail_closed(self):
+ invalid = self.service.set("0", self.service.default_state())
+ self.assertFalse(invalid["success"])
+ invalid = self.service.set("123", {**self.service.default_state(), "dxvkFrameRate": 61})
+ self.assertFalse(invalid["success"])
+
+ self.service.local_bin_dir.mkdir(parents=True, exist_ok=True)
+ self.service.wrapper_path.write_text("#!/bin/sh\necho foreign\n", encoding="utf-8")
+ response = self.service.set("123", self.service.default_state())
+ self.assertFalse(response["success"])
+ self.assertIn("unowned", response["error"])
+ self.assertEqual(self.service.wrapper_path.read_text(encoding="utf-8"), "#!/bin/sh\necho foreign\n")
+
+ def test_remove_keeps_a_safe_owned_passthrough_wrapper(self):
+ self.service.set("123", self.service.default_state())
+ response = self.service.remove("123")
+ self.assertTrue(response["success"])
+ self.assertIsNone(self.service.get("123")["state"])
+ self.assertTrue(self.service.wrapper_path.exists())
+ result = subprocess.run(
+ [str(self.service.wrapper_path), "/usr/bin/printf", "ok"],
+ env={"PATH": "/usr/bin:/bin", "SteamAppId": "123"},
+ capture_output=True,
+ text=True,
+ check=True,
+ )
+ self.assertEqual(result.stdout, "ok")
+
+
+if __name__ == "__main__":
+ unittest.main()
--
cgit v1.2.3
From 102a4a0f0ce4af303a12e7f6f1a4454f4e572a17 Mon Sep 17 00:00:00 2001
From: xXJSONDeruloXx
Date: Wed, 9 Sep 2026 09:51:21 -0400
Subject: move all games
---
src/components/GameConfigurationSelector.tsx | 14 +++++++-------
1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/src/components/GameConfigurationSelector.tsx b/src/components/GameConfigurationSelector.tsx
index 50b2cf8..df0c3e9 100644
--- a/src/components/GameConfigurationSelector.tsx
+++ b/src/components/GameConfigurationSelector.tsx
@@ -174,13 +174,6 @@ export function GameConfigurationSelector({
)}
- {availableGames.length > 0 && (
-
-
- Enable all available games
-
-
- )}
+
+ Enable all available games
+
+
+ )}
Date: Wed, 9 Sep 2026 19:16:30 -0400
Subject: refactor: unify flatpak targets with steam profiles
---
py_modules/lsfg_vk/flatpak_service.py | 724 ++++++++++++++++-----------
py_modules/lsfg_vk/plugin.py | 109 ++--
py_modules/lsfg_vk/steam_service.py | 86 +++-
py_modules/lsfg_vk/wrapper_service.py | 139 ++++-
src/api/lsfgApi.ts | 81 +--
src/components/ConfigurationTab.tsx | 22 +-
src/components/Content.tsx | 41 +-
src/components/FlatpaksTab.tsx | 196 --------
src/components/GameConfigurationControls.tsx | 3 +-
src/components/GameConfigurationSelector.tsx | 101 +---
src/components/NowPlayingTab.tsx | 93 +++-
src/components/SetupTab.tsx | 142 +++++-
src/components/WorkaroundsSection.tsx | 6 +-
src/components/index.ts | 2 -
src/hooks/useGameConfiguration.ts | 78 ++-
src/hooks/usePerAppWorkarounds.ts | 24 +-
src/types.d.ts | 1 +
tests/test_flatpak_overrides.py | 158 ------
tests/test_flatpak_service.py | 231 +++++++++
tests/test_steam_service.py | 77 +++
tests/test_wrapper_service.py | 79 ++-
21 files changed, 1468 insertions(+), 925 deletions(-)
delete mode 100644 src/components/FlatpaksTab.tsx
delete mode 100644 tests/test_flatpak_overrides.py
create mode 100644 tests/test_flatpak_service.py
create mode 100644 tests/test_steam_service.py
diff --git a/py_modules/lsfg_vk/flatpak_service.py b/py_modules/lsfg_vk/flatpak_service.py
index 0e89d3c..071b29c 100644
--- a/py_modules/lsfg_vk/flatpak_service.py
+++ b/py_modules/lsfg_vk/flatpak_service.py
@@ -1,33 +1,52 @@
+"""Flatpak runtime-extension infrastructure for unified game targets."""
+
+from __future__ import annotations
+
+import json
import os
import pwd
import re
import shutil
import subprocess
+import threading
from pathlib import Path
-from typing import Any, Dict, List
+from typing import Any, Dict, List, Optional, Set, Tuple
from .base_service import BaseService
-from .config_schema import ConfigurationManager
from .constants import (
BIN_DIR,
FLATPAK_23_08_FILENAME,
FLATPAK_24_08_FILENAME,
FLATPAK_25_08_FILENAME,
)
-from .types import BaseResponse
class FlatpakService(BaseService):
+ """Resolve and provision only the runtime support a target actually needs.
+
+ Flatpak application permissions are deliberately not persisted here. The
+ generated per-AppID wrapper supplies the narrow launch-time permissions and
+ environment instead, while this service owns only the shared Vulkan layer
+ runtime extensions installed from the plugin bundle.
+ """
+
EXTENSION_ID = "org.freedesktop.Platform.VulkanLayer.lsfgvk"
SUPPORTED_RUNTIMES = ("23.08", "24.08", "25.08")
- COMPATIBILITY_ENV = (
- ("ENABLE_GAMESCOPE_WSI", "0"),
- ("DXVK_HDR", "0"),
+ OWNERSHIP_FILENAME = "flatpak_extensions.json"
+ OWNERSHIP_VERSION = 1
+ APP_ID_PATTERN = re.compile(
+ r"^[A-Za-z0-9][A-Za-z0-9-]*(?:\.[A-Za-z0-9][A-Za-z0-9-]*)+$"
)
+ BRANCH_PATTERN = re.compile(r"^[0-9]+\.[0-9]+$")
def __init__(self, logger=None):
super().__init__(logger)
- self.flatpak_command = None
+ self.flatpak_command: Optional[str] = None
+ self._lock = threading.RLock()
+
+ @property
+ def ownership_path(self) -> Path:
+ return self.config_dir / self.OWNERSHIP_FILENAME
def _get_clean_env(self) -> Dict[str, str]:
env = os.environ.copy()
@@ -61,20 +80,39 @@ class FlatpakService(BaseService):
if runuser is None:
raise FileNotFoundError("runuser command not available")
command = [runuser, "--user", target_user.pw_name, "--", *command]
- return subprocess.run(
- command,
- env=self._get_clean_env(),
- **kwargs,
- )
+ return subprocess.run(command, env=self._get_clean_env(), **kwargs)
@classmethod
- def _extension_ref(cls, version: str) -> str:
- return f"{cls.EXTENSION_ID}/x86_64/{version}"
+ def _validate_app_id(cls, app_id: str) -> str:
+ if not isinstance(app_id, str) or not cls.APP_ID_PATTERN.fullmatch(app_id):
+ raise ValueError("Invalid Flatpak application ID")
+ return app_id
@classmethod
- def _validate_runtime(cls, version: str) -> None:
+ def _validate_runtime(cls, version: str) -> str:
if version not in cls.SUPPORTED_RUNTIMES:
- raise ValueError("Unsupported Flatpak runtime")
+ raise ValueError(
+ f"Unsupported Flatpak runtime branch {version}; "
+ f"supported branches are {', '.join(cls.SUPPORTED_RUNTIMES)}"
+ )
+ return version
+
+ @classmethod
+ def _extension_ref(cls, version: str) -> str:
+ return f"{cls.EXTENSION_ID}/x86_64/{cls._validate_runtime(version)}"
+
+ @classmethod
+ def runtime_branch_from_ref(cls, runtime_ref: str) -> str:
+ """Return the supported Freedesktop branch from a runtime ref."""
+ if not isinstance(runtime_ref, str):
+ raise ValueError("Flatpak did not return a runtime reference")
+ parts = runtime_ref.strip().split("/")
+ if len(parts) != 3 or parts[0] != "org.freedesktop.Platform":
+ raise ValueError(f"Unsupported Flatpak runtime reference: {runtime_ref}")
+ branch = parts[2]
+ if not cls.BRANCH_PATTERN.fullmatch(branch):
+ raise ValueError(f"Unrecognized Flatpak runtime branch: {branch}")
+ return cls._validate_runtime(branch)
@classmethod
def _bundle_filename(cls, version: str) -> str:
@@ -82,320 +120,432 @@ class FlatpakService(BaseService):
"23.08": FLATPAK_23_08_FILENAME,
"24.08": FLATPAK_24_08_FILENAME,
"25.08": FLATPAK_25_08_FILENAME,
- }[version]
+ }[cls._validate_runtime(version)]
def _bundled_extension_path(self, version: str) -> Path:
- self._validate_runtime(version)
- return Path(__file__).resolve().parent.parent.parent / BIN_DIR / self._bundle_filename(version)
+ return (
+ Path(__file__).resolve().parent.parent.parent
+ / BIN_DIR
+ / self._bundle_filename(version)
+ )
- def get_extension_status(self) -> Dict[str, Any]:
- try:
- if not self.check_flatpak_available():
- raise FileNotFoundError("Flatpak is not available on this system")
+ def _installed_extension_branches(self) -> Set[str]:
+ result = self._run_flatpak_command(
+ ["list", "--runtime", "--columns=application,arch,branch"],
+ capture_output=True,
+ text=True,
+ check=True,
+ )
+ installed: Set[str] = set()
+ for line in result.stdout.splitlines():
+ if not line.strip():
+ continue
+ fields = line.split("\t")
+ if len(fields) < 3:
+ fields = line.split()
+ if len(fields) < 3:
+ continue
+ application, arch, branch = (field.strip() for field in fields[:3])
+ if application == self.EXTENSION_ID and arch == "x86_64":
+ installed.add(branch)
+ return installed
- result = self._run_flatpak_command(
- ["list", "--user", "--runtime", "--columns=application,arch,branch"],
- capture_output=True,
- text=True,
- check=True,
- )
- installed = {
- tuple(line.split("\t")[:3])
- for line in result.stdout.splitlines()
- if line.strip()
+ def _read_owned_branches(self) -> Tuple[Set[str], bool]:
+ """Read ownership without guessing when metadata is damaged."""
+ path = self.ownership_path
+ if path.is_symlink():
+ self.log.warning(f"Flatpak ownership metadata is not a regular file: {path}")
+ return set(), True
+ if not path.exists():
+ return set(), False
+ if not path.is_file():
+ self.log.warning(f"Flatpak ownership metadata is not a regular file: {path}")
+ return set(), True
+ try:
+ raw = json.loads(path.read_text(encoding="utf-8"))
+ if not isinstance(raw, dict) or raw.get("version") != self.OWNERSHIP_VERSION:
+ raise ValueError("unsupported ownership metadata version")
+ branches = raw.get("plugin_owned_branches")
+ if not isinstance(branches, list):
+ raise ValueError("plugin_owned_branches is not a list")
+ normalized = {
+ self._validate_runtime(branch)
+ for branch in branches
+ if isinstance(branch, str)
}
- return self._success_response(
- BaseResponse,
- "Flatpak runtime status retrieved",
- installed_23_08=(self.EXTENSION_ID, "x86_64", "23.08") in installed,
- installed_24_08=(self.EXTENSION_ID, "x86_64", "24.08") in installed,
- installed_25_08=(self.EXTENSION_ID, "x86_64", "25.08") in installed,
- )
- except Exception as error:
- return self._error_response(
- BaseResponse,
- str(error),
- installed_23_08=False,
- installed_24_08=False,
- installed_25_08=False,
- )
+ if len(normalized) != len(branches):
+ raise ValueError("ownership metadata contains invalid branches")
+ return normalized, False
+ except (OSError, json.JSONDecodeError, TypeError, ValueError) as error:
+ self.log.warning(f"Could not trust Flatpak ownership metadata: {error}")
+ return set(), True
- def install_extension(self, version: str) -> Dict[str, Any]:
+ def _write_owned_branches(self, branches: Set[str]) -> None:
+ if not branches:
+ if self.ownership_path.exists() or self.ownership_path.is_symlink():
+ self.ownership_path.unlink()
+ return
+ document = {
+ "version": self.OWNERSHIP_VERSION,
+ "plugin_owned_branches": sorted(branches),
+ }
+ self._write_file(self.ownership_path, json.dumps(document, indent=2) + "\n")
+
+ def get_extension_status(self) -> Dict[str, Any]:
+ """Return global extension inventory for Setup diagnostics."""
try:
- self._validate_runtime(version)
if not self.check_flatpak_available():
- raise FileNotFoundError("Flatpak is not available on this system")
- bundle_path = self._bundled_extension_path(version)
- if not bundle_path.is_file():
- raise FileNotFoundError(
- f"Bundled Flatpak extension not found at {bundle_path}; reinstall the plugin"
+ return self._success_response(
+ dict,
+ "Flatpak is not available",
+ available=False,
+ extension_id=self.EXTENSION_ID,
+ supported_branches=list(self.SUPPORTED_RUNTIMES),
+ installed_branches=[],
+ owned_branches=[],
+ ownership_uncertain=False,
)
- result = self._run_flatpak_command(
- [
- "install",
- "--user",
- "--noninteractive",
- "--or-update",
- str(bundle_path),
- ],
- capture_output=True,
- text=True,
- )
- if result.returncode != 0:
- raise OSError(result.stderr.strip() or "Flatpak installation failed")
+ installed = self._installed_extension_branches()
+ owned, uncertain = self._read_owned_branches()
return self._success_response(
- BaseResponse,
- f"lsfg-vk {version} runtime extension installed from the bundled asset",
+ dict,
+ "Flatpak runtime extension status retrieved",
+ available=True,
+ extension_id=self.EXTENSION_ID,
+ supported_branches=list(self.SUPPORTED_RUNTIMES),
+ installed_branches=sorted(installed),
+ owned_branches=sorted(owned),
+ ownership_uncertain=uncertain,
)
except Exception as error:
- return self._error_response(BaseResponse, str(error))
-
- def uninstall_extension(self, version: str) -> Dict[str, Any]:
- try:
- self._validate_runtime(version)
- if not self.check_flatpak_available():
- raise FileNotFoundError("Flatpak is not available on this system")
- result = self._run_flatpak_command(
- ["uninstall", "--user", "--noninteractive", self._extension_ref(version)],
- capture_output=True,
- text=True,
- )
- if result.returncode != 0:
- raise OSError(result.stderr.strip() or "Flatpak uninstall failed")
- return self._success_response(
- BaseResponse,
- f"lsfg-vk {version} runtime extension uninstalled",
+ return self._error_response(
+ dict,
+ str(error),
+ available=self.check_flatpak_available(),
+ extension_id=self.EXTENSION_ID,
+ supported_branches=list(self.SUPPORTED_RUNTIMES),
+ installed_branches=[],
+ owned_branches=[],
+ ownership_uncertain=False,
)
- except Exception as error:
- return self._error_response(BaseResponse, str(error))
- def _override_output(self, app_id: str) -> str:
+ def get_flatpak_support_status(self) -> Dict[str, Any]:
+ return self.get_extension_status()
+
+ def _resolve_runtime(self, app_id: str) -> Dict[str, Any]:
+ self._validate_app_id(app_id)
+ if not self.check_flatpak_available():
+ raise FileNotFoundError("Flatpak is not available on this system")
result = self._run_flatpak_command(
- ["override", "--user", "--show", app_id],
+ ["info", "--show-runtime", app_id],
capture_output=True,
text=True,
)
if result.returncode != 0:
- raise OSError(result.stderr.strip() or "Failed to read Flatpak overrides")
- return result.stdout
-
- def _dll_directory(self) -> Path:
- if self.config_file_path.exists():
- try:
- profile_data = ConfigurationManager.parse_toml_content_multi_profile(
- self.config_file_path.read_text(encoding="utf-8")
- )
- dll_path = profile_data["global_config"].get("dll")
- if dll_path:
- return Path(dll_path).parent
- except Exception:
- pass
-
- return self.user_home / ".local/share/Steam/steamapps/common/Lossless Scaling"
+ raise OSError(result.stderr.strip() or f"Could not inspect Flatpak app {app_id}")
+ runtime_ref = result.stdout.strip().splitlines()[0] if result.stdout.strip() else ""
+ branch = self.runtime_branch_from_ref(runtime_ref)
+ return {"runtime": runtime_ref, "runtime_branch": branch}
- def _override_paths(self) -> Dict[str, str]:
- return {
- "config_dir": str(self.config_dir),
- "config_file": str(self.config_file_path),
- "dll_dir": str(self._dll_directory()),
- "legacy_home": str(self.user_home),
- "legacy_dll": str(
- self.user_home
- / ".local/share/Steam/steamapps/common/Lossless Scaling/Lossless.dll"
- ),
- "legacy_script": str(self.legacy_script_path),
- }
-
- def _override_file_path(self, app_id: str) -> Path:
- if not app_id or Path(app_id).name != app_id or app_id in {".", ".."}:
- raise ValueError("Invalid Flatpak application ID")
- return self.user_home / ".local/share/flatpak/overrides" / app_id
-
- @staticmethod
- def _filesystem_entry_path(entry: str) -> str:
- value = entry.strip()
- if value.startswith("!"):
- value = value[1:]
- for suffix in (":ro", ":rw", ":create"):
- if value.endswith(suffix):
- return value[: -len(suffix)]
- return value
-
- @staticmethod
- def _override_value(content: str, key: str) -> str:
- match = re.search(rf"(?m)^[ \t]*{re.escape(key)}[ \t]*=([^\r\n]*)", content)
- return match.group(1).strip() if match else ""
-
- def _clean_override_file(self, app_id: str, paths: Dict[str, str]) -> bool:
- path = self._override_file_path(app_id)
- if not path.is_file():
- return False
-
- owner = path.stat().st_uid, path.stat().st_gid
- original = path.read_text(encoding="utf-8")
- managed_paths = {
- paths[name]
- for name in ("config_dir", "dll_dir", "legacy_home", "legacy_dll", "legacy_script")
- }
- managed_env = {
- "LSFGVK_CONFIG",
- "LSFG_CONFIG",
- *(name for name, _ in self.COMPATIBILITY_ENV),
- }
- def clean_list(match):
- key, value, newline = match.groups()
- is_filesystem = key.split("=", 1)[0].strip() == "filesystems"
- keep = [item for item in value.split(";") if item and (
- self._filesystem_entry_path(item) not in managed_paths
- if is_filesystem else item.strip() not in managed_env
- )]
- return f"{key}{';'.join(keep)}{newline}" if keep else ""
-
- updated = re.sub(
- r"(?m)^([ \t]*(?:filesystems|unset-environment)[ \t]*=)([^\r\n]*)(\r?\n|$)",
- clean_list,
- original,
- )
- env_pattern = "|".join(re.escape(name) for name in managed_env)
- updated = re.sub(
- rf"(?m)^[ \t]*(?:{env_pattern})[ \t]*=[^\r\n]*(?:\r?\n|$)",
- "",
- updated,
- )
- if updated != original:
- self._write_file(path, updated)
- if os.geteuid() == 0:
- os.chown(path, *owner)
- return updated != original
-
- def _check_app_override_status(self, app_id: str) -> Dict[str, bool]:
- output = self._override_output(app_id)
- paths = self._override_paths()
- filesystem_entries = self._override_value(output, "filesystems").split(";")
- positive_filesystems = {
- self._filesystem_entry_path(entry)
- for entry in filesystem_entries
- if not entry.strip().startswith("!")
- }
- blocked_filesystems = {
- self._filesystem_entry_path(entry)
- for entry in filesystem_entries
- if entry.strip().startswith("!")
- }
- unset_environment = set(
- item.strip()
- for item in self._override_value(output, "unset-environment").split(";")
- if item.strip()
- )
- return {
- "filesystem": all(
- path in positive_filesystems and path not in blocked_filesystems
- for path in (paths["config_dir"], paths["dll_dir"])
- ),
- "env": all(
- self._override_value(output, name) == value and name not in unset_environment
- for name, value in (
- ("LSFGVK_CONFIG", paths["config_file"]),
- *self.COMPATIBILITY_ENV,
- )
- ),
- }
-
- def get_flatpak_apps(self) -> Dict[str, Any]:
+ def resolve_app_support(self, app_id: str) -> Dict[str, Any]:
+ """Resolve the exact runtime branch required by one Flatpak app."""
try:
- if not self.check_flatpak_available():
- raise FileNotFoundError("Flatpak is not available on this system")
- result = self._run_flatpak_command(
- ["list", "--app", "--columns=name,application"],
- capture_output=True,
- text=True,
- check=True,
+ app_id = self._validate_app_id(app_id)
+ resolved = self._resolve_runtime(app_id)
+ installed = self._installed_extension_branches()
+ branch = resolved["runtime_branch"]
+ ready = branch in installed
+ return self._success_response(
+ dict,
+ (
+ f"lsfg-vk support is ready for {app_id}"
+ if ready
+ else f"lsfg-vk runtime extension {branch} is required for {app_id}"
+ ),
+ flatpak_app_id=app_id,
+ runtime=resolved["runtime"],
+ runtime_branch=branch,
+ support_status="ready" if ready else "needs-runtime",
+ extension_installed=ready,
+ installed_branches=sorted(installed),
)
- apps = []
- for line in result.stdout.splitlines():
- parts = line.split("\t", 1)
- if len(parts) != 2:
- continue
- status = self._check_app_override_status(parts[1])
- apps.append(
- {
- "app_id": parts[1],
- "app_name": parts[0],
- "has_filesystem_override": status["filesystem"],
- "has_env_override": status["env"],
- }
- )
+ except ValueError as error:
return self._success_response(
- BaseResponse,
- f"Found {len(apps)} Flatpak applications",
- apps=apps,
- total_apps=len(apps),
+ dict,
+ str(error),
+ flatpak_app_id=app_id,
+ runtime=None,
+ runtime_branch=None,
+ support_status="unsupported",
+ extension_installed=False,
+ installed_branches=[],
+ error=str(error),
)
except Exception as error:
return self._error_response(
- BaseResponse,
+ dict,
str(error),
- apps=[],
- total_apps=0,
+ flatpak_app_id=app_id,
+ runtime=None,
+ runtime_branch=None,
+ support_status="error",
+ extension_installed=False,
+ installed_branches=[],
)
- def set_app_override(self, app_id: str) -> Dict[str, Any]:
+ def install_extension(self, version: str) -> Dict[str, Any]:
+ """Install one missing branch and record ownership only after readback."""
try:
+ version = self._validate_runtime(version)
if not self.check_flatpak_available():
raise FileNotFoundError("Flatpak is not available on this system")
- paths = self._override_paths()
- self._clean_override_file(app_id, paths)
- result = self._run_flatpak_command(
- [
- "override",
- "--user",
- f"--filesystem={paths['config_dir']}:rw",
- f"--filesystem={paths['dll_dir']}:ro",
- f"--env=LSFGVK_CONFIG={paths['config_file']}",
- *(f"--env={name}={value}" for name, value in self.COMPATIBILITY_ENV),
- app_id,
- ],
- capture_output=True,
- text=True,
+ bundle_path = self._bundled_extension_path(version)
+ if not bundle_path.is_file():
+ raise FileNotFoundError(
+ f"Bundled Flatpak extension not found at {bundle_path}; reinstall the plugin"
+ )
+ with self._lock:
+ owned, uncertain = self._read_owned_branches()
+ if uncertain:
+ raise RuntimeError(
+ "Flatpak ownership metadata is uncertain; refusing to install "
+ "until it is repaired"
+ )
+ installed_before = self._installed_extension_branches()
+ if version in installed_before:
+ return self._success_response(
+ dict,
+ f"lsfg-vk {version} runtime extension is already installed",
+ runtime_branch=version,
+ installed=True,
+ owned_by_plugin=version in owned,
+ )
+ result = self._run_flatpak_command(
+ [
+ "install",
+ "--user",
+ "--noninteractive",
+ "--or-update",
+ str(bundle_path),
+ ],
+ capture_output=True,
+ text=True,
+ )
+ if result.returncode != 0:
+ raise OSError(result.stderr.strip() or "Flatpak installation failed")
+ installed_after = self._installed_extension_branches()
+ if version not in installed_after:
+ raise RuntimeError(
+ f"Flatpak install completed but {self._extension_ref(version)} "
+ "was not visible afterwards"
+ )
+ owned.add(version)
+ self._write_owned_branches(owned)
+ return self._success_response(
+ dict,
+ f"lsfg-vk {version} runtime extension installed",
+ runtime_branch=version,
+ installed=True,
+ owned_by_plugin=True,
+ )
+ except Exception as error:
+ return self._error_response(
+ dict,
+ str(error),
+ runtime_branch=version,
+ installed=False,
+ owned_by_plugin=False,
)
- if result.returncode != 0:
- raise OSError(result.stderr.strip() or "Failed to set Flatpak overrides")
- status = self._check_app_override_status(app_id)
- if not status["filesystem"] or not status["env"]:
- raise RuntimeError("Flatpak overrides could not be verified after setting")
+
+ def ensure_extension(self, version: str) -> Dict[str, Any]:
+ status = self.get_extension_status()
+ if not status.get("success"):
+ return status
+ if not status.get("available"):
+ return self._error_response(
+ dict,
+ "Flatpak is not available on this system",
+ runtime_branch=version,
+ support_status="error",
+ )
+ try:
+ version = self._validate_runtime(version)
+ except ValueError as error:
+ return self._error_response(dict, str(error), runtime_branch=version, support_status="unsupported")
+ if version in status.get("installed_branches", []):
return self._success_response(
- BaseResponse,
- f"lsfg-vk overrides set for {app_id}",
- app_id=app_id,
- operation="set",
+ dict,
+ f"lsfg-vk {version} runtime extension is ready",
+ runtime_branch=version,
+ installed=True,
+ owned_by_plugin=version in status.get("owned_branches", []),
)
- except Exception as error:
+ return self.install_extension(version)
+
+ def ensure_app_support(self, app_id: str) -> Dict[str, Any]:
+ """Provision only the branch returned by flatpak info for this app."""
+ resolved = self.resolve_app_support(app_id)
+ if not resolved.get("success") or resolved.get("support_status") != "needs-runtime":
+ return resolved
+ branch = resolved.get("runtime_branch")
+ result = self.ensure_extension(branch)
+ if not result.get("success"):
return self._error_response(
- BaseResponse,
- str(error),
- app_id=app_id,
- operation="set",
+ dict,
+ result.get("error") or "Could not install the required Flatpak runtime extension",
+ flatpak_app_id=app_id,
+ runtime=resolved.get("runtime"),
+ runtime_branch=branch,
+ support_status="error",
+ extension_installed=False,
)
+ final = self.resolve_app_support(app_id)
+ if final.get("success") and final.get("support_status") == "ready":
+ return final
+ return self._error_response(
+ dict,
+ final.get("error") or "Required Flatpak runtime extension could not be verified",
+ flatpak_app_id=app_id,
+ runtime=resolved.get("runtime"),
+ runtime_branch=branch,
+ support_status="error",
+ extension_installed=False,
+ )
- def remove_app_override(self, app_id: str) -> Dict[str, Any]:
+ def uninstall_extension(self, version: str) -> Dict[str, Any]:
+ """Uninstall only when explicitly requested for a plugin-owned branch."""
try:
+ version = self._validate_runtime(version)
if not self.check_flatpak_available():
raise FileNotFoundError("Flatpak is not available on this system")
- paths = self._override_paths()
- self._clean_override_file(app_id, paths)
- status = self._check_app_override_status(app_id)
- if status["filesystem"] or status["env"]:
- raise RuntimeError("Flatpak overrides could not be verified after removal")
- return self._success_response(
- BaseResponse,
- f"lsfg-vk overrides removed for {app_id}",
- app_id=app_id,
- operation="remove",
+ with self._lock:
+ owned, uncertain = self._read_owned_branches()
+ if uncertain:
+ raise RuntimeError(
+ "Flatpak ownership metadata is uncertain; refusing to uninstall"
+ )
+ if version not in owned:
+ return self._success_response(
+ dict,
+ f"Preserved Flatpak extension {version}; it is not plugin-owned",
+ runtime_branch=version,
+ removed=False,
+ preserved=True,
+ )
+ installed = self._installed_extension_branches()
+ if version in installed:
+ result = self._run_flatpak_command(
+ [
+ "uninstall",
+ "--user",
+ "--noninteractive",
+ self._extension_ref(version),
+ ],
+ capture_output=True,
+ text=True,
+ )
+ if result.returncode != 0:
+ raise OSError(result.stderr.strip() or "Flatpak uninstall failed")
+ if version in self._installed_extension_branches():
+ raise RuntimeError(
+ f"Flatpak uninstall completed but {self._extension_ref(version)} "
+ "is still installed"
+ )
+ owned.remove(version)
+ self._write_owned_branches(owned)
+ return self._success_response(
+ dict,
+ f"Plugin-owned lsfg-vk {version} runtime extension removed",
+ runtime_branch=version,
+ removed=True,
+ preserved=False,
+ )
+ except Exception as error:
+ return self._error_response(
+ dict,
+ str(error),
+ runtime_branch=version,
+ removed=False,
+ preserved=False,
)
+
+ def remove_plugin_owned_extensions(self) -> Dict[str, Any]:
+ """Uninstall only branches recorded as installed by this plugin."""
+ try:
+ with self._lock:
+ owned, uncertain = self._read_owned_branches()
+ if uncertain:
+ return self._error_response(
+ dict,
+ "Flatpak ownership metadata is uncertain; no extensions were removed",
+ removed_branches=[],
+ preserved_branches=[],
+ ownership_uncertain=True,
+ )
+ if not owned:
+ return self._success_response(
+ dict,
+ "No plugin-owned Flatpak extensions to remove",
+ removed_branches=[],
+ preserved_branches=[],
+ ownership_uncertain=False,
+ )
+ if not self.check_flatpak_available():
+ return self._error_response(
+ dict,
+ "Flatpak is not available; plugin-owned extension metadata was preserved",
+ removed_branches=[],
+ preserved_branches=sorted(owned),
+ ownership_uncertain=False,
+ )
+ removed: List[str] = []
+ failures: List[str] = []
+ for branch in sorted(owned):
+ try:
+ installed = self._installed_extension_branches()
+ if branch in installed:
+ result = self._run_flatpak_command(
+ [
+ "uninstall",
+ "--user",
+ "--noninteractive",
+ self._extension_ref(branch),
+ ],
+ capture_output=True,
+ text=True,
+ )
+ if result.returncode != 0:
+ raise OSError(result.stderr.strip() or "Flatpak uninstall failed")
+ if branch in self._installed_extension_branches():
+ raise RuntimeError(
+ f"Flatpak uninstall completed but {self._extension_ref(branch)} "
+ "is still installed"
+ )
+ removed.append(branch)
+ except Exception as error:
+ failures.append(f"{branch}: {error}")
+ remaining = owned - set(removed)
+ self._write_owned_branches(remaining)
+ if failures:
+ return self._error_response(
+ dict,
+ "; ".join(failures),
+ removed_branches=removed,
+ preserved_branches=sorted(remaining),
+ ownership_uncertain=False,
+ )
+ return self._success_response(
+ dict,
+ "Plugin-owned Flatpak extensions removed",
+ removed_branches=removed,
+ preserved_branches=[],
+ ownership_uncertain=False,
+ )
except Exception as error:
return self._error_response(
- BaseResponse,
+ dict,
str(error),
- app_id=app_id,
- operation="remove",
+ removed_branches=[],
+ preserved_branches=[],
+ ownership_uncertain=False,
)
diff --git a/py_modules/lsfg_vk/plugin.py b/py_modules/lsfg_vk/plugin.py
index f80c635..cb2d3df 100644
--- a/py_modules/lsfg_vk/plugin.py
+++ b/py_modules/lsfg_vk/plugin.py
@@ -67,7 +67,24 @@ class Plugin:
return self.configuration_service.get_game_configs()
async def get_installed_games(self) -> Dict[str, Any]:
- return self.steam_service.get_installed_games()
+ result = self.steam_service.get_installed_games()
+ if not result.get("success"):
+ return result
+
+ support_cache: Dict[str, Dict[str, Any]] = {}
+ for game in result.get("games", []):
+ transport = game.get("transport") if isinstance(game, dict) else None
+ if not isinstance(transport, dict) or transport.get("kind") != "flatpak":
+ continue
+ flatpak_app_id = transport.get("flatpakAppId")
+ if not isinstance(flatpak_app_id, str) or not flatpak_app_id:
+ continue
+ if flatpak_app_id not in support_cache:
+ support_cache[flatpak_app_id] = self.flatpak_service.resolve_app_support(
+ flatpak_app_id
+ )
+ game["flatpakSupport"] = support_cache[flatpak_app_id]
+ return result
async def update_game_config(self, appid: str, game_name: str, config: Dict[str, Any]) -> Dict[str, Any]:
return self.configuration_service.update_game_config(appid, game_name, config)
@@ -87,8 +104,15 @@ class Plugin:
state: Dict[str, Any],
shortcut_exe: Optional[str] = None,
command_token_added: bool = False,
+ transport: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
- return self.wrapper_service.set(appid, state, shortcut_exe, command_token_added)
+ return self.wrapper_service.set(
+ appid,
+ state,
+ shortcut_exe,
+ command_token_added,
+ transport,
+ )
async def remove_workaround_state(self, appid: str) -> Dict[str, Any]:
return self.wrapper_service.remove(appid)
@@ -124,68 +148,20 @@ class Plugin:
"error": f"Error reading config file: {str(e)}"
}
- async def check_flatpak_extension_status(self) -> Dict[str, Any]:
- """Check status of lsfg-vk Flatpak runtime extensions
-
- Returns:
- FlatpakExtensionStatus dict with installation status for all supported runtime versions
- """
- return self.flatpak_service.get_extension_status()
-
- async def install_flatpak_extension(self, version: str) -> Dict[str, Any]:
- """Install lsfg-vk Flatpak runtime extension
-
- Args:
- version: Runtime version to install ("23.08", "24.08", or "25.08")
-
- Returns:
- BaseResponse dict with success status and message/error
- """
- return self.flatpak_service.install_extension(version)
-
- async def uninstall_flatpak_extension(self, version: str) -> Dict[str, Any]:
- """Uninstall lsfg-vk Flatpak runtime extension
-
- Args:
- version: Runtime version to uninstall ("23.08", "24.08", or "25.08")
-
- Returns:
- BaseResponse dict with success status and message/error
- """
- return self.flatpak_service.uninstall_extension(version)
-
- async def get_flatpak_apps(self) -> Dict[str, Any]:
- """Get list of installed Flatpak apps and their lsfg-vk override status
-
- Returns:
- FlatpakAppInfo dict with apps list and override status
- """
- return self.flatpak_service.get_flatpak_apps()
-
async def get_lossless_scaling_branch_status(self) -> Dict[str, Any]:
return self.steam_service.get_branch_status()
- async def set_flatpak_app_override(self, app_id: str) -> Dict[str, Any]:
- """Set lsfg-vk overrides for a Flatpak app
-
- Args:
- app_id: Flatpak application ID
-
- Returns:
- FlatpakOverrideResponse dict with operation result
- """
- return self.flatpak_service.set_app_override(app_id)
+ async def get_flatpak_support_status(self) -> Dict[str, Any]:
+ return self.flatpak_service.get_flatpak_support_status()
- async def remove_flatpak_app_override(self, app_id: str) -> Dict[str, Any]:
- """Remove lsfg-vk overrides for a Flatpak app
-
- Args:
- app_id: Flatpak application ID
-
- Returns:
- FlatpakOverrideResponse dict with operation result
- """
- return self.flatpak_service.remove_app_override(app_id)
+ async def ensure_flatpak_support(self, flatpak_app_id: str) -> Dict[str, Any]:
+ return self.flatpak_service.ensure_app_support(flatpak_app_id)
+
+ async def repair_flatpak_support(self, flatpak_app_id: str) -> Dict[str, Any]:
+ return self.flatpak_service.ensure_app_support(flatpak_app_id)
+
+ async def remove_plugin_owned_flatpak_extensions(self) -> Dict[str, Any]:
+ return self.flatpak_service.remove_plugin_owned_extensions()
async def _main(self):
"""
@@ -224,16 +200,9 @@ class Plugin:
self.installation_service.cleanup_on_uninstall()
try:
- extension_status = self.flatpak_service.get_extension_status()
- for version, key in (
- ("23.08", "installed_23_08"),
- ("24.08", "installed_24_08"),
- ("25.08", "installed_25_08"),
- ):
- if extension_status.get(key):
- result = self.flatpak_service.uninstall_extension(version)
- if not result.get("success"):
- decky.logger.warning(result.get("error"))
+ result = self.flatpak_service.remove_plugin_owned_extensions()
+ if not result.get("success"):
+ decky.logger.warning(result.get("error"))
except Exception as error:
decky.logger.error(f"Error during Flatpak cleanup: {error}")
diff --git a/py_modules/lsfg_vk/steam_service.py b/py_modules/lsfg_vk/steam_service.py
index 9a6570f..b3bdb69 100644
--- a/py_modules/lsfg_vk/steam_service.py
+++ b/py_modules/lsfg_vk/steam_service.py
@@ -1,4 +1,5 @@
import re
+import shlex
from pathlib import Path
from typing import Dict, Optional, Tuple
@@ -6,6 +7,46 @@ from .base_service import BaseService
from .constants import STEAM_LOSSLESS_SCALING_APP_ID, STEAM_LOSSLESS_SCALING_BRANCH
+_FLATPAK_APP_ID = re.compile(r"^[A-Za-z0-9][A-Za-z0-9-]*(?:\.[A-Za-z0-9][A-Za-z0-9-]*)+$")
+
+
+def _split_command(value: Optional[str]) -> Optional[list[str]]:
+ if not isinstance(value, str) or not value.strip():
+ return []
+ try:
+ return shlex.split(value, posix=True)
+ except ValueError:
+ return None
+
+
+def classify_shortcut_transport(
+ executable: Optional[str],
+ launch_options: Optional[str] = None,
+) -> Dict[str, object]:
+ """Classify only direct Flatpak invocations; leave shell launchers on host."""
+ executable_tokens = _split_command(executable)
+ option_tokens = _split_command(launch_options)
+ if executable_tokens is None or option_tokens is None or not executable_tokens:
+ return {"kind": "host"}
+
+ if executable_tokens[0] != "/usr/bin/flatpak":
+ return {"kind": "host"}
+
+ arguments = [*executable_tokens[1:], *option_tokens]
+ if not arguments or arguments[0] != "run":
+ return {"kind": "host"}
+
+ for argument in arguments[1:]:
+ if argument == "--":
+ continue
+ if argument.startswith("-"):
+ continue
+ if _FLATPAK_APP_ID.fullmatch(argument):
+ return {"kind": "flatpak", "flatpakAppId": argument}
+ return {"kind": "host"}
+ return {"kind": "host"}
+
+
class SteamService(BaseService):
DEFAULT_BRANCH = "public"
MANIFEST_FILENAME = f"appmanifest_{STEAM_LOSSLESS_SCALING_APP_ID}.acf"
@@ -114,7 +155,43 @@ class SteamService(BaseService):
name = shortcut.get("AppName") or shortcut.get("appname")
if not isinstance(appid, int) or appid == 0 or not isinstance(name, str) or not name:
return None
- return {"appid": str(appid & 0xffffffff), "name": name, "nonSteam": True}
+ executable = next(
+ (
+ shortcut.get(key)
+ for key in ("Exe", "exe", "executable")
+ if isinstance(shortcut.get(key), str)
+ ),
+ None,
+ )
+ launch_options = next(
+ (
+ shortcut.get(key)
+ for key in ("LaunchOptions", "launchoptions", "launch_options", "arguments")
+ if isinstance(shortcut.get(key), str)
+ ),
+ None,
+ )
+ start_dir = next(
+ (
+ shortcut.get(key)
+ for key in ("StartDir", "startdir", "start_dir")
+ if isinstance(shortcut.get(key), str)
+ ),
+ None,
+ )
+ game: Dict[str, object] = {
+ "appid": str(appid & 0xffffffff),
+ "name": name,
+ "nonSteam": True,
+ "transport": classify_shortcut_transport(executable, launch_options),
+ }
+ if executable is not None:
+ game["executable"] = executable
+ if launch_options is not None:
+ game["arguments"] = launch_options
+ if start_dir is not None:
+ game["startDir"] = start_dir
+ return game
def _shortcut_games(self):
games = {}
@@ -294,7 +371,12 @@ class SteamService(BaseService):
if appid in self.GAME_SELECTOR_EXCLUDED_APPIDS:
continue
name = self._section_value(content, "AppState", "name") or f"App {appid}"
- games[appid] = {"appid": appid, "name": name, "nonSteam": False}
+ games[appid] = {
+ "appid": appid,
+ "name": name,
+ "nonSteam": False,
+ "transport": {"kind": "host"},
+ }
for game in self._shortcut_games():
games.setdefault(str(game["appid"]), game)
return self._success_response(
diff --git a/py_modules/lsfg_vk/wrapper_service.py b/py_modules/lsfg_vk/wrapper_service.py
index a3cba6e..dae565b 100644
--- a/py_modules/lsfg_vk/wrapper_service.py
+++ b/py_modules/lsfg_vk/wrapper_service.py
@@ -16,8 +16,10 @@ from .constants import WRAPPER_FILENAME
class WrapperService(BaseService):
"""Persist workaround state and compile it into a safe POSIX wrapper."""
- FORMAT_VERSION = 1
- MARKER = "# lsfg-vk-wrapper-format: 1"
+ LEGACY_FORMAT_VERSION = 1
+ FORMAT_VERSION = 2
+ LEGACY_MARKER = "# lsfg-vk-wrapper-format: 1"
+ MARKER = "# lsfg-vk-wrapper-format: 2"
WRAPPER_TOKEN = "~/.lsfg"
STATE_FIELDS = (
"dxvkFrameRate",
@@ -81,6 +83,28 @@ class WrapperService(BaseService):
raise ValueError(f"{field} must be a boolean")
return state
+ @classmethod
+ def _validate_transport(cls, raw: Any) -> Dict[str, Any]:
+ if raw is None:
+ return {"kind": "host"}
+ if not isinstance(raw, dict):
+ raise ValueError("Workaround transport must be an object")
+ kind = raw.get("kind")
+ if kind == "host":
+ return {"kind": "host"}
+ if kind == "flatpak":
+ app_id = raw.get("flatpakAppId")
+ if (
+ not isinstance(app_id, str)
+ or not re.fullmatch(
+ r"^[A-Za-z0-9][A-Za-z0-9-]*(?:\.[A-Za-z0-9][A-Za-z0-9-]*)+$",
+ app_id,
+ )
+ ):
+ raise ValueError("Flatpak transport requires a valid application ID")
+ return {"kind": "flatpak", "flatpakAppId": app_id}
+ raise ValueError("Workaround transport must be host or flatpak")
+
@classmethod
def _validate_entry(cls, raw: Any) -> Dict[str, Any]:
if not isinstance(raw, dict):
@@ -88,6 +112,10 @@ class WrapperService(BaseService):
entry = {
"state": cls._validate_state(raw.get("state")),
"command_token_added": raw.get("command_token_added", False),
+ # Version 1 entries had no transport field. They are preserved as
+ # host entries until the shortcut is explicitly repaired with the
+ # backend's classified transport.
+ "transport": cls._validate_transport(raw.get("transport")),
}
if type(entry["command_token_added"]) is not bool:
raise ValueError("command_token_added must be a boolean")
@@ -105,7 +133,10 @@ class WrapperService(BaseService):
@classmethod
def _validate_document(cls, raw: Any) -> Dict[str, Any]:
- if not isinstance(raw, dict) or raw.get("version") != cls.FORMAT_VERSION:
+ if not isinstance(raw, dict) or raw.get("version") not in (
+ cls.LEGACY_FORMAT_VERSION,
+ cls.FORMAT_VERSION,
+ ):
raise ValueError("Unsupported lsfg-vk workaround state version")
apps = raw.get("apps")
if not isinstance(apps, dict):
@@ -142,7 +173,7 @@ class WrapperService(BaseService):
prefix = "\n".join(self.wrapper_path.read_text(encoding="utf-8").splitlines()[:8])
except OSError as error:
raise RuntimeError(f"Could not read lsfg wrapper: {error}") from error
- return self.MARKER in prefix
+ return self.MARKER in prefix or self.LEGACY_MARKER in prefix
def _assert_wrapper_owned_or_absent(self) -> bool:
if not self.wrapper_path.exists() and not self.wrapper_path.is_symlink():
@@ -157,6 +188,17 @@ class WrapperService(BaseService):
def _shell(value: str) -> str:
return shlex.quote(value)
+ @staticmethod
+ def _direct_flatpak_tokens(value: str) -> Optional[list[str]]:
+ """Parse the supported full executable form: /usr/bin/flatpak run APP."""
+ try:
+ tokens = shlex.split(value, posix=True)
+ except ValueError:
+ return None
+ if len(tokens) >= 3 and Path(tokens[0]).name == "flatpak" and tokens[1] == "run":
+ return tokens
+ return None
+
@classmethod
def _state_lines(cls, state: Dict[str, Any], shortcut_exe: Optional[str]) -> list[str]:
lines = [" unset " + " ".join(cls.MANAGED_ENV_KEYS)]
@@ -194,9 +236,31 @@ class WrapperService(BaseService):
lines.append(f" shortcut_exe={cls._shell(shortcut_exe or '')}")
return lines
- @classmethod
- def _flatpak_args(cls, state: Dict[str, Any]) -> list[str]:
+ def _dll_directory(self) -> Path:
+ if self.config_file_path.exists():
+ try:
+ content = self.config_file_path.read_text(encoding="utf-8")
+ match = re.search(
+ r'(?m)^[ \t]*dll[ \t]*=[ \t]*"((?:\\.|[^"\\])*)"',
+ content,
+ )
+ if match:
+ configured_dll = json.loads('"' + match.group(1) + '"')
+ if configured_dll:
+ return Path(configured_dll).parent
+ except Exception:
+ pass
+ return self.user_home / ".local/share/Steam/steamapps/common/Lossless Scaling"
+
+ def _flatpak_args(self, state: Dict[str, Any]) -> list[str]:
+ config_dir = str(self.config_dir)
+ config_file = str(self.config_file_path)
+ dll_dir = str(self._dll_directory())
args = [
+ self._shell(f"--filesystem={config_dir}:rw"),
+ self._shell(f"--filesystem={dll_dir}:ro"),
+ self._shell(f"--env=LSFGVK_CONFIG={config_file}"),
+ '"--env=LSFGVK_FLATPAK=1"',
'"--env=SteamAppId=$appid"',
'"--unset-env=DISABLE_GAMESCOPE_WSI"',
'"--unset-env=ENABLE_GAMESCOPE_WSI"' if not state["disableGamescopeWsi"] else
@@ -230,11 +294,10 @@ class WrapperService(BaseService):
" fi",
]
- @classmethod
- def _render_wrapper(cls, document: Dict[str, Any]) -> str:
+ def _render_wrapper(self, document: Dict[str, Any]) -> str:
lines = [
"#!/bin/sh",
- cls.MARKER,
+ self.MARKER,
"# Generated by Decky LSFG-VK; edits will be rejected on the next update.",
"",
"appid=",
@@ -260,29 +323,61 @@ class WrapperService(BaseService):
for appid in sorted(document["apps"], key=lambda value: int(value)):
entry = document["apps"][appid]
lines.append(f" {appid})")
- lines.extend(cls._state_lines(entry["state"], entry.get("shortcut_exe")))
+ lines.extend(self._state_lines(entry["state"], entry.get("shortcut_exe")))
lines.append(" ;;")
lines.extend([
"esac",
"",
'if [ -n "$shortcut_exe" ]; then',
- ' if [ "${1-}" = "run" ]; then',
- ' flatpak_command="$1"',
- " shift",
])
# The arguments are emitted per branch below so the values are static and
# the wrapper never needs a JSON parser or another helper executable.
lines.append(' case "$appid" in')
for appid in sorted(document["apps"], key=lambda value: int(value)):
entry = document["apps"][appid]
- if not entry.get("shortcut_exe", "").endswith("/flatpak"):
+ transport = entry.get("transport", {"kind": "host"})
+ if transport.get("kind") != "flatpak":
continue
+ shortcut_exe = entry.get("shortcut_exe", "")
+ direct_flatpak_tokens = self._direct_flatpak_tokens(shortcut_exe)
+ if direct_flatpak_tokens is None and Path(shortcut_exe).name != "flatpak":
+ raise ValueError(
+ f"Flatpak target {appid} does not use a direct flatpak executable"
+ )
lines.append(f" {appid})")
- lines.extend(cls._flatpak_args(entry["state"]))
+ lines.extend([
+ *(
+ [
+ f" shortcut_exe={self._shell(direct_flatpak_tokens[0])}",
+ " set -- "
+ + " ".join(self._shell(token) for token in direct_flatpak_tokens[1:])
+ + ' "$@"',
+ ]
+ if direct_flatpak_tokens
+ else []
+ ),
+ ' if [ "${1-}" != "run" ]; then',
+ ' echo "lsfg-vk: Flatpak shortcut must use direct flatpak run transport" >&2',
+ " exit 64",
+ " fi",
+ ' flatpak_command="$1"',
+ " shift",
+ " flatpak_target=",
+ ' for flatpak_arg in "$@"; do',
+ ' case "$flatpak_arg" in',
+ ' -*) ;;',
+ ' *) flatpak_target="$flatpak_arg"; break ;;',
+ " esac",
+ " done",
+ f' if [ "$flatpak_target" != {self._shell(transport["flatpakAppId"])} ]; then',
+ ' echo "lsfg-vk: Flatpak shortcut application ID changed externally" >&2',
+ " exit 64",
+ " fi",
+ ])
+ lines.extend(self._flatpak_args(entry["state"]))
lines.append(" ;;")
lines.extend([
" esac",
- " fi",
' exec "$shortcut_exe" "$@"',
"fi",
'exec "$@"',
@@ -328,6 +423,7 @@ class WrapperService(BaseService):
"wrapper_owned": self._wrapper_marker() if document["apps"] else False,
"shortcut_exe": entry.get("shortcut_exe") if entry else None,
"command_token_added": entry.get("command_token_added", False) if entry else False,
+ "transport": dict(entry.get("transport", {"kind": "host"})) if entry else None,
}
def get(self, appid: str) -> Dict[str, Any]:
@@ -354,6 +450,7 @@ class WrapperService(BaseService):
state: Dict[str, Any],
shortcut_exe: Optional[str] = None,
command_token_added: bool = False,
+ transport: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
try:
normalized = self._valid_appid(appid)
@@ -364,9 +461,19 @@ class WrapperService(BaseService):
self._assert_wrapper_owned_or_absent()
document, _, _ = self._read_document()
previous_entry = document["apps"].get(normalized)
+ selected_transport = self._validate_transport(
+ transport
+ if transport is not None
+ else (
+ previous_entry.get("transport")
+ if previous_entry
+ else None
+ )
+ )
entry: Dict[str, Any] = {
"state": validated_state,
"command_token_added": bool(command_token_added),
+ "transport": selected_transport,
}
if shortcut_exe is not None:
entry = self._validate_entry({**entry, "shortcut_exe": shortcut_exe})
diff --git a/src/api/lsfgApi.ts b/src/api/lsfgApi.ts
index 087228c..f487dff 100644
--- a/src/api/lsfgApi.ts
+++ b/src/api/lsfgApi.ts
@@ -43,7 +43,34 @@ export interface GameConfigEntry {
profile: string;
config: LsfgConfig;
}
-export interface InstalledGame { appid: string; name: string; nonSteam: boolean; }
+export type TargetTransport =
+ | { kind: "host" }
+ | { kind: "flatpak"; flatpakAppId: string };
+
+export type FlatpakTargetSupportStatus = "ready" | "needs-runtime" | "unsupported" | "error";
+
+export interface FlatpakTargetSupport {
+ success: boolean;
+ message?: string;
+ error?: string | null;
+ flatpak_app_id?: string;
+ runtime?: string | null;
+ runtime_branch?: string | null;
+ support_status: FlatpakTargetSupportStatus;
+ extension_installed: boolean;
+ installed_branches: string[];
+}
+
+export interface InstalledGame {
+ appid: string;
+ name: string;
+ nonSteam: boolean;
+ transport: TargetTransport;
+ executable?: string;
+ arguments?: string;
+ startDir?: string;
+ flatpakSupport?: FlatpakTargetSupport;
+}
export interface InstalledGamesResult { success: boolean; games?: InstalledGame[]; error?: string; }
export interface GlobalConfig { dll: string; no_fp16: boolean; }
@@ -79,6 +106,7 @@ export interface WorkaroundStateResult {
wrapper_owned?: boolean;
shortcut_exe?: string | null;
command_token_added?: boolean;
+ transport?: TargetTransport | null;
}
export interface FileContentResult {
@@ -88,37 +116,25 @@ export interface FileContentResult {
error?: string;
}
-// Flatpak management interfaces
export interface FlatpakExtensionStatus {
success: boolean;
message: string;
- error?: string;
- installed_23_08: boolean;
- installed_24_08: boolean;
- installed_25_08: boolean;
+ error?: string | null;
+ available: boolean;
+ extension_id: string;
+ supported_branches: string[];
+ installed_branches: string[];
+ owned_branches: string[];
+ ownership_uncertain: boolean;
}
-export interface FlatpakApp {
- app_id: string;
- app_name: string;
- has_filesystem_override: boolean;
- has_env_override: boolean;
-}
-
-export interface FlatpakAppInfo {
- success: boolean;
- message: string;
- error?: string;
- apps: FlatpakApp[];
- total_apps: number;
-}
-
-export interface FlatpakOperationResult {
+export interface FlatpakCleanupResult {
success: boolean;
message: string;
- error?: string;
- app_id?: string;
- operation?: string;
+ error?: string | null;
+ removed_branches: string[];
+ preserved_branches: string[];
+ ownership_uncertain: boolean;
}
// API functions
@@ -128,13 +144,13 @@ export const checkLsfgVkInstalled = callable<[], InstallationStatus>("check_lsfg
export const getLosslessScalingBranchStatus = callable<[], SteamBranchStatus>("get_lossless_scaling_branch_status");
export const getConfigFileContent = callable<[], FileContentResult>("get_config_file_content");
-// Flatpak management API functions
-export const checkFlatpakExtensionStatus = callable<[], FlatpakExtensionStatus>("check_flatpak_extension_status");
-export const installFlatpakExtension = callable<[string], FlatpakOperationResult>("install_flatpak_extension");
-export const uninstallFlatpakExtension = callable<[string], FlatpakOperationResult>("uninstall_flatpak_extension");
-export const getFlatpakApps = callable<[], FlatpakAppInfo>("get_flatpak_apps");
-export const setFlatpakAppOverride = callable<[string], FlatpakOperationResult>("set_flatpak_app_override");
-export const removeFlatpakAppOverride = callable<[string], FlatpakOperationResult>("remove_flatpak_app_override");
+export const getFlatpakSupportStatus = callable<[], FlatpakExtensionStatus>("get_flatpak_support_status");
+export const ensureFlatpakSupport = callable<[string], FlatpakTargetSupport>("ensure_flatpak_support");
+export const repairFlatpakSupport = callable<[string], FlatpakTargetSupport>("repair_flatpak_support");
+export const removePluginOwnedFlatpakExtensions = callable<
+ [],
+ FlatpakCleanupResult
+>("remove_plugin_owned_flatpak_extensions");
export const getGameConfigs = callable<[], GameConfigsResult>("get_game_configs");
export const getInstalledGames = callable<[], InstalledGamesResult>("get_installed_games");
@@ -147,5 +163,6 @@ export const setWorkaroundState = callable<[
WorkaroundState,
string | null | undefined,
boolean,
+ TargetTransport | null | undefined,
], WorkaroundStateResult>("set_workaround_state");
export const removeWorkaroundState = callable<[string], WorkaroundStateResult>("remove_workaround_state");
diff --git a/src/components/ConfigurationTab.tsx b/src/components/ConfigurationTab.tsx
index 62a971b..90c1a7b 100644
--- a/src/components/ConfigurationTab.tsx
+++ b/src/components/ConfigurationTab.tsx
@@ -14,7 +14,6 @@ interface ConfigurationTabProps {
onSelect: (appid: string) => void;
onConfigChange: (fieldName: keyof ConfigurationData, value: boolean | number | string | string[]) => Promise;
onEnable: (appid: string) => Promise;
- onEnableAll: () => Promise;
onRepair: (appid: string) => Promise;
onReset: () => Promise;
onResetAll: () => Promise;
@@ -27,7 +26,6 @@ export function ConfigurationTab({
onSelect,
onConfigChange,
onEnable,
- onEnableAll,
onRepair,
onReset,
onResetAll,
@@ -86,7 +84,6 @@ export function ConfigurationTab({
onSelect(appid);
setDetailAppId(appid);
}}
- onEnableAll={onEnableAll}
onResetAll={onResetAll}
focusConfiguredToggle={focusConfiguredToggle}
onConfiguredToggleFocused={clearConfiguredToggleFocusRequest}
@@ -96,8 +93,13 @@ export function ConfigurationTab({
}
const profileLabel = selectedTarget?.name || "Game profile";
+ const profileTransport = selectedTarget
+ ? selectedTarget.transport.kind === "flatpak"
+ ? "Non-Steam · Flatpak"
+ : selectedTarget.nonSteam ? "Non-Steam" : "Steam"
+ : "Game";
const profileDescription = selectedTarget
- ? `${selectedTarget.nonSteam ? "Non-Steam" : "Steam"} · App ID ${selectedTarget.appid} · ${selectedTarget.configured ? "LSFG-VK Enabled" : "LSFG-VK not enabled"}`
+ ? `${profileTransport} · App ID ${selectedTarget.appid} · ${selectedTarget.configured ? "LSFG-VK Enabled" : "LSFG-VK not enabled"}`
: "Game is no longer available";
const handleProfileAction = async () => {
if (selectedTarget?.configured) {
@@ -151,6 +153,18 @@ export function ConfigurationTab({
)}
+ {selectedTarget?.configured && selectedTarget.transport.kind === "flatpak" && selectedTarget.flatpakSupport?.support_status !== "ready" && (
+
+
+ void onRepair(selectedTarget.appid)}
+ >
+ Repair Flatpak support
+
+
+
+ )}
{selectedTarget?.configured && (
(null);
useEffect(() => {
if (!setupComplete) {
setTab("Setup");
return;
}
- setTab((current) => current === "Setup" ? (runningGame?.configured ? "NowPlaying" : "Configuration") : current);
- }, [runningGame?.configured, setupComplete]);
+ setTab((current) => current === "Setup" ? (runningGame ? "NowPlaying" : "Games") : current);
+ }, [runningGame?.appid, setupComplete]);
useEffect(() => {
if (!setupComplete) return;
- const current = runningGame ? { appid: runningGame.appid, configured: runningGame.configured } : null;
- const previous = previousRunningState.current;
- previousRunningState.current = current;
- if (current?.appid && (current.appid !== previous?.appid || current.configured !== previous?.configured)) {
- setTab(current.configured ? "NowPlaying" : "Configuration");
- } else if (!current && previous) {
- setTab((currentTab) => currentTab === "NowPlaying" ? "Configuration" : currentTab);
+ const appid = runningGame?.appid || null;
+ const previous = previousRunningAppId.current;
+ previousRunningAppId.current = appid;
+ if (appid && appid !== previous) {
+ setTab("NowPlaying");
+ } else if (!appid && previous) {
+ setTab((currentTab) => currentTab === "NowPlaying" ? "Games" : currentTab);
}
}, [runningGame?.appid, runningGame?.configured, setupComplete]);
@@ -105,12 +100,13 @@ export function Content() {
isUninstalling={isUninstalling}
onInstall={onInstall}
onUninstall={onUninstall}
+ flatpakRelevant={targets.some((target) => target.transport.kind === "flatpak")}
/>
);
const tabs = setupComplete
? [
- ...(runningGame?.configured ? [{
+ ...(runningGame ? [{
id: "NowPlaying",
title: tabIcons.nowPlaying,
content: (
@@ -118,12 +114,14 @@ export function Content() {
game={runningGame}
config={config}
onConfigChange={(fieldName, value) => handleConfigChange(fieldName, value)}
+ onEnable={enable}
+ onRepair={repair}
/>
),
}] : []),
{
- id: "Configuration",
- title: tabIcons.configuration,
+ id: "Games",
+ title: tabIcons.games,
content: (
handleConfigChange(fieldName, value, true)}
onEnable={enable}
- onEnableAll={enableAll}
onRepair={repair}
onReset={resetSelected}
onResetAll={resetAll}
/>
),
},
- { id: "Flatpak", title: tabIcons.flatpak, content:
- onAction()}
- disabled={busy}
- />
-
- );
-}
-
-interface AppRowProps {
- app: FlatpakApp;
- runtimeReady: boolean;
- busy: boolean;
- onToggle: () => void;
-}
-
-function AppRow({ app, runtimeReady, busy, onToggle }: AppRowProps) {
- const configured = app.has_filesystem_override && app.has_env_override;
- const partial = app.has_filesystem_override || app.has_env_override;
- const status = configured
- ? runtimeReady
- ? t("FLATPAK_STATUS_READY", "Ready")
- : t("FLATPAK_STATUS_RUNTIME_MISSING", "Runtime missing")
- : partial
- ? t("FLATPAK_STATUS_PARTIAL", "Partial")
- : t("FLATPAK_STATUS_NOT_ENABLED", "Not enabled");
-
- return (
-
-
- );
-}
-
-export function FlatpaksTab() {
- const [extensionStatus, setExtensionStatus] = useState(null);
- const [apps, setApps] = useState(null);
- const [loading, setLoading] = useState(true);
- const [operation, setOperation] = useState(null);
- const [error, setError] = useState(null);
- const runtimeReady = extensionStatus?.success === true
- && runtimeVersions.some(({ key }) => extensionStatus[key]);
-
- const load = async () => {
- setLoading(true);
- try {
- const [nextStatus, nextApps] = await Promise.all([
- checkFlatpakExtensionStatus(),
- getFlatpakApps(),
- ]);
- setExtensionStatus(nextStatus);
- setApps(nextApps);
- } catch (loadError) {
- setError(String(loadError));
- } finally {
- setLoading(false);
- }
- };
-
- useEffect(() => {
- void load();
- }, []);
-
- const runExtensionOperation = async (version: string, installed: boolean) => {
- const action = installed ? "uninstall" : "install";
- setOperation(`${action}-${version}`);
- setError(null);
- try {
- const result = installed
- ? await uninstallFlatpakExtension(version)
- : await installFlatpakExtension(version);
- if (!result.success) throw new Error(result.error || result.message);
- setExtensionStatus(await checkFlatpakExtensionStatus());
- } catch (operationError) {
- const message = String(operationError);
- setError(message);
- showErrorToast("Flatpak operation failed", message);
- } finally {
- setOperation(null);
- }
- };
-
- const confirmExtensionOperation = (version: string, installed: boolean) => {
- if (!installed) {
- void runExtensionOperation(version, false);
- return;
- }
- showModal(
- void runExtensionOperation(version, true)}
- onCancel={() => {}}
- />,
- );
- };
-
- const toggleApp = async (app: FlatpakApp) => {
- const configured = app.has_filesystem_override && app.has_env_override;
- setOperation(`app-${app.app_id}`);
- setError(null);
- try {
- const result = configured
- ? await removeFlatpakAppOverride(app.app_id)
- : await setFlatpakAppOverride(app.app_id);
- if (!result.success) throw new Error(result.error || result.message);
- setApps(await getFlatpakApps());
- } catch (operationError) {
- const message = String(operationError);
- setError(message);
- showErrorToast("Flatpak override failed", message);
- } finally {
- setOperation(null);
- }
- };
-
- if (loading) {
- return
- {error && confirmExtensionOperation(version, extensionStatus[key])}
- />
- )) :
-
-
- {apps?.success ? apps.apps.length ? apps.apps.map((app) => (
- void toggleApp(app)}
- />
- )) :
-
- );
-}
diff --git a/src/components/GameConfigurationControls.tsx b/src/components/GameConfigurationControls.tsx
index 7025f78..6bea2e0 100644
--- a/src/components/GameConfigurationControls.tsx
+++ b/src/components/GameConfigurationControls.tsx
@@ -10,7 +10,7 @@ interface Props {
autoFocusFpsMultiplier?: boolean;
onFpsMultiplierFocused?: () => void;
showWorkarounds?: boolean;
- workaroundTarget?: Pick;
+ workaroundTarget?: Pick;
onRepairWorkaround?: () => Promise;
}
@@ -36,6 +36,7 @@ export function GameConfigurationControls({
;
onResetAll: () => Promise;
focusConfiguredToggle?: boolean;
onConfiguredToggleFocused?: () => void;
}
-const CONFIGURED_COLLAPSED_KEY = "lsfg-configured-games-collapsed-v3";
-const AVAILABLE_COLLAPSED_KEY = "lsfg-available-games-collapsed-v2";
+const ENABLED_COLLAPSED_KEY = "lsfg-enabled-games-collapsed-v4";
+const AVAILABLE_COLLAPSED_KEY = "lsfg-available-games-collapsed-v3";
function usePersistentCollapsed(key: string) {
const [collapsed, setCollapsed] = useState(() => {
@@ -36,6 +35,11 @@ function usePersistentCollapsed(key: string) {
return [collapsed, () => setCollapsed((value) => !value)] as const;
}
+function targetDescription(game: GameTarget): string {
+ if (game.transport.kind === "flatpak") return "Non-Steam · Flatpak";
+ return game.nonSteam ? "Non-Steam" : "Steam";
+}
+
function GameGroup({
title,
games,
@@ -56,7 +60,7 @@ function GameGroup({
return (
<>
-
@@ -81,7 +81,7 @@ function GameGroup({
onSelect(game.appid)}
highlightOnFocus
/>
@@ -95,7 +95,6 @@ export function GameConfigurationSelector({
targets,
runningGame,
onSelect,
- onEnableAll,
onResetAll,
focusConfiguredToggle = false,
onConfiguredToggleFocused,
@@ -105,26 +104,20 @@ export function GameConfigurationSelector({
if (b.appid === runningGame?.appid) return 1;
return a.name.localeCompare(b.name);
});
- const configuredGames = sortGames(targets.filter((game) => game.configured));
+ const enabledGames = sortGames(targets.filter((game) => game.configured));
const availableGames = sortGames(targets.filter((game) => !game.configured));
- const configuredSteamGames = configuredGames.filter((game) => !game.nonSteam);
- const configuredNonSteamGames = configuredGames.filter((game) => game.nonSteam);
- const availableSteamGames = availableGames.filter((game) => !game.nonSteam);
- const availableNonSteamGames = availableGames.filter((game) => game.nonSteam);
- const [configuredCollapsed, toggleConfigured] = usePersistentCollapsed(CONFIGURED_COLLAPSED_KEY);
- const [configuredNonSteamCollapsed, toggleConfiguredNonSteam] = usePersistentCollapsed(`${CONFIGURED_COLLAPSED_KEY}-non-steam`);
+ const [enabledCollapsed, toggleEnabled] = usePersistentCollapsed(ENABLED_COLLAPSED_KEY);
const [availableCollapsed, toggleAvailable] = usePersistentCollapsed(AVAILABLE_COLLAPSED_KEY);
- const [availableNonSteamCollapsed, toggleAvailableNonSteam] = usePersistentCollapsed(`${AVAILABLE_COLLAPSED_KEY}-non-steam`);
- const configuredToggleRef = useRef(null);
+ const enabledToggleRef = useRef(null);
useEffect(() => {
if (!focusConfiguredToggle) return;
const frame = requestAnimationFrame(() => {
- configuredToggleRef.current?.querySelector('[role="button"], button')?.focus();
+ enabledToggleRef.current?.querySelector('[role="button"], button')?.focus();
onConfiguredToggleFocused?.();
});
return () => cancelAnimationFrame(frame);
- }, [configuredGames.length, focusConfiguredToggle, onConfiguredToggleFocused]);
+ }, [enabledGames.length, focusConfiguredToggle, onConfiguredToggleFocused]);
const confirmResetAll = () => {
showModal(
@@ -137,79 +130,29 @@ export function GameConfigurationSelector({
/>,
);
};
- const confirmEnableAll = () => {
- showModal(
- void onEnableAll()}
- onCancel={() => {}}
- />,
- );
- };
return (
<>
-
{targets.length === 0 && (
)}
-
- Enable all available games
-
-
- )}
Promise;
+ onConfigChange: (
+ fieldName: keyof ConfigurationData,
+ value: boolean | number | string | string[],
+ ) => Promise;
+ onEnable: (appid: string) => Promise;
+ onRepair: (appid: string) => Promise;
}
-export function NowPlayingTab({ game, config, onConfigChange }: Props) {
+function targetDescription(game: GameTarget): string {
+ if (game.transport.kind === "flatpak") return "Non-Steam · Flatpak";
+ return game.nonSteam ? "Non-Steam" : "Steam";
+}
+
+export function NowPlayingTab({
+ game,
+ config,
+ onConfigChange,
+ onEnable,
+ onRepair,
+}: Props) {
+ const [busy, setBusy] = useState(false);
+ const supportNeedsRepair =
+ game.configured &&
+ game.transport.kind === "flatpak" &&
+ game.flatpakSupport?.support_status !== "ready";
+
+ const handleEnable = async () => {
+ if (busy) return;
+ setBusy(true);
+ try {
+ await onEnable(game.appid);
+ } finally {
+ setBusy(false);
+ }
+ };
+
+ const handleRepair = async () => {
+ if (busy) return;
+ setBusy(true);
+ try {
+ await onRepair(game.appid);
+ } finally {
+ setBusy(false);
+ }
+ };
+
return (
-
+
-
-
+
+
+
+ void handleEnable()}>
+ {busy ? "Enabling..." : "Enable LSFG-VK"}
+
+
+
+ )}
+ {game.configured && supportNeedsRepair && (
+
+
+
+
+ void handleRepair()}>
+ {busy ? "Repairing..." : "Repair Flatpak support"}
+
+
+
+ )}
+ {game.configured && (
+
);
}
diff --git a/src/components/SetupTab.tsx b/src/components/SetupTab.tsx
index 98d6e78..9c854e1 100644
--- a/src/components/SetupTab.tsx
+++ b/src/components/SetupTab.tsx
@@ -1,5 +1,11 @@
-import { PanelSection } from "@decky/ui";
-import type { SteamBranchStatus } from "../api/lsfgApi";
+import { ButtonItem, ConfirmModal, Field, PanelSection, PanelSectionRow, showModal } from "@decky/ui";
+import { useEffect, useState } from "react";
+import {
+ getFlatpakSupportStatus,
+ removePluginOwnedFlatpakExtensions,
+ type FlatpakExtensionStatus,
+ type SteamBranchStatus,
+} from "../api/lsfgApi";
import { InstallationButton } from "./InstallationButton";
import { StatusDisplay } from "./StatusDisplay";
@@ -13,6 +19,104 @@ interface SetupTabProps {
isUninstalling: boolean;
onInstall: () => void;
onUninstall: () => void;
+ flatpakRelevant: boolean;
+}
+
+function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
+ const [status, setStatus] = useState(null);
+ const [advanced, setAdvanced] = useState(false);
+ const [busy, setBusy] = useState(false);
+
+ const refresh = async () => {
+ try {
+ setStatus(await getFlatpakSupportStatus());
+ } catch (error) {
+ setStatus({
+ success: false,
+ message: "",
+ error: String(error),
+ available: false,
+ extension_id: "",
+ supported_branches: [],
+ installed_branches: [],
+ owned_branches: [],
+ ownership_uncertain: false,
+ });
+ }
+ };
+
+ useEffect(() => {
+ if (relevant) void refresh();
+ }, [relevant]);
+
+ if (!relevant || !status?.available) return null;
+
+ const confirmCleanup = () => {
+ showModal(
+ {
+ setBusy(true);
+ try {
+ await removePluginOwnedFlatpakExtensions();
+ await refresh();
+ } finally {
+ setBusy(false);
+ }
+ }}
+ onCancel={() => {}}
+ />,
+ );
+ };
+
+ return (
+
+
+
+
+ setAdvanced((value) => !value)}>
+ {advanced ? "Hide runtime details" : "Show runtime details"}
+
+
+ {advanced && (
+ <>
+ {status.supported_branches.map((branch) => (
+
+
+ ))}
+ {status.ownership_uncertain && (
+
+
+ )}
+
+
+ {busy ? "Removing..." : "Remove plugin-installed extensions"}
+
+
+
+ )}
+
+ );
}
export function SetupTab({
@@ -25,22 +129,26 @@ export function SetupTab({
isUninstalling,
onInstall,
onUninstall,
+ flatpakRelevant,
}: SetupTabProps) {
return (
-
-
+ <>
+
+
+ ;
}
@@ -79,9 +81,9 @@ function usePersistentCollapsed() {
return [collapsed, () => setCollapsed((value) => !value)] as const;
}
-export function WorkaroundsSection({ appId, nonSteam, onRepair }: WorkaroundsSectionProps) {
+export function WorkaroundsSection({ appId, nonSteam, transport, onRepair }: WorkaroundsSectionProps) {
const [collapsed, toggleCollapsed] = usePersistentCollapsed();
- const { status, snapshot, refresh, update, error } = usePerAppWorkarounds(appId, nonSteam);
+ const { status, snapshot, refresh, update, error } = usePerAppWorkarounds(appId, nonSteam, transport);
const [repairing, setRepairing] = useState(false);
const state = snapshot?.state;
const controlsDisabled = status !== "ready" || state === undefined || snapshot?.wrapperOwned !== true || snapshot.integrationInstalled !== true;
diff --git a/src/components/index.ts b/src/components/index.ts
index 37a8edb..7c3ee0a 100644
--- a/src/components/index.ts
+++ b/src/components/index.ts
@@ -5,8 +5,6 @@ export { ConfigurationSection } from "./ConfigurationSection";
export { FpsMultiplierControl } from "./FpsMultiplierControl";
export { ConfigurationTab } from "./ConfigurationTab";
export { SetupTab } from "./SetupTab";
-export { ConfigFileTab } from "./ConfigFileTab";
-export { FlatpaksTab } from "./FlatpaksTab";
export { GameConfigurationSelector } from "./GameConfigurationSelector";
export { GameConfigurationControls } from "./GameConfigurationControls";
export { NowPlayingTab } from "./NowPlayingTab";
diff --git a/src/hooks/useGameConfiguration.ts b/src/hooks/useGameConfiguration.ts
index c66596a..b59d592 100644
--- a/src/hooks/useGameConfiguration.ts
+++ b/src/hooks/useGameConfiguration.ts
@@ -1,7 +1,7 @@
import { useCallback, useEffect, useMemo, useRef, useState } from "react";
import { useQuickAccessVisible } from "@decky/api";
import { Router } from "@decky/ui";
-import { getGameConfigs, getInstalledGames, getWorkaroundState, removeWorkaroundState, resetGameConfig, resetAllGameConfigs, setWorkaroundState, updateGameConfig, type GameConfigEntry, type GlobalConfig, type InstalledGame, type WorkaroundState } from "../api/lsfgApi";
+import { ensureFlatpakSupport, getGameConfigs, getInstalledGames, getWorkaroundState, removeWorkaroundState, repairFlatpakSupport, resetGameConfig, resetAllGameConfigs, setWorkaroundState, updateGameConfig, type GameConfigEntry, type GlobalConfig, type InstalledGame, type WorkaroundState } from "../api/lsfgApi";
import { ConfigurationData, getDefaults } from "../config/configSchema";
import { cleanupLegacySteamLaunchOptions, getDefaultWrapperPath, hasWrapperLaunchIntegration, installWrapperIntegration, isLegacyWrapperToken, readSteamLaunchOptions, removeWrapperIntegration } from "../utils/steamLaunchOptions";
import { showErrorToast } from "../utils/toastUtils";
@@ -19,7 +19,12 @@ async function getSteamShortcuts(): Promise {
const appid = Number(shortcut?.appid);
const name = shortcut?.data?.strAppName;
if (!Number.isInteger(appid) || appid === 0 || typeof name !== "string" || !name) return [];
- return [{ appid: String(appid >>> 0), name, nonSteam: true }];
+ return [{
+ appid: String(appid >>> 0),
+ name,
+ nonSteam: true,
+ transport: { kind: "host" },
+ }];
});
} catch {
return [];
@@ -28,7 +33,10 @@ async function getSteamShortcuts(): Promise {
function mergeInstalledGames(backendGames: InstalledGame[], shortcutGames: InstalledGame[]) {
const games = new Map(backendGames.map((game) => [game.appid, game]));
- for (const game of shortcutGames) games.set(game.appid, game);
+ for (const game of shortcutGames) {
+ const existing = games.get(game.appid);
+ games.set(game.appid, existing ? { ...existing, name: game.name, nonSteam: true } : game);
+ }
return Array.from(games.values());
}
@@ -82,7 +90,7 @@ export function useGameConfiguration() {
const name = app.display_name || installed?.name;
if (!name) return setRunningGame(null);
setRunningGame((current) => current?.appid === appid ? current : {
- ...(installed || { appid, name, nonSteam: false }),
+ ...(installed || { appid, name, nonSteam: false, transport: { kind: "host" } }),
name,
configured: games.some((game) => game.appid === appid),
});
@@ -101,13 +109,26 @@ export function useGameConfiguration() {
const targets = useMemo(() => {
const configured = installedGames.map((game) => ({ ...game, configured: games.some((item) => item.appid === game.appid) }));
- for (const game of games) if (!configured.some((item) => item.appid === game.appid)) configured.push({ appid: game.appid, name: game.profile, nonSteam: false, configured: true });
+ for (const game of games) if (!configured.some((item) => item.appid === game.appid)) configured.push({ appid: game.appid, name: game.profile, nonSteam: false, transport: { kind: "host" }, configured: true });
if (runningGame && !configured.some((game) => game.appid === runningGame.appid)) configured.unshift(runningGame);
return configured;
}, [games, installedGames, runningGame]);
const template = useMemo(() => ({ ...getDefaults(), ...globalConfig }), [globalConfig]);
const config = games.find((game) => game.appid === selectedAppId)?.config || template;
+ const ensureTargetFlatpakSupport = useCallback(async (target: GameTarget): Promise => {
+ if (target.transport.kind !== "flatpak") return true;
+ const result = await ensureFlatpakSupport(target.transport.flatpakAppId);
+ if (!result.success || result.support_status !== "ready") {
+ showErrorToast(
+ "Flatpak support unavailable",
+ result.error || result.message || "The required Flatpak runtime extension is not ready",
+ );
+ return false;
+ }
+ return true;
+ }, []);
+
const ensureTargetWorkarounds = useCallback(async (target: GameTarget): Promise => {
if (!installedGames.some((game) => game.appid === target.appid)) return true;
const appId = Number(target.appid);
@@ -119,6 +140,7 @@ export function useGameConfiguration() {
const oldState = existing.state;
const oldShortcutExe = existing.shortcut_exe || undefined;
const oldCommandTokenAdded = existing.command_token_added === true;
+ const oldTransport = existing.transport || target.transport;
if (target.nonSteam && oldState && current.target === wrapperPath && !oldShortcutExe) {
throw new Error("Managed shortcut Target has no saved original executable");
}
@@ -138,6 +160,7 @@ export function useGameConfiguration() {
state,
originalExecutable || null,
oldCommandTokenAdded,
+ target.transport,
);
if (!initialStateResult.success) throw new Error(initialStateResult.error || "Could not create workaround state");
@@ -149,6 +172,7 @@ export function useGameConfiguration() {
state,
target.nonSteam ? (integration.originalExecutable || originalExecutable || null) : null,
integration.commandTokenAdded,
+ target.transport,
);
if (!finalStateResult.success) throw new Error(finalStateResult.error || "Could not finalize workaround state");
return true;
@@ -170,7 +194,13 @@ export function useGameConfiguration() {
}
if (rollbackSucceeded) {
const restored = oldState
- ? await setWorkaroundState(target.appid, oldState, oldShortcutExe || null, oldCommandTokenAdded)
+ ? await setWorkaroundState(
+ target.appid,
+ oldState,
+ oldShortcutExe || null,
+ oldCommandTokenAdded,
+ oldTransport,
+ )
: await removeWorkaroundState(target.appid);
if (!restored.success) throw new Error(restored.error || "Could not roll back workaround state");
}
@@ -227,30 +257,30 @@ export function useGameConfiguration() {
const enable = useCallback(async (appid: string) => {
const target = targets.find((item) => item.appid === appid);
if (!target?.name) return false;
+ if (!(await ensureTargetFlatpakSupport(target))) return false;
if (!(await ensureTargetWorkarounds(target))) return false;
const result = await updateGameConfig(appid, target.name, template);
if (result.success) await load();
else await removeTargetWorkarounds(target);
return result.success;
- }, [ensureTargetWorkarounds, load, removeTargetWorkarounds, targets, template]);
- const enableAll = useCallback(async (): Promise => {
- const available = targets.filter((target) => !target.configured && target.name);
- if (available.length === 0) return;
- for (const target of available) {
- if (!(await ensureTargetWorkarounds(target))) return;
- const result = await updateGameConfig(target.appid, target.name, template);
- if (!result.success) {
- showErrorToast("Could not enable all games", result.error || "A game profile could not be created");
- await removeTargetWorkarounds(target);
- return;
- }
- }
- await load();
- }, [ensureTargetWorkarounds, load, removeTargetWorkarounds, targets, template]);
+ }, [ensureTargetFlatpakSupport, ensureTargetWorkarounds, load, removeTargetWorkarounds, targets, template]);
const repair = useCallback(async (appid: string): Promise => {
const target = targets.find((item) => item.appid === appid);
- return target ? ensureTargetWorkarounds(target) : false;
- }, [ensureTargetWorkarounds, targets]);
+ if (!target) return false;
+ if (target.transport.kind === "flatpak") {
+ const support = await repairFlatpakSupport(target.transport.flatpakAppId);
+ if (!support.success || support.support_status !== "ready") {
+ showErrorToast(
+ "Flatpak support unavailable",
+ support.error || support.message || "The required Flatpak runtime extension is not ready",
+ );
+ return false;
+ }
+ }
+ const success = await ensureTargetWorkarounds(target);
+ if (success) await load();
+ return success;
+ }, [ensureTargetWorkarounds, load, targets]);
const resetSelected = useCallback(async () => {
if (selectedAppId) {
@@ -276,5 +306,5 @@ export function useGameConfiguration() {
}
}, [load, removeTargetWorkarounds, targets]);
- return { config, games, targets, runningGame, selectedAppId, setSelectedAppId, save, enable, enableAll, repair, resetSelected, resetAll, reload: load };
+ return { config, games, targets, runningGame, selectedAppId, setSelectedAppId, save, enable, repair, resetSelected, resetAll, reload: load };
}
diff --git a/src/hooks/usePerAppWorkarounds.ts b/src/hooks/usePerAppWorkarounds.ts
index 9e283db..c7413b0 100644
--- a/src/hooks/usePerAppWorkarounds.ts
+++ b/src/hooks/usePerAppWorkarounds.ts
@@ -3,6 +3,7 @@ import {
getWorkaroundState,
removeWorkaroundState,
setWorkaroundState,
+ type TargetTransport,
type WorkaroundState,
} from "../api/lsfgApi";
import {
@@ -45,6 +46,7 @@ export interface WorkaroundSnapshot {
integrationInstalled: boolean;
commandTokenAdded: boolean;
shortcutExe?: string | null;
+ transport: TargetTransport;
}
interface PerAppWorkarounds {
@@ -85,12 +87,14 @@ function makeSnapshot(
integrationInstalled: integrationIsInstalled(steam, nonSteam, wrapperPath),
commandTokenAdded: result.command_token_added === true,
shortcutExe: result.shortcut_exe,
+ transport: result.transport || { kind: "host" },
};
}
async function adoptWorkaroundState(
appId: string,
nonSteam: boolean,
+ transport: TargetTransport,
steam: SteamLaunchOptionsSnapshot,
wrapperPath: string,
): Promise {
@@ -98,7 +102,13 @@ async function adoptWorkaroundState(
throw new Error("Shortcut Target is a wrapper but its original Target is unknown");
}
const originalExecutable = nonSteam ? steam.target : null;
- const initial = await setWorkaroundState(appId, DEFAULT_WORKAROUND_STATE, originalExecutable, false);
+ const initial = await setWorkaroundState(
+ appId,
+ DEFAULT_WORKAROUND_STATE,
+ originalExecutable,
+ false,
+ transport,
+ );
if (!initial.success) throw new Error(initial.error || "Could not create workaround state");
let integration: Awaited> | null = null;
try {
@@ -112,6 +122,7 @@ async function adoptWorkaroundState(
DEFAULT_WORKAROUND_STATE,
nonSteam ? (integration.originalExecutable || originalExecutable) : null,
integration.commandTokenAdded,
+ transport,
);
if (!finalized.success) throw new Error(finalized.error || "Could not finalize workaround state");
return makeSnapshot(integration.snapshot, finalized, nonSteam);
@@ -139,7 +150,11 @@ async function adoptWorkaroundState(
}
}
-export function usePerAppWorkarounds(appId: string, nonSteam: boolean): PerAppWorkarounds {
+export function usePerAppWorkarounds(
+ appId: string,
+ nonSteam: boolean,
+ transport: TargetTransport = { kind: "host" },
+): PerAppWorkarounds {
const [status, setStatus] = useState("loading");
const [snapshot, setSnapshot] = useState(null);
const [error, setError] = useState(null);
@@ -156,12 +171,13 @@ export function usePerAppWorkarounds(appId: string, nonSteam: boolean): PerAppWo
return adoptWorkaroundState(
appId,
nonSteam,
+ transport,
steam,
result.wrapper_path || getDefaultWrapperPath(),
);
}
return makeSnapshot(steam, result, nonSteam);
- }, [appId, nonSteam, numericAppId]);
+ }, [appId, nonSteam, numericAppId, transport]);
const applySnapshot = useCallback((next: WorkaroundSnapshot) => {
setSnapshot(next);
@@ -236,6 +252,7 @@ export function usePerAppWorkarounds(appId: string, nonSteam: boolean): PerAppWo
nextState,
current.shortcutExe ?? null,
current.commandTokenAdded,
+ current.transport,
);
if (!result.success || !result.state) throw new Error(result.error || "Could not save workaround state");
applySnapshot({
@@ -245,6 +262,7 @@ export function usePerAppWorkarounds(appId: string, nonSteam: boolean): PerAppWo
wrapperOwned: result.wrapper_owned === true,
shortcutExe: result.shortcut_exe,
commandTokenAdded: result.command_token_added === true,
+ transport: result.transport || current.transport,
});
return true;
} catch (updateError) {
diff --git a/src/types.d.ts b/src/types.d.ts
index 7b5d055..df433e0 100644
--- a/src/types.d.ts
+++ b/src/types.d.ts
@@ -17,6 +17,7 @@ interface SteamAppDetails {
strLaunchOptions?: string;
strShortcutLaunchOptions?: string;
strShortcutExe?: string;
+ strShortcutStartDir?: string;
}
interface SteamAppDetailsRegistration {
diff --git a/tests/test_flatpak_overrides.py b/tests/test_flatpak_overrides.py
deleted file mode 100644
index ed3ef6a..0000000
--- a/tests/test_flatpak_overrides.py
+++ /dev/null
@@ -1,158 +0,0 @@
-import sys
-import tempfile
-import types
-import unittest
-from pathlib import Path
-from unittest.mock import Mock
-
-
-sys.modules.setdefault(
- "decky",
- types.SimpleNamespace(DECKY_USER_HOME="/home/deck", logger=Mock()),
-)
-sys.modules.setdefault("tomllib", types.SimpleNamespace(loads=Mock()))
-sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "py_modules"))
-
-from lsfg_vk.flatpak_service import FlatpakService
-
-
-class FlatpakOverrideTests(unittest.TestCase):
- def setUp(self):
- self.tempdir = tempfile.TemporaryDirectory()
- home = Path(self.tempdir.name) / "home" / "deck"
- home.mkdir(parents=True)
- self.service = FlatpakService()
- self.service.user_home = home
- self.service.config_dir = home / ".config/lsfg-vk"
- self.service.config_file_path = self.service.config_dir / "conf.toml"
- self.service.legacy_script_path = home / "lsfg"
- self.service.check_flatpak_available = Mock(return_value=True)
- self.service._run_flatpak_command = Mock(
- return_value=types.SimpleNamespace(returncode=0, stderr="", stdout="")
- )
- self.app_id = "com.example.Game"
- self.override_path = self.service._override_file_path(self.app_id)
-
- def tearDown(self):
- self.tempdir.cleanup()
- sys.modules.pop("lsfg_vk.plugin", None)
- sys.modules.pop("lsfg_vk", None)
-
- def _paths(self):
- return self.service._override_paths()
-
- def _write_override(self, content):
- self.override_path.parent.mkdir(parents=True, exist_ok=True)
- self.override_path.write_text(content, encoding="utf-8")
-
- def _show_response(self, content):
- return types.SimpleNamespace(returncode=0, stderr="", stdout=content)
-
- def test_set_cleans_legacy_entries_and_verifies_readback(self):
- paths = self._paths()
- self._write_override(
- "[Context]\n"
- f"filesystems=/home/deck/keep;{paths['config_dir']}:rw;!{paths['legacy_home']};"
- f"{paths['legacy_script']};{paths['legacy_dll']}:ro;{paths['dll_dir']}:ro;\n"
- "unset-environment=KEEP_UNSET;LSFG_CONFIG;\n\n"
- "[Environment]\n"
- "KEEP_ENV=1\n"
- "LSFG_CONFIG=\n"
- "LSFGVK_CONFIG=old\n"
- "ENABLE_GAMESCOPE_WSI=1\n"
- "DXVK_HDR=1\n"
- )
- expected = (
- "[Context]\n"
- f"filesystems={paths['config_dir']}:rw;{paths['dll_dir']}:ro\n"
- "[Environment]\n"
- f"LSFGVK_CONFIG={paths['config_file']}\n"
- "ENABLE_GAMESCOPE_WSI=0\n"
- "DXVK_HDR=0\n"
- )
- self.service._run_flatpak_command.side_effect = [
- self._show_response(""),
- self._show_response(expected),
- ]
-
- response = self.service.set_app_override(self.app_id)
- command_args = self.service._run_flatpak_command.call_args_list[0].args[0]
- cleaned = self.override_path.read_text(encoding="utf-8")
-
- self.assertTrue(response["success"])
- self.assertIn("--env=ENABLE_GAMESCOPE_WSI=0", command_args)
- self.assertIn("--env=DXVK_HDR=0", command_args)
- self.assertNotIn("--nofilesystem=/home/deck", command_args)
- self.assertNotIn("--unset-env=LSFG_CONFIG", command_args)
- self.assertIn("/home/deck/keep", cleaned)
- self.assertIn("KEEP_ENV=1", cleaned)
- self.assertNotIn("LSFG_CONFIG", cleaned)
- self.assertNotIn(paths["legacy_home"], cleaned)
-
- def test_set_reports_failed_readback(self):
- paths = self._paths()
- self.service._run_flatpak_command.side_effect = [
- self._show_response(""),
- self._show_response(
- f"[Context]\nfilesystems={paths['config_dir']};{paths['dll_dir']}\n"
- f"[Environment]\nLSFGVK_CONFIG={paths['config_file']}\n"
- ),
- ]
-
- response = self.service.set_app_override(self.app_id)
-
- self.assertFalse(response["success"])
- self.assertIn("verified", response["error"])
-
- def test_remove_cleans_known_entries_preserves_unrelated_and_verifies(self):
- paths = self._paths()
- self._write_override(
- "[Context]\n"
- f"filesystems=/home/deck/keep;{paths['config_dir']};!{paths['legacy_home']};"
- f"{paths['legacy_dll']};{paths['legacy_script']}\n"
- "unset-environment=KEEP_UNSET;LSFG_CONFIG;ENABLE_GAMESCOPE_WSI\n\n"
- "[Environment]\n"
- "KEEP_ENV=1\n"
- "LSFGVK_CONFIG=/old/path\n"
- "DXVK_HDR=0\n"
- )
- self.service._run_flatpak_command.side_effect = [
- self._show_response(
- "[Context]\nfilesystems=/home/deck/keep\n"
- "[Environment]\nKEEP_ENV=1\n"
- )
- ]
-
- response = self.service.remove_app_override(self.app_id)
- cleaned = self.override_path.read_text(encoding="utf-8")
-
- self.assertTrue(response["success"])
- self.assertEqual(self.service._run_flatpak_command.call_count, 1)
- self.assertIn("/home/deck/keep", cleaned)
- self.assertIn("KEEP_UNSET", cleaned)
- self.assertIn("KEEP_ENV", cleaned)
- for name in ("LSFGVK_CONFIG", "LSFG_CONFIG", "ENABLE_GAMESCOPE_WSI", "DXVK_HDR"):
- self.assertNotIn(name, cleaned)
- for path in paths.values():
- if path != paths["config_file"]:
- self.assertNotIn(path, cleaned)
-
- def test_remove_reports_failed_readback(self):
- self._write_override("[Context]\nfilesystems=/home/deck/keep\n")
- paths = self._paths()
- self.service._run_flatpak_command.side_effect = [
- self._show_response(
- f"[Context]\nfilesystems={paths['config_dir']};{paths['dll_dir']}\n"
- f"[Environment]\nLSFGVK_CONFIG={paths['config_file']}\n"
- "ENABLE_GAMESCOPE_WSI=0\nDXVK_HDR=0\n"
- )
- ]
-
- response = self.service.remove_app_override(self.app_id)
-
- self.assertFalse(response["success"])
- self.assertIn("verified", response["error"])
-
-
-if __name__ == "__main__":
- unittest.main()
diff --git a/tests/test_flatpak_service.py b/tests/test_flatpak_service.py
new file mode 100644
index 0000000..38dfcb5
--- /dev/null
+++ b/tests/test_flatpak_service.py
@@ -0,0 +1,231 @@
+import json
+import sys
+import tempfile
+import types
+import unittest
+from pathlib import Path
+from unittest.mock import Mock
+
+
+sys.modules.setdefault(
+ "decky",
+ types.SimpleNamespace(DECKY_USER_HOME="/home/deck", logger=Mock()),
+)
+sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "py_modules"))
+
+from lsfg_vk.flatpak_service import FlatpakService
+
+
+class FlatpakServiceTests(unittest.TestCase):
+ def setUp(self):
+ self.tempdir = tempfile.TemporaryDirectory()
+ self.home = Path(self.tempdir.name) / "home" / "deck"
+ self.home.mkdir(parents=True)
+ self.service = FlatpakService()
+ self.service.user_home = self.home
+ self.service.config_dir = self.home / ".config/lsfg-vk"
+ self.service.config_file_path = self.service.config_dir / "conf.toml"
+ self.service.check_flatpak_available = Mock(return_value=True)
+ self.service._run_flatpak_command = Mock()
+ self.bundle = self.home / "lsfg-vk-24.08.flatpak"
+ self.bundle.write_bytes(b"bundle")
+ self.service._bundled_extension_path = Mock(return_value=self.bundle)
+
+ def tearDown(self):
+ self.tempdir.cleanup()
+
+ @staticmethod
+ def _result(stdout="", returncode=0, stderr=""):
+ return types.SimpleNamespace(stdout=stdout, returncode=returncode, stderr=stderr)
+
+ @staticmethod
+ def _extension_line(branch):
+ return f"org.freedesktop.Platform.VulkanLayer.lsfgvk\tx86_64\t{branch}\n"
+
+ def test_runtime_branch_mapping_is_strict_and_branch_specific(self):
+ self.assertEqual(
+ FlatpakService.runtime_branch_from_ref(
+ "org.freedesktop.Platform/x86_64/24.08"
+ ),
+ "24.08",
+ )
+ self.assertEqual(
+ FlatpakService.runtime_branch_from_ref(
+ "org.freedesktop.Platform//25.08"
+ ),
+ "25.08",
+ )
+ with self.assertRaises(ValueError):
+ FlatpakService.runtime_branch_from_ref("org.gnome.Sdk/x86_64/46")
+ with self.assertRaises(ValueError):
+ FlatpakService.runtime_branch_from_ref(
+ "org.freedesktop.Platform/x86_64/26.08"
+ )
+
+ def test_resolve_reads_required_runtime_instead_of_any_installed_branch(self):
+ self.service._run_flatpak_command.side_effect = [
+ self._result("org.freedesktop.Platform/x86_64/24.08\n"),
+ self._result(self._extension_line("23.08")),
+ ]
+
+ response = self.service.resolve_app_support("com.example.Game")
+
+ self.assertTrue(response["success"])
+ self.assertEqual(response["runtime_branch"], "24.08")
+ self.assertEqual(response["support_status"], "needs-runtime")
+ self.assertFalse(response["extension_installed"])
+ self.assertEqual(
+ self.service._run_flatpak_command.call_args_list[0].args[0],
+ ["info", "--show-runtime", "com.example.Game"],
+ )
+ self.assertEqual(
+ self.service._run_flatpak_command.call_args_list[1].args[0],
+ ["list", "--runtime", "--columns=application,arch,branch"],
+ )
+
+ def test_install_records_only_a_new_user_owned_branch(self):
+ self.service._run_flatpak_command.side_effect = [
+ self._result(""),
+ self._result(""),
+ self._result(self._extension_line("24.08")),
+ ]
+
+ response = self.service.install_extension("24.08")
+
+ self.assertTrue(response["success"])
+ self.assertTrue(response["owned_by_plugin"])
+ install_args = self.service._run_flatpak_command.call_args_list[1].args[0]
+ self.assertEqual(install_args[:4], ["install", "--user", "--noninteractive", "--or-update"])
+ self.assertEqual(
+ json.loads(self.service.ownership_path.read_text(encoding="utf-8")),
+ {"version": 1, "plugin_owned_branches": ["24.08"]},
+ )
+
+ def test_preexisting_branch_is_not_claimed_or_removed(self):
+ self.service._run_flatpak_command.return_value = self._result(
+ self._extension_line("24.08")
+ )
+
+ install_response = self.service.install_extension("24.08")
+ cleanup_response = self.service.remove_plugin_owned_extensions()
+
+ self.assertTrue(install_response["success"])
+ self.assertFalse(install_response["owned_by_plugin"])
+ self.assertFalse(self.service.ownership_path.exists())
+ self.assertTrue(cleanup_response["success"])
+ self.assertEqual(self.service._run_flatpak_command.call_count, 1)
+
+ def test_corrupt_ownership_metadata_fails_closed(self):
+ self.service.ownership_path.parent.mkdir(parents=True, exist_ok=True)
+ self.service.ownership_path.write_text("{not-json", encoding="utf-8")
+
+ response = self.service.remove_plugin_owned_extensions()
+
+ self.assertFalse(response["success"])
+ self.assertTrue(response["ownership_uncertain"])
+ self.assertEqual(self.service._run_flatpak_command.call_count, 0)
+
+ def test_dangling_ownership_symlink_fails_closed(self):
+ self.service.ownership_path.parent.mkdir(parents=True, exist_ok=True)
+ self.service.ownership_path.symlink_to(self.home / "missing-metadata")
+
+ response = self.service.remove_plugin_owned_extensions()
+
+ self.assertFalse(response["success"])
+ self.assertTrue(response["ownership_uncertain"])
+ self.assertEqual(self.service._run_flatpak_command.call_count, 0)
+
+ def test_ensure_app_support_installs_only_the_app_runtime_branch(self):
+ self.service._run_flatpak_command.side_effect = [
+ self._result("org.freedesktop.Platform/x86_64/24.08\n"),
+ self._result(""),
+ self._result(""),
+ self._result(""),
+ self._result(""),
+ self._result(self._extension_line("24.08")),
+ self._result("org.freedesktop.Platform/x86_64/24.08\n"),
+ self._result(self._extension_line("24.08")),
+ ]
+
+ response = self.service.ensure_app_support("com.example.Game")
+
+ self.assertTrue(response["success"])
+ self.assertEqual(response["support_status"], "ready")
+ self.assertEqual(response["runtime_branch"], "24.08")
+ install_args = self.service._run_flatpak_command.call_args_list[4].args[0]
+ self.assertEqual(install_args[0], "install")
+ self.assertIn("--user", install_args)
+ self.assertNotIn("23.08", install_args)
+ self.assertEqual(
+ json.loads(self.service.ownership_path.read_text(encoding="utf-8")),
+ {"version": 1, "plugin_owned_branches": ["24.08"]},
+ )
+
+ def test_two_shortcuts_using_one_flatpak_share_one_extension_branch(self):
+ self.service._run_flatpak_command.side_effect = [
+ self._result("org.freedesktop.Platform/x86_64/24.08\n"),
+ self._result(""),
+ self._result(""),
+ self._result(""),
+ self._result(""),
+ self._result(self._extension_line("24.08")),
+ self._result("org.freedesktop.Platform/x86_64/24.08\n"),
+ self._result(self._extension_line("24.08")),
+ self._result("org.freedesktop.Platform/x86_64/24.08\n"),
+ self._result(self._extension_line("24.08")),
+ ]
+
+ first = self.service.ensure_app_support("net.pcsx2.PCSX2")
+ second = self.service.ensure_app_support("net.pcsx2.PCSX2.Dev")
+
+ self.assertEqual(first["support_status"], "ready")
+ self.assertEqual(second["support_status"], "ready")
+ install_commands = [
+ call.args[0]
+ for call in self.service._run_flatpak_command.call_args_list
+ if call.args[0][0] == "install"
+ ]
+ self.assertEqual(len(install_commands), 1)
+ self.assertEqual(
+ json.loads(self.service.ownership_path.read_text(encoding="utf-8")),
+ {"version": 1, "plugin_owned_branches": ["24.08"]},
+ )
+
+ def test_cleanup_removes_all_owned_branches_without_reusing_stale_metadata(self):
+ self.service.ownership_path.parent.mkdir(parents=True, exist_ok=True)
+ self.service.ownership_path.write_text(
+ json.dumps({"version": 1, "plugin_owned_branches": ["23.08", "24.08"]}),
+ encoding="utf-8",
+ )
+ self.service._run_flatpak_command.side_effect = [
+ self._result(
+ "\n".join(
+ [
+ "\t".join([FlatpakService.EXTENSION_ID, "x86_64", "23.08"]),
+ "\t".join([FlatpakService.EXTENSION_ID, "x86_64", "24.08"]),
+ ]
+ )
+ + "\n"
+ ),
+ self._result(""),
+ self._result("\t".join([FlatpakService.EXTENSION_ID, "x86_64", "24.08"]) + "\n"),
+ self._result("\t".join([FlatpakService.EXTENSION_ID, "x86_64", "24.08"]) + "\n"),
+ self._result(""),
+ self._result(""),
+ ]
+
+ response = self.service.remove_plugin_owned_extensions()
+
+ self.assertTrue(response["success"])
+ self.assertEqual(response["removed_branches"], ["23.08", "24.08"])
+ self.assertFalse(self.service.ownership_path.exists())
+ uninstall_commands = [
+ call.args[0]
+ for call in self.service._run_flatpak_command.call_args_list
+ if call.args[0][0] == "uninstall"
+ ]
+ self.assertEqual(len(uninstall_commands), 2)
+
+
+if __name__ == "__main__":
+ unittest.main()
diff --git a/tests/test_steam_service.py b/tests/test_steam_service.py
new file mode 100644
index 0000000..849bb01
--- /dev/null
+++ b/tests/test_steam_service.py
@@ -0,0 +1,77 @@
+import sys
+import types
+import unittest
+from pathlib import Path
+from unittest.mock import Mock
+
+
+sys.modules.setdefault(
+ "decky",
+ types.SimpleNamespace(DECKY_USER_HOME="/home/deck", logger=Mock()),
+)
+sys.path.insert(0, str(Path(__file__).resolve().parents[1] / "py_modules"))
+
+from lsfg_vk.steam_service import SteamService, classify_shortcut_transport
+
+
+class SteamTransportTests(unittest.TestCase):
+ def test_only_direct_canonical_flatpak_forms_are_classified(self):
+ self.assertEqual(
+ classify_shortcut_transport(
+ "/usr/bin/flatpak",
+ "run com.example.PCSX2 --fullscreen",
+ ),
+ {"kind": "flatpak", "flatpakAppId": "com.example.PCSX2"},
+ )
+ self.assertEqual(
+ classify_shortcut_transport(
+ "/usr/bin/flatpak run com.example.PCSX2",
+ "--fullscreen",
+ ),
+ {"kind": "flatpak", "flatpakAppId": "com.example.PCSX2"},
+ )
+ self.assertEqual(
+ classify_shortcut_transport(
+ "/usr/bin/bash",
+ "~/launch-game.sh --fullscreen",
+ ),
+ {"kind": "host"},
+ )
+ self.assertEqual(
+ classify_shortcut_transport(
+ "/usr/bin/flatpak",
+ "--user run com.example.PCSX2",
+ ),
+ {"kind": "host"},
+ )
+ self.assertEqual(
+ classify_shortcut_transport(
+ "/usr/bin/flatpak",
+ "run bash ~/launch-game.sh",
+ ),
+ {"kind": "host"},
+ )
+
+ def test_shortcut_data_preserves_transport_inputs(self):
+ game = SteamService._shortcut_game(
+ {
+ "appid": 123456,
+ "AppName": "PCSX2 shortcut",
+ "Exe": "/usr/bin/flatpak",
+ "LaunchOptions": "run net.pcsx2.PCSX2 --fullscreen",
+ "StartDir": "/home/deck/Games",
+ }
+ )
+
+ self.assertEqual(game["appid"], "123456")
+ self.assertEqual(game["transport"], {
+ "kind": "flatpak",
+ "flatpakAppId": "net.pcsx2.PCSX2",
+ })
+ self.assertEqual(game["executable"], "/usr/bin/flatpak")
+ self.assertEqual(game["arguments"], "run net.pcsx2.PCSX2 --fullscreen")
+ self.assertEqual(game["startDir"], "/home/deck/Games")
+
+
+if __name__ == "__main__":
+ unittest.main()
diff --git a/tests/test_wrapper_service.py b/tests/test_wrapper_service.py
index f17a944..5010d23 100644
--- a/tests/test_wrapper_service.py
+++ b/tests/test_wrapper_service.py
@@ -123,10 +123,20 @@ class WrapperServiceTests(unittest.TestCase):
encoding="utf-8",
)
fake_flatpak.chmod(0o755)
- self.service.set("123", self._state(dxvkFrameRate=20, enableZink=True), str(fake_flatpak))
+ self.service.set(
+ "123",
+ self._state(dxvkFrameRate=20, enableZink=True),
+ str(fake_flatpak),
+ False,
+ {"kind": "flatpak", "flatpakAppId": "com.example.Game"},
+ )
result = self._run(123, "run", "com.example.Game", "--windowed", env={"DXVK_CONFIG": "foo=1"})
args = result.stdout.splitlines()
self.assertEqual(args[0], "ARG:run")
+ self.assertIn("ARG:--filesystem=" + str(self.service.config_dir) + ":rw", args)
+ self.assertIn("ARG:--filesystem=" + str(self.home / ".local/share/Steam/steamapps/common/Lossless Scaling") + ":ro", args)
+ self.assertIn("ARG:--env=LSFGVK_CONFIG=" + str(self.service.config_file_path), args)
+ self.assertIn("ARG:--env=LSFGVK_FLATPAK=1", args)
self.assertIn("ARG:--env=SteamAppId=123", args)
self.assertIn("ARG:--env=ENABLE_GAMESCOPE_WSI=0", args)
self.assertIn("ARG:--env=DXVK_HDR=0", args)
@@ -137,6 +147,73 @@ class WrapperServiceTests(unittest.TestCase):
self.assertIn("ARG:com.example.Game", args)
self.assertIn("ARG:--windowed", args)
+ def test_flatpak_full_executable_form_is_preserved(self):
+ fake_flatpak = self.home / ".local/bin/flatpak"
+ fake_flatpak.parent.mkdir(parents=True, exist_ok=True)
+ fake_flatpak.write_text(
+ "#!/bin/sh\n"
+ "printf 'ARG:%s\\n' \"$@\"\n",
+ encoding="utf-8",
+ )
+ fake_flatpak.chmod(0o755)
+ response = self.service.set(
+ "123",
+ self._state(),
+ f"{fake_flatpak} run com.example.Game",
+ False,
+ {"kind": "flatpak", "flatpakAppId": "com.example.Game"},
+ )
+ self.assertTrue(response["success"])
+ result = self._run(123, "--windowed")
+ args = result.stdout.splitlines()
+ self.assertEqual(args[0], "ARG:run")
+ self.assertIn("ARG:com.example.Game", args)
+ self.assertIn("ARG:--windowed", args)
+
+ def test_flatpak_transport_rejects_non_run_invocation(self):
+ fake_flatpak = self.home / ".local/bin/flatpak"
+ fake_flatpak.parent.mkdir(parents=True, exist_ok=True)
+ fake_flatpak.write_text("#!/bin/sh\nexit 0\n", encoding="utf-8")
+ fake_flatpak.chmod(0o755)
+ response = self.service.set(
+ "123",
+ self._state(),
+ str(fake_flatpak),
+ False,
+ {"kind": "flatpak", "flatpakAppId": "com.example.Game"},
+ )
+ self.assertTrue(response["success"])
+ result = subprocess.run(
+ [str(self.service.wrapper_path), "bash", "launch-game.sh"],
+ env={"PATH": "/usr/bin:/bin", "SteamAppId": "123"},
+ capture_output=True,
+ text=True,
+ )
+ self.assertEqual(result.returncode, 64)
+ self.assertIn("direct flatpak run", result.stderr)
+
+ def test_flatpak_transport_rejects_external_app_id_change(self):
+ fake_flatpak = self.home / ".local/bin/flatpak"
+ fake_flatpak.parent.mkdir(parents=True, exist_ok=True)
+ fake_flatpak.write_text("#!/bin/sh\nexit 0\n", encoding="utf-8")
+ fake_flatpak.chmod(0o755)
+ response = self.service.set(
+ "123",
+ self._state(),
+ str(fake_flatpak),
+ False,
+ {"kind": "flatpak", "flatpakAppId": "com.example.Game"},
+ )
+ self.assertTrue(response["success"])
+ result = subprocess.run(
+ [str(self.service.wrapper_path), "run", "com.other.Game"],
+ env={"PATH": "/usr/bin:/bin", "SteamAppId": "123"},
+ capture_output=True,
+ text=True,
+ )
+ self.assertEqual(result.returncode, 64)
+ self.assertIn("application ID changed externally", result.stderr)
+
def test_invalid_state_and_foreign_wrapper_fail_closed(self):
invalid = self.service.set("0", self.service.default_state())
self.assertFalse(invalid["success"])
--
cgit v1.2.3
From fb4d053213bdbda271a54b517a11a89c4780f80a Mon Sep 17 00:00:00 2001
From: xXJSONDeruloXx
Date: Wed, 9 Sep 2026 20:45:20 -0400
Subject: fix: restore profile and Flatpak controls
---
py_modules/lsfg_vk/flatpak_service.py | 56 ++++++++++++++++---
py_modules/lsfg_vk/plugin.py | 3 ++
src/api/lsfgApi.ts | 15 ++++++
src/components/ConfigurationTab.tsx | 3 ++
src/components/Content.tsx | 11 +++-
src/components/GameConfigurationSelector.tsx | 40 ++++++++++++++
src/components/SetupTab.tsx | 81 ++++++++++++++++++++++++----
src/components/index.ts | 1 +
src/hooks/useGameConfiguration.ts | 65 ++++++++++++++++++++--
src/hooks/usePerAppWorkarounds.ts | 24 +++++++--
tests/test_flatpak_service.py | 48 +++++++++++++++++
11 files changed, 320 insertions(+), 27 deletions(-)
diff --git a/py_modules/lsfg_vk/flatpak_service.py b/py_modules/lsfg_vk/flatpak_service.py
index 071b29c..c0a9c0c 100644
--- a/py_modules/lsfg_vk/flatpak_service.py
+++ b/py_modules/lsfg_vk/flatpak_service.py
@@ -299,11 +299,6 @@ class FlatpakService(BaseService):
version = self._validate_runtime(version)
if not self.check_flatpak_available():
raise FileNotFoundError("Flatpak is not available on this system")
- bundle_path = self._bundled_extension_path(version)
- if not bundle_path.is_file():
- raise FileNotFoundError(
- f"Bundled Flatpak extension not found at {bundle_path}; reinstall the plugin"
- )
with self._lock:
owned, uncertain = self._read_owned_branches()
if uncertain:
@@ -318,7 +313,14 @@ class FlatpakService(BaseService):
f"lsfg-vk {version} runtime extension is already installed",
runtime_branch=version,
installed=True,
+ enabled=True,
owned_by_plugin=version in owned,
+ preserved=version not in owned,
+ )
+ bundle_path = self._bundled_extension_path(version)
+ if not bundle_path.is_file():
+ raise FileNotFoundError(
+ f"Bundled Flatpak extension not found at {bundle_path}; reinstall the plugin"
)
result = self._run_flatpak_command(
[
@@ -346,7 +348,9 @@ class FlatpakService(BaseService):
f"lsfg-vk {version} runtime extension installed",
runtime_branch=version,
installed=True,
+ enabled=True,
owned_by_plugin=True,
+ preserved=False,
)
except Exception as error:
return self._error_response(
@@ -354,7 +358,9 @@ class FlatpakService(BaseService):
str(error),
runtime_branch=version,
installed=False,
+ enabled=False,
owned_by_plugin=False,
+ preserved=False,
)
def ensure_extension(self, version: str) -> Dict[str, Any]:
@@ -424,15 +430,29 @@ class FlatpakService(BaseService):
raise RuntimeError(
"Flatpak ownership metadata is uncertain; refusing to uninstall"
)
+ installed = self._installed_extension_branches()
if version not in owned:
+ if version in installed:
+ return self._success_response(
+ dict,
+ f"Preserved Flatpak extension {version}; it is not plugin-owned",
+ runtime_branch=version,
+ removed=False,
+ installed=True,
+ enabled=True,
+ owned_by_plugin=False,
+ preserved=True,
+ )
return self._success_response(
dict,
- f"Preserved Flatpak extension {version}; it is not plugin-owned",
+ f"Flatpak extension {version} is already not installed",
runtime_branch=version,
removed=False,
- preserved=True,
+ installed=False,
+ enabled=False,
+ owned_by_plugin=False,
+ preserved=False,
)
- installed = self._installed_extension_branches()
if version in installed:
result = self._run_flatpak_command(
[
@@ -458,6 +478,9 @@ class FlatpakService(BaseService):
f"Plugin-owned lsfg-vk {version} runtime extension removed",
runtime_branch=version,
removed=True,
+ installed=False,
+ enabled=False,
+ owned_by_plugin=False,
preserved=False,
)
except Exception as error:
@@ -466,8 +489,25 @@ class FlatpakService(BaseService):
str(error),
runtime_branch=version,
removed=False,
+ installed=False,
+ enabled=False,
+ owned_by_plugin=False,
+ preserved=False,
+ )
+
+ def set_extension_enabled(self, version: str, enabled: bool) -> Dict[str, Any]:
+ """Set one runtime branch to the requested state, safely and idempotently."""
+ if type(enabled) is not bool:
+ return self._error_response(
+ dict,
+ "enabled must be a boolean",
+ runtime_branch=version,
+ installed=False,
+ enabled=False,
+ owned_by_plugin=False,
preserved=False,
)
+ return self.install_extension(version) if enabled else self.uninstall_extension(version)
def remove_plugin_owned_extensions(self) -> Dict[str, Any]:
"""Uninstall only branches recorded as installed by this plugin."""
diff --git a/py_modules/lsfg_vk/plugin.py b/py_modules/lsfg_vk/plugin.py
index cb2d3df..76a4250 100644
--- a/py_modules/lsfg_vk/plugin.py
+++ b/py_modules/lsfg_vk/plugin.py
@@ -160,6 +160,9 @@ class Plugin:
async def repair_flatpak_support(self, flatpak_app_id: str) -> Dict[str, Any]:
return self.flatpak_service.ensure_app_support(flatpak_app_id)
+ async def set_flatpak_extension_enabled(self, version: str, enabled: bool) -> Dict[str, Any]:
+ return self.flatpak_service.set_extension_enabled(version, enabled)
+
async def remove_plugin_owned_flatpak_extensions(self) -> Dict[str, Any]:
return self.flatpak_service.remove_plugin_owned_extensions()
diff --git a/src/api/lsfgApi.ts b/src/api/lsfgApi.ts
index f487dff..16b6eab 100644
--- a/src/api/lsfgApi.ts
+++ b/src/api/lsfgApi.ts
@@ -137,6 +137,17 @@ export interface FlatpakCleanupResult {
ownership_uncertain: boolean;
}
+export interface FlatpakExtensionToggleResult {
+ success: boolean;
+ message: string;
+ error?: string | null;
+ runtime_branch: string;
+ enabled: boolean;
+ installed: boolean;
+ owned_by_plugin: boolean;
+ preserved: boolean;
+}
+
// API functions
export const installLsfgVk = callable<[], InstallationResult>("install_lsfg_vk");
export const uninstallLsfgVk = callable<[], InstallationResult>("uninstall_lsfg_vk");
@@ -147,6 +158,10 @@ export const getConfigFileContent = callable<[], FileContentResult>("get_config_
export const getFlatpakSupportStatus = callable<[], FlatpakExtensionStatus>("get_flatpak_support_status");
export const ensureFlatpakSupport = callable<[string], FlatpakTargetSupport>("ensure_flatpak_support");
export const repairFlatpakSupport = callable<[string], FlatpakTargetSupport>("repair_flatpak_support");
+export const setFlatpakExtensionEnabled = callable<
+ [string, boolean],
+ FlatpakExtensionToggleResult
+>("set_flatpak_extension_enabled");
export const removePluginOwnedFlatpakExtensions = callable<
[],
FlatpakCleanupResult
diff --git a/src/components/ConfigurationTab.tsx b/src/components/ConfigurationTab.tsx
index 90c1a7b..8f8690c 100644
--- a/src/components/ConfigurationTab.tsx
+++ b/src/components/ConfigurationTab.tsx
@@ -14,6 +14,7 @@ interface ConfigurationTabProps {
onSelect: (appid: string) => void;
onConfigChange: (fieldName: keyof ConfigurationData, value: boolean | number | string | string[]) => Promise;
onEnable: (appid: string) => Promise;
+ onEnableAll: () => Promise;
onRepair: (appid: string) => Promise;
onReset: () => Promise;
onResetAll: () => Promise;
@@ -26,6 +27,7 @@ export function ConfigurationTab({
onSelect,
onConfigChange,
onEnable,
+ onEnableAll,
onRepair,
onReset,
onResetAll,
@@ -84,6 +86,7 @@ export function ConfigurationTab({
onSelect(appid);
setDetailAppId(appid);
}}
+ onEnableAll={onEnableAll}
onResetAll={onResetAll}
focusConfiguredToggle={focusConfiguredToggle}
onConfiguredToggleFocused={clearConfiguredToggleFocusRequest}
diff --git a/src/components/Content.tsx b/src/components/Content.tsx
index ff2376b..58512d5 100644
--- a/src/components/Content.tsx
+++ b/src/components/Content.tsx
@@ -1,18 +1,20 @@
import { Tabs } from "@decky/ui";
import { useEffect, useRef, useState } from "react";
-import { FaGamepad, FaList, FaTools } from "react-icons/fa";
+import { FaFileAlt, FaGamepad, FaList, FaTools } from "react-icons/fa";
import { ConfigurationData } from "../config/configSchema";
import { tabStyles } from "../styles";
import { useGameConfiguration } from "../hooks/useGameConfiguration";
import { useInstallationActions } from "../hooks/useInstallationActions";
import { useInstallationStatus } from "../hooks/useLsfgHooks";
import { ConfigurationTab } from "./ConfigurationTab";
+import { ConfigFileTab } from "./ConfigFileTab";
import { NowPlayingTab } from "./NowPlayingTab";
import { SetupTab } from "./SetupTab";
const tabIcons = {
nowPlaying: ;
onResetAll: () => Promise;
focusConfiguredToggle?: boolean;
onConfiguredToggleFocused?: () => void;
@@ -95,6 +96,7 @@ export function GameConfigurationSelector({
targets,
runningGame,
onSelect,
+ onEnableAll,
onResetAll,
focusConfiguredToggle = false,
onConfiguredToggleFocused,
@@ -131,8 +133,39 @@ export function GameConfigurationSelector({
);
};
+ const confirmEnableAll = () => {
+ showModal(
+ void onEnableAll()}
+ onCancel={() => {}}
+ />,
+ );
+ };
+
return (
<>
+
{targets.length === 0 && (
+
+ Enable all available games
+
+
+ )}
(null);
const [advanced, setAdvanced] = useState(false);
- const [busy, setBusy] = useState(false);
+ const [operation, setOperation] = useState(null);
const refresh = async () => {
try {
@@ -51,6 +53,51 @@ function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
if (!relevant || !status?.available) return null;
+ const runExtensionOperation = async (version: string, enabled: boolean) => {
+ const operationKey = `${enabled ? "enable" : "disable"}-${version}`;
+ setOperation(operationKey);
+ try {
+ const result = await setFlatpakExtensionEnabled(version, enabled);
+ if (!result.success) throw new Error(result.error || result.message || "Flatpak runtime update failed");
+ await refresh();
+ } catch (error) {
+ showErrorToast("Flatpak runtime update failed", String(error));
+ } finally {
+ setOperation(null);
+ }
+ };
+
+ const confirmDisable = (version: string) => {
+ showModal(
+ void runExtensionOperation(version, false)}
+ onCancel={() => {}}
+ />,
+ );
+ };
+
+ const handleExtensionToggle = (version: string, enabled: boolean) => {
+ const installed = status.installed_branches.includes(version);
+ const owned = status.owned_branches.includes(version);
+ if (!enabled && installed && !owned) {
+ showErrorToast(
+ "Flatpak runtime preserved",
+ `${version} was not installed by this plugin, so it will remain installed.`,
+ );
+ void refresh();
+ return;
+ }
+ if (!enabled && installed && owned) {
+ confirmDisable(version);
+ return;
+ }
+ void runExtensionOperation(version, enabled);
+ };
+
const confirmCleanup = () => {
showModal(
{
- setBusy(true);
+ setOperation("cleanup");
try {
- await removePluginOwnedFlatpakExtensions();
+ const result = await removePluginOwnedFlatpakExtensions();
+ if (!result.success) throw new Error(result.error || result.message || "Flatpak cleanup failed");
await refresh();
+ } catch (error) {
+ showErrorToast("Flatpak cleanup failed", String(error));
} finally {
- setBusy(false);
+ setOperation(null);
}
}}
onCancel={() => {}}
@@ -89,13 +139,22 @@ function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
<>
{status.supported_branches.map((branch) => (
- handleExtensionToggle(branch, enabled)}
+ disabled={operation !== null || status.ownership_uncertain}
/>
))}
@@ -107,10 +166,10 @@ function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
- {busy ? "Removing..." : "Remove plugin-installed extensions"}
+ {operation === "cleanup" ? "Removing..." : "Remove plugin-installed extensions"}
diff --git a/src/components/index.ts b/src/components/index.ts
index 7c3ee0a..6856e76 100644
--- a/src/components/index.ts
+++ b/src/components/index.ts
@@ -4,6 +4,7 @@ export { InstallationButton } from "./InstallationButton";
export { ConfigurationSection } from "./ConfigurationSection";
export { FpsMultiplierControl } from "./FpsMultiplierControl";
export { ConfigurationTab } from "./ConfigurationTab";
+export { ConfigFileTab } from "./ConfigFileTab";
export { SetupTab } from "./SetupTab";
export { GameConfigurationSelector } from "./GameConfigurationSelector";
export { GameConfigurationControls } from "./GameConfigurationControls";
diff --git a/src/hooks/useGameConfiguration.ts b/src/hooks/useGameConfiguration.ts
index b59d592..c70d589 100644
--- a/src/hooks/useGameConfiguration.ts
+++ b/src/hooks/useGameConfiguration.ts
@@ -40,6 +40,23 @@ function mergeInstalledGames(backendGames: InstalledGame[], shortcutGames: Insta
return Array.from(games.values());
}
+function selectShortcutExecutable(
+ target: GameTarget,
+ ...candidates: Array
+): string | undefined {
+ const absolute = candidates
+ .map((candidate) => candidate?.trim())
+ .find((candidate) => candidate && candidate.startsWith("/"));
+ if (absolute) return absolute;
+
+ // Steam's app-details API can report a Flatpak Target as just "flatpak"
+ // even when the shortcut's canonical VDF executable is /usr/bin/flatpak.
+ // Keep the stored original executable absolute so SetShortcutExe and the
+ // generated dispatcher agree on the same direct transport.
+ if (target.transport.kind === "flatpak") return "/usr/bin/flatpak";
+ return candidates.map((candidate) => candidate?.trim()).find(Boolean);
+}
+
const DEFAULT_WORKAROUND_STATE: WorkaroundState = {
dxvkFrameRate: 0,
disableGamescopeWsi: true,
@@ -151,7 +168,14 @@ export function useGameConfiguration() {
throw new Error("Shortcut Target is already the managed wrapper but its original Target is unknown");
}
const state = oldState || { ...DEFAULT_WORKAROUND_STATE };
- const originalExecutable = target.nonSteam ? (oldShortcutExe || current.target) : undefined;
+ const originalExecutable = target.nonSteam
+ ? selectShortcutExecutable(
+ target,
+ oldShortcutExe,
+ target.transport.kind === "flatpak" ? target.executable : undefined,
+ current.target,
+ )
+ : undefined;
const initialIntegration = target.nonSteam
? current.target === wrapperPath
: hasWrapperLaunchIntegration(current.options, wrapperPath);
@@ -170,7 +194,14 @@ export function useGameConfiguration() {
const finalStateResult = await setWorkaroundState(
target.appid,
state,
- target.nonSteam ? (integration.originalExecutable || originalExecutable || null) : null,
+ target.nonSteam
+ ? (selectShortcutExecutable(
+ target,
+ integration.originalExecutable,
+ originalExecutable,
+ target.transport.kind === "flatpak" ? target.executable : undefined,
+ ) || null)
+ : null,
integration.commandTokenAdded,
target.transport,
);
@@ -184,7 +215,14 @@ export function useGameConfiguration() {
appId,
target.nonSteam,
wrapperPath,
- target.nonSteam ? (integration?.originalExecutable || originalExecutable) : undefined,
+ target.nonSteam
+ ? (selectShortcutExecutable(
+ target,
+ integration?.originalExecutable,
+ originalExecutable,
+ target.transport.kind === "flatpak" ? target.executable : undefined,
+ ) || undefined)
+ : undefined,
integration?.commandTokenAdded ?? oldCommandTokenAdded,
);
} catch (rollbackError) {
@@ -264,6 +302,25 @@ export function useGameConfiguration() {
else await removeTargetWorkarounds(target);
return result.success;
}, [ensureTargetFlatpakSupport, ensureTargetWorkarounds, load, removeTargetWorkarounds, targets, template]);
+ const enableAll = useCallback(async (): Promise => {
+ const available = targets.filter((target) => !target.configured && target.name);
+ if (available.length === 0) return;
+
+ for (const target of available) {
+ if (!(await ensureTargetFlatpakSupport(target))) return;
+ if (!(await ensureTargetWorkarounds(target))) return;
+ const result = await updateGameConfig(target.appid, target.name, template);
+ if (!result.success) {
+ await removeTargetWorkarounds(target);
+ showErrorToast(
+ "Could not enable all games",
+ result.error || `Could not create a profile for ${target.name}`,
+ );
+ return;
+ }
+ }
+ await load();
+ }, [ensureTargetFlatpakSupport, ensureTargetWorkarounds, load, removeTargetWorkarounds, targets, template]);
const repair = useCallback(async (appid: string): Promise => {
const target = targets.find((item) => item.appid === appid);
if (!target) return false;
@@ -306,5 +363,5 @@ export function useGameConfiguration() {
}
}, [load, removeTargetWorkarounds, targets]);
- return { config, games, targets, runningGame, selectedAppId, setSelectedAppId, save, enable, repair, resetSelected, resetAll, reload: load };
+ return { config, games, targets, runningGame, selectedAppId, setSelectedAppId, save, enable, enableAll, repair, resetSelected, resetAll, reload: load };
}
diff --git a/src/hooks/usePerAppWorkarounds.ts b/src/hooks/usePerAppWorkarounds.ts
index c7413b0..e9e44e1 100644
--- a/src/hooks/usePerAppWorkarounds.ts
+++ b/src/hooks/usePerAppWorkarounds.ts
@@ -61,6 +61,18 @@ function asError(error: unknown): Error {
return error instanceof Error ? error : new Error(String(error));
}
+function selectShortcutExecutable(
+ transport: TargetTransport,
+ ...candidates: Array
+): string | undefined {
+ const absolute = candidates
+ .map((candidate) => candidate?.trim())
+ .find((candidate) => candidate && candidate.startsWith("/"));
+ if (absolute) return absolute;
+ if (transport.kind === "flatpak") return "/usr/bin/flatpak";
+ return candidates.map((candidate) => candidate?.trim()).find(Boolean);
+}
+
function integrationIsInstalled(
steam: SteamLaunchOptionsSnapshot,
nonSteam: boolean,
@@ -101,7 +113,9 @@ async function adoptWorkaroundState(
if (nonSteam && (!steam.target || steam.target === wrapperPath || isLegacyWrapperToken(steam.target))) {
throw new Error("Shortcut Target is a wrapper but its original Target is unknown");
}
- const originalExecutable = nonSteam ? steam.target : null;
+ const originalExecutable = nonSteam
+ ? selectShortcutExecutable(transport, steam.target)
+ : null;
const initial = await setWorkaroundState(
appId,
DEFAULT_WORKAROUND_STATE,
@@ -120,7 +134,9 @@ async function adoptWorkaroundState(
const finalized = await setWorkaroundState(
appId,
DEFAULT_WORKAROUND_STATE,
- nonSteam ? (integration.originalExecutable || originalExecutable) : null,
+ nonSteam
+ ? (selectShortcutExecutable(transport, integration.originalExecutable, originalExecutable) || null)
+ : null,
integration.commandTokenAdded,
transport,
);
@@ -134,7 +150,9 @@ async function adoptWorkaroundState(
Number(appId),
nonSteam,
wrapperPath,
- nonSteam ? (integration?.originalExecutable || originalExecutable || undefined) : undefined,
+ nonSteam
+ ? (selectShortcutExecutable(transport, integration?.originalExecutable, originalExecutable) || undefined)
+ : undefined,
integration?.commandTokenAdded ?? false,
);
} catch {
diff --git a/tests/test_flatpak_service.py b/tests/test_flatpak_service.py
index 38dfcb5..274c0c5 100644
--- a/tests/test_flatpak_service.py
+++ b/tests/test_flatpak_service.py
@@ -115,6 +115,54 @@ class FlatpakServiceTests(unittest.TestCase):
self.assertTrue(cleanup_response["success"])
self.assertEqual(self.service._run_flatpak_command.call_count, 1)
+ def test_extension_toggle_is_idempotent_and_preserves_preexisting_branch(self):
+ self.service._run_flatpak_command.return_value = self._result(
+ self._extension_line("24.08")
+ )
+
+ enable_response = self.service.set_extension_enabled("24.08", True)
+ disable_response = self.service.set_extension_enabled("24.08", False)
+
+ self.assertTrue(enable_response["success"])
+ self.assertTrue(enable_response["enabled"])
+ self.assertTrue(disable_response["success"])
+ self.assertTrue(disable_response["enabled"])
+ self.assertTrue(disable_response["preserved"])
+ self.assertFalse(disable_response["owned_by_plugin"])
+ self.assertEqual(
+ [call.args[0][0] for call in self.service._run_flatpak_command.call_args_list],
+ ["list", "list"],
+ )
+
+ def test_extension_toggle_removes_owned_branch_and_can_repeat_disable(self):
+ self.service.ownership_path.parent.mkdir(parents=True, exist_ok=True)
+ self.service.ownership_path.write_text(
+ json.dumps({"version": 1, "plugin_owned_branches": ["24.08"]}),
+ encoding="utf-8",
+ )
+ self.service._run_flatpak_command.side_effect = [
+ self._result(self._extension_line("24.08")),
+ self._result(""),
+ self._result(""),
+ self._result(""),
+ ]
+
+ disable_response = self.service.set_extension_enabled("24.08", False)
+ repeat_response = self.service.set_extension_enabled("24.08", False)
+
+ self.assertTrue(disable_response["success"])
+ self.assertFalse(disable_response["enabled"])
+ self.assertTrue(disable_response["removed"])
+ self.assertTrue(repeat_response["success"])
+ self.assertFalse(repeat_response["enabled"])
+ self.assertFalse(repeat_response["installed"])
+ uninstall_commands = [
+ call.args[0]
+ for call in self.service._run_flatpak_command.call_args_list
+ if call.args[0][0] == "uninstall"
+ ]
+ self.assertEqual(len(uninstall_commands), 1)
+
def test_corrupt_ownership_metadata_fails_closed(self):
self.service.ownership_path.parent.mkdir(parents=True, exist_ok=True)
self.service.ownership_path.write_text("{not-json", encoding="utf-8")
--
cgit v1.2.3
From bc75bb93d5aa9aa176262a138f47d3a1d53afbcb Mon Sep 17 00:00:00 2001
From: xXJSONDeruloXx
Date: Thu, 10 Sep 2026 00:25:58 -0400
Subject: fix: simplify Flatpak runtime toggles
---
py_modules/lsfg_vk/flatpak_service.py | 76 +++++++----------------------------
py_modules/lsfg_vk/plugin.py | 3 --
src/api/lsfgApi.ts | 17 --------
src/components/SetupTab.tsx | 76 ++---------------------------------
tests/test_flatpak_service.py | 26 +++++++-----
5 files changed, 33 insertions(+), 165 deletions(-)
diff --git a/py_modules/lsfg_vk/flatpak_service.py b/py_modules/lsfg_vk/flatpak_service.py
index c0a9c0c..11f1a82 100644
--- a/py_modules/lsfg_vk/flatpak_service.py
+++ b/py_modules/lsfg_vk/flatpak_service.py
@@ -202,11 +202,8 @@ class FlatpakService(BaseService):
extension_id=self.EXTENSION_ID,
supported_branches=list(self.SUPPORTED_RUNTIMES),
installed_branches=[],
- owned_branches=[],
- ownership_uncertain=False,
)
installed = self._installed_extension_branches()
- owned, uncertain = self._read_owned_branches()
return self._success_response(
dict,
"Flatpak runtime extension status retrieved",
@@ -214,8 +211,6 @@ class FlatpakService(BaseService):
extension_id=self.EXTENSION_ID,
supported_branches=list(self.SUPPORTED_RUNTIMES),
installed_branches=sorted(installed),
- owned_branches=sorted(owned),
- ownership_uncertain=uncertain,
)
except Exception as error:
return self._error_response(
@@ -225,8 +220,6 @@ class FlatpakService(BaseService):
extension_id=self.EXTENSION_ID,
supported_branches=list(self.SUPPORTED_RUNTIMES),
installed_branches=[],
- owned_branches=[],
- ownership_uncertain=False,
)
def get_flatpak_support_status(self) -> Dict[str, Any]:
@@ -294,18 +287,12 @@ class FlatpakService(BaseService):
)
def install_extension(self, version: str) -> Dict[str, Any]:
- """Install one missing branch and record ownership only after readback."""
+ """Install one branch, treating an already-installed branch as success."""
try:
version = self._validate_runtime(version)
if not self.check_flatpak_available():
raise FileNotFoundError("Flatpak is not available on this system")
with self._lock:
- owned, uncertain = self._read_owned_branches()
- if uncertain:
- raise RuntimeError(
- "Flatpak ownership metadata is uncertain; refusing to install "
- "until it is repaired"
- )
installed_before = self._installed_extension_branches()
if version in installed_before:
return self._success_response(
@@ -314,8 +301,6 @@ class FlatpakService(BaseService):
runtime_branch=version,
installed=True,
enabled=True,
- owned_by_plugin=version in owned,
- preserved=version not in owned,
)
bundle_path = self._bundled_extension_path(version)
if not bundle_path.is_file():
@@ -341,16 +326,16 @@ class FlatpakService(BaseService):
f"Flatpak install completed but {self._extension_ref(version)} "
"was not visible afterwards"
)
- owned.add(version)
- self._write_owned_branches(owned)
+ owned, uncertain = self._read_owned_branches()
+ if not uncertain:
+ owned.add(version)
+ self._write_owned_branches(owned)
return self._success_response(
dict,
f"lsfg-vk {version} runtime extension installed",
runtime_branch=version,
installed=True,
enabled=True,
- owned_by_plugin=True,
- preserved=False,
)
except Exception as error:
return self._error_response(
@@ -359,8 +344,6 @@ class FlatpakService(BaseService):
runtime_branch=version,
installed=False,
enabled=False,
- owned_by_plugin=False,
- preserved=False,
)
def ensure_extension(self, version: str) -> Dict[str, Any]:
@@ -384,7 +367,6 @@ class FlatpakService(BaseService):
f"lsfg-vk {version} runtime extension is ready",
runtime_branch=version,
installed=True,
- owned_by_plugin=version in status.get("owned_branches", []),
)
return self.install_extension(version)
@@ -419,41 +401,15 @@ class FlatpakService(BaseService):
)
def uninstall_extension(self, version: str) -> Dict[str, Any]:
- """Uninstall only when explicitly requested for a plugin-owned branch."""
+ """Uninstall one branch, treating an already-absent branch as success."""
try:
version = self._validate_runtime(version)
if not self.check_flatpak_available():
raise FileNotFoundError("Flatpak is not available on this system")
with self._lock:
- owned, uncertain = self._read_owned_branches()
- if uncertain:
- raise RuntimeError(
- "Flatpak ownership metadata is uncertain; refusing to uninstall"
- )
installed = self._installed_extension_branches()
- if version not in owned:
- if version in installed:
- return self._success_response(
- dict,
- f"Preserved Flatpak extension {version}; it is not plugin-owned",
- runtime_branch=version,
- removed=False,
- installed=True,
- enabled=True,
- owned_by_plugin=False,
- preserved=True,
- )
- return self._success_response(
- dict,
- f"Flatpak extension {version} is already not installed",
- runtime_branch=version,
- removed=False,
- installed=False,
- enabled=False,
- owned_by_plugin=False,
- preserved=False,
- )
- if version in installed:
+ was_installed = version in installed
+ if was_installed:
result = self._run_flatpak_command(
[
"uninstall",
@@ -471,17 +427,17 @@ class FlatpakService(BaseService):
f"Flatpak uninstall completed but {self._extension_ref(version)} "
"is still installed"
)
- owned.remove(version)
- self._write_owned_branches(owned)
+ owned, uncertain = self._read_owned_branches()
+ if not uncertain and version in owned:
+ owned.remove(version)
+ self._write_owned_branches(owned)
return self._success_response(
dict,
- f"Plugin-owned lsfg-vk {version} runtime extension removed",
+ f"lsfg-vk {version} runtime extension uninstalled",
runtime_branch=version,
- removed=True,
+ removed=was_installed,
installed=False,
enabled=False,
- owned_by_plugin=False,
- preserved=False,
)
except Exception as error:
return self._error_response(
@@ -491,8 +447,6 @@ class FlatpakService(BaseService):
removed=False,
installed=False,
enabled=False,
- owned_by_plugin=False,
- preserved=False,
)
def set_extension_enabled(self, version: str, enabled: bool) -> Dict[str, Any]:
@@ -504,8 +458,6 @@ class FlatpakService(BaseService):
runtime_branch=version,
installed=False,
enabled=False,
- owned_by_plugin=False,
- preserved=False,
)
return self.install_extension(version) if enabled else self.uninstall_extension(version)
diff --git a/py_modules/lsfg_vk/plugin.py b/py_modules/lsfg_vk/plugin.py
index 76a4250..c576cc2 100644
--- a/py_modules/lsfg_vk/plugin.py
+++ b/py_modules/lsfg_vk/plugin.py
@@ -162,9 +162,6 @@ class Plugin:
async def set_flatpak_extension_enabled(self, version: str, enabled: bool) -> Dict[str, Any]:
return self.flatpak_service.set_extension_enabled(version, enabled)
-
- async def remove_plugin_owned_flatpak_extensions(self) -> Dict[str, Any]:
- return self.flatpak_service.remove_plugin_owned_extensions()
async def _main(self):
"""
diff --git a/src/api/lsfgApi.ts b/src/api/lsfgApi.ts
index 16b6eab..8179ef9 100644
--- a/src/api/lsfgApi.ts
+++ b/src/api/lsfgApi.ts
@@ -124,17 +124,6 @@ export interface FlatpakExtensionStatus {
extension_id: string;
supported_branches: string[];
installed_branches: string[];
- owned_branches: string[];
- ownership_uncertain: boolean;
-}
-
-export interface FlatpakCleanupResult {
- success: boolean;
- message: string;
- error?: string | null;
- removed_branches: string[];
- preserved_branches: string[];
- ownership_uncertain: boolean;
}
export interface FlatpakExtensionToggleResult {
@@ -144,8 +133,6 @@ export interface FlatpakExtensionToggleResult {
runtime_branch: string;
enabled: boolean;
installed: boolean;
- owned_by_plugin: boolean;
- preserved: boolean;
}
// API functions
@@ -162,10 +149,6 @@ export const setFlatpakExtensionEnabled = callable<
[string, boolean],
FlatpakExtensionToggleResult
>("set_flatpak_extension_enabled");
-export const removePluginOwnedFlatpakExtensions = callable<
- [],
- FlatpakCleanupResult
->("remove_plugin_owned_flatpak_extensions");
export const getGameConfigs = callable<[], GameConfigsResult>("get_game_configs");
export const getInstalledGames = callable<[], InstalledGamesResult>("get_installed_games");
diff --git a/src/components/SetupTab.tsx b/src/components/SetupTab.tsx
index df43c5e..aec0e93 100644
--- a/src/components/SetupTab.tsx
+++ b/src/components/SetupTab.tsx
@@ -1,8 +1,7 @@
-import { ButtonItem, ConfirmModal, Field, PanelSection, PanelSectionRow, ToggleField, showModal } from "@decky/ui";
+import { ButtonItem, Field, PanelSection, PanelSectionRow, ToggleField } from "@decky/ui";
import { useEffect, useState } from "react";
import {
getFlatpakSupportStatus,
- removePluginOwnedFlatpakExtensions,
setFlatpakExtensionEnabled,
type FlatpakExtensionStatus,
type SteamBranchStatus,
@@ -41,8 +40,6 @@ function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
extension_id: "",
supported_branches: [],
installed_branches: [],
- owned_branches: [],
- ownership_uncertain: false,
});
}
};
@@ -67,61 +64,10 @@ function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
}
};
- const confirmDisable = (version: string) => {
- showModal(
- void runExtensionOperation(version, false)}
- onCancel={() => {}}
- />,
- );
- };
-
const handleExtensionToggle = (version: string, enabled: boolean) => {
- const installed = status.installed_branches.includes(version);
- const owned = status.owned_branches.includes(version);
- if (!enabled && installed && !owned) {
- showErrorToast(
- "Flatpak runtime preserved",
- `${version} was not installed by this plugin, so it will remain installed.`,
- );
- void refresh();
- return;
- }
- if (!enabled && installed && owned) {
- confirmDisable(version);
- return;
- }
void runExtensionOperation(version, enabled);
};
- const confirmCleanup = () => {
- showModal(
- {
- setOperation("cleanup");
- try {
- const result = await removePluginOwnedFlatpakExtensions();
- if (!result.success) throw new Error(result.error || result.message || "Flatpak cleanup failed");
- await refresh();
- } catch (error) {
- showErrorToast("Flatpak cleanup failed", String(error));
- } finally {
- setOperation(null);
- }
- }}
- onCancel={() => {}}
- />,
- );
- };
-
return (
@@ -147,31 +93,15 @@ function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
: operation === `disable-${branch}`
? "Uninstalling..."
: status.installed_branches.includes(branch)
- ? status.owned_branches.includes(branch)
- ? "Installed · plugin-owned"
- : "Installed · pre-existing (preserved)"
+ ? "Installed"
: "Not installed"
}
checked={status.installed_branches.includes(branch)}
onChange={(enabled) => handleExtensionToggle(branch, enabled)}
- disabled={operation !== null || status.ownership_uncertain}
+ disabled={operation !== null}
/>
))}
- {status.ownership_uncertain && (
-
-
- )}
-
-
- {operation === "cleanup" ? "Removing..." : "Remove plugin-installed extensions"}
-
-
)}
diff --git a/tests/test_flatpak_service.py b/tests/test_flatpak_service.py
index 274c0c5..70ba228 100644
--- a/tests/test_flatpak_service.py
+++ b/tests/test_flatpak_service.py
@@ -93,7 +93,8 @@ class FlatpakServiceTests(unittest.TestCase):
response = self.service.install_extension("24.08")
self.assertTrue(response["success"])
- self.assertTrue(response["owned_by_plugin"])
+ self.assertTrue(response["enabled"])
+ self.assertTrue(response["installed"])
install_args = self.service._run_flatpak_command.call_args_list[1].args[0]
self.assertEqual(install_args[:4], ["install", "--user", "--noninteractive", "--or-update"])
self.assertEqual(
@@ -110,28 +111,33 @@ class FlatpakServiceTests(unittest.TestCase):
cleanup_response = self.service.remove_plugin_owned_extensions()
self.assertTrue(install_response["success"])
- self.assertFalse(install_response["owned_by_plugin"])
+ self.assertTrue(install_response["enabled"])
+ self.assertTrue(install_response["installed"])
self.assertFalse(self.service.ownership_path.exists())
self.assertTrue(cleanup_response["success"])
self.assertEqual(self.service._run_flatpak_command.call_count, 1)
- def test_extension_toggle_is_idempotent_and_preserves_preexisting_branch(self):
- self.service._run_flatpak_command.return_value = self._result(
- self._extension_line("24.08")
- )
+ def test_extension_toggle_installs_and_uninstalls_preexisting_branch(self):
+ self.service._run_flatpak_command.side_effect = [
+ self._result(self._extension_line("24.08")),
+ self._result(self._extension_line("24.08")),
+ self._result(""),
+ self._result(""),
+ ]
enable_response = self.service.set_extension_enabled("24.08", True)
disable_response = self.service.set_extension_enabled("24.08", False)
self.assertTrue(enable_response["success"])
self.assertTrue(enable_response["enabled"])
+ self.assertTrue(enable_response["installed"])
self.assertTrue(disable_response["success"])
- self.assertTrue(disable_response["enabled"])
- self.assertTrue(disable_response["preserved"])
- self.assertFalse(disable_response["owned_by_plugin"])
+ self.assertFalse(disable_response["enabled"])
+ self.assertFalse(disable_response["installed"])
+ self.assertTrue(disable_response["removed"])
self.assertEqual(
[call.args[0][0] for call in self.service._run_flatpak_command.call_args_list],
- ["list", "list"],
+ ["list", "list", "uninstall", "list"],
)
def test_extension_toggle_removes_owned_branch_and_can_repeat_disable(self):
--
cgit v1.2.3
From 28ebc17785a8cca52f289b74261d1f310fd35904 Mon Sep 17 00:00:00 2001
From: xXJSONDeruloXx
Date: Thu, 10 Sep 2026 07:08:19 -0400
Subject: fix: detect wrapped Flatpak shortcuts
---
py_modules/lsfg_vk/steam_service.py | 21 ++++++++++--
src/components/Content.tsx | 1 -
src/components/SetupTab.tsx | 68 +++++++++++++++----------------------
tests/test_steam_service.py | 33 ++++++++++++++++++
4 files changed, 79 insertions(+), 44 deletions(-)
diff --git a/py_modules/lsfg_vk/steam_service.py b/py_modules/lsfg_vk/steam_service.py
index b3bdb69..50d722b 100644
--- a/py_modules/lsfg_vk/steam_service.py
+++ b/py_modules/lsfg_vk/steam_service.py
@@ -4,10 +4,15 @@ from pathlib import Path
from typing import Dict, Optional, Tuple
from .base_service import BaseService
-from .constants import STEAM_LOSSLESS_SCALING_APP_ID, STEAM_LOSSLESS_SCALING_BRANCH
+from .constants import (
+ STEAM_LOSSLESS_SCALING_APP_ID,
+ STEAM_LOSSLESS_SCALING_BRANCH,
+ WRAPPER_FILENAME,
+)
_FLATPAK_APP_ID = re.compile(r"^[A-Za-z0-9][A-Za-z0-9-]*(?:\.[A-Za-z0-9][A-Za-z0-9-]*)+$")
+_WRAPPER_TOKEN = f"~/{WRAPPER_FILENAME}"
def _split_command(value: Optional[str]) -> Optional[list[str]]:
@@ -19,17 +24,27 @@ def _split_command(value: Optional[str]) -> Optional[list[str]]:
return None
+def _is_managed_wrapper(value: str) -> bool:
+ """Recognize the wrapper Target while keeping arbitrary launchers as host games."""
+ if value in {_WRAPPER_TOKEN, f"$HOME/{WRAPPER_FILENAME}"}:
+ return True
+ path = Path(value)
+ return path.is_absolute() and path.name == WRAPPER_FILENAME
+
+
def classify_shortcut_transport(
executable: Optional[str],
launch_options: Optional[str] = None,
) -> Dict[str, object]:
- """Classify only direct Flatpak invocations; leave shell launchers on host."""
+ """Classify direct Flatpak invocations, including the managed wrapper Target."""
executable_tokens = _split_command(executable)
option_tokens = _split_command(launch_options)
if executable_tokens is None or option_tokens is None or not executable_tokens:
return {"kind": "host"}
- if executable_tokens[0] != "/usr/bin/flatpak":
+ direct_flatpak = executable_tokens[0] == "/usr/bin/flatpak"
+ managed_wrapper = len(executable_tokens) == 1 and _is_managed_wrapper(executable_tokens[0])
+ if not direct_flatpak and not managed_wrapper:
return {"kind": "host"}
arguments = [*executable_tokens[1:], *option_tokens]
diff --git a/src/components/Content.tsx b/src/components/Content.tsx
index 58512d5..d4f54e9 100644
--- a/src/components/Content.tsx
+++ b/src/components/Content.tsx
@@ -103,7 +103,6 @@ export function Content() {
isUninstalling={isUninstalling}
onInstall={onInstall}
onUninstall={onUninstall}
- flatpakRelevant={targets.some((target) => target.transport.kind === "flatpak")}
/>
);
diff --git a/src/components/SetupTab.tsx b/src/components/SetupTab.tsx
index aec0e93..6bf1fad 100644
--- a/src/components/SetupTab.tsx
+++ b/src/components/SetupTab.tsx
@@ -1,4 +1,4 @@
-import { ButtonItem, Field, PanelSection, PanelSectionRow, ToggleField } from "@decky/ui";
+import { Field, PanelSection, PanelSectionRow, ToggleField } from "@decky/ui";
import { useEffect, useState } from "react";
import {
getFlatpakSupportStatus,
@@ -20,12 +20,10 @@ interface SetupTabProps {
isUninstalling: boolean;
onInstall: () => void;
onUninstall: () => void;
- flatpakRelevant: boolean;
}
-function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
+function FlatpakSupportDiagnostics() {
const [status, setStatus] = useState(null);
- const [advanced, setAdvanced] = useState(false);
const [operation, setOperation] = useState(null);
const refresh = async () => {
@@ -45,10 +43,10 @@ function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
};
useEffect(() => {
- if (relevant) void refresh();
- }, [relevant]);
+ void refresh();
+ }, []);
- if (!relevant || !status?.available) return null;
+ if (!status?.available) return null;
const runExtensionOperation = async (version: string, enabled: boolean) => {
const operationKey = `${enabled ? "enable" : "disable"}-${version}`;
@@ -69,41 +67,32 @@ function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
};
return (
-
+
-
- setAdvanced((value) => !value)}>
- {advanced ? "Hide runtime details" : "Show runtime details"}
-
-
- {advanced && (
- <>
- {status.supported_branches.map((branch) => (
-
- handleExtensionToggle(branch, enabled)}
- disabled={operation !== null}
- />
-
- ))}
-
- )}
+ {status.supported_branches.map((branch) => (
+
+ handleExtensionToggle(branch, enabled)}
+ disabled={operation !== null}
+ />
+
+ ))}
);
}
@@ -118,7 +107,6 @@ export function SetupTab({
isUninstalling,
onInstall,
onUninstall,
- flatpakRelevant,
}: SetupTabProps) {
return (
<>
@@ -137,7 +125,7 @@ export function SetupTab({
onUninstall={onUninstall}
/>
- [^"]+)"[ \t]+"(?P(?:\\.|[^"\\])*)"'
- )
- for match in pattern.finditer(content, body_start, body_end):
- if match.group("key") == key:
- return match.group("value")
- return None
+ start, end, _ = bounds
+ pattern = re.compile(r'(?m)^[ \t]*"(?P[^"]+)"[ \t]+"(?P(?:\\.|[^"\\])*)"')
+ return next((
+ match.group("value")
+ for match in pattern.finditer(content, start, end)
+ if match.group("key") == key
+ ), None)
@classmethod
def _branch_or_default(cls, branch: Optional[str]) -> str:
return branch or cls.DEFAULT_BRANCH
def _status_fields(self, manifest_path: Path, content: str) -> Dict[str, object]:
- selected_branch = self._branch_or_default(
- self._section_value(content, "UserConfig", "BetaKey")
- )
- current_branch = self._branch_or_default(
+ selected = self._branch_or_default(self._section_value(content, "UserConfig", "BetaKey"))
+ current = self._branch_or_default(
self._section_value(content, "MountedConfig", "BetaKey")
or self._section_value(content, "UserConfig", "BetaKey")
)
- needs_switch = (
- selected_branch != STEAM_LOSSLESS_SCALING_BRANCH
- or current_branch != STEAM_LOSSLESS_SCALING_BRANCH
- )
+ needs_switch = selected != STEAM_LOSSLESS_SCALING_BRANCH or current != STEAM_LOSSLESS_SCALING_BRANCH
return {
"installed": True,
"manifest_path": str(manifest_path),
- "selected_branch": selected_branch,
- "current_branch": current_branch,
+ "selected_branch": selected,
+ "current_branch": current,
"target_branch": STEAM_LOSSLESS_SCALING_BRANCH,
"needs_switch": needs_switch,
- "restart_required": (
- selected_branch == STEAM_LOSSLESS_SCALING_BRANCH
- and current_branch != STEAM_LOSSLESS_SCALING_BRANCH
- ),
+ "restart_required": selected == STEAM_LOSSLESS_SCALING_BRANCH and current != STEAM_LOSSLESS_SCALING_BRANCH,
+ }
+
+ @staticmethod
+ def _missing_branch_fields() -> Dict[str, object]:
+ return {
+ "installed": False,
+ "manifest_path": None,
+ "selected_branch": None,
+ "current_branch": None,
+ "target_branch": STEAM_LOSSLESS_SCALING_BRANCH,
+ "needs_switch": False,
+ "restart_required": False,
}
def find_lsfg_vk_dll(self) -> Optional[str]:
- """Find the branch-specific upstream DLL in any Steam library."""
if self.get_branch_status().get("needs_switch"):
return None
- for library_root in self._steam_library_roots():
- dll_path = library_root / "steamapps/common/Lossless Scaling/lsfg-vk.dll"
- if dll_path.is_file():
- return str(dll_path)
- return None
+ return next((
+ str(path)
+ for root in self._steam_library_roots()
+ if (path := root / "steamapps/common/Lossless Scaling/lsfg-vk.dll").is_file()
+ ), None)
def get_branch_status(self) -> Dict[str, object]:
try:
- manifest_path = self._manifest_path()
- if manifest_path is None:
+ manifest = self._manifest_path()
+ if manifest is None:
return self._success_response(
dict,
"Lossless Scaling is not installed through Steam",
- installed=False,
- manifest_path=None,
- selected_branch=None,
- current_branch=None,
- target_branch=STEAM_LOSSLESS_SCALING_BRANCH,
- needs_switch=False,
- restart_required=False,
+ **self._missing_branch_fields(),
)
-
- content = manifest_path.read_text(encoding="utf-8")
- fields = self._status_fields(manifest_path, content)
- if not fields["needs_switch"]:
- message = "Lossless Scaling is using the lsfg-vk Steam branch"
- elif fields["restart_required"]:
- message = "lsfg-vk is selected; restart Steam to finish the branch switch"
- else:
- message = "Select lsfg-vk in Lossless Scaling's Steam Properties > Betas"
+ fields = self._status_fields(manifest, manifest.read_text(encoding="utf-8"))
+ message = (
+ "Lossless Scaling is using the lsfg-vk Steam branch"
+ if not fields["needs_switch"]
+ else "lsfg-vk is selected; restart Steam to finish the branch switch"
+ if fields["restart_required"]
+ else "Select lsfg-vk in Lossless Scaling's Steam Properties > Betas"
+ )
return self._success_response(dict, message, **fields)
except Exception as error:
- return self._error_response(
- dict,
- str(error),
- installed=False,
- manifest_path=None,
- selected_branch=None,
- current_branch=None,
- target_branch=STEAM_LOSSLESS_SCALING_BRANCH,
- needs_switch=False,
- restart_required=False,
- )
+ return self._error_response(dict, str(error), **self._missing_branch_fields())
def get_installed_games(self) -> Dict[str, object]:
- """Return installed Steam app IDs and names for the Game Mode selector."""
try:
games: Dict[str, Dict[str, object]] = {}
- for library_root in self._steam_library_roots():
- for manifest in (library_root / "steamapps").glob("appmanifest_*.acf"):
+ for root in self._steam_library_roots():
+ for manifest in (root / "steamapps").glob("appmanifest_*.acf"):
match = re.fullmatch(r"appmanifest_(\d+)\.acf", manifest.name)
if not match:
continue
@@ -385,10 +305,9 @@ class SteamService(BaseService):
appid = match.group(1)
if appid in self.GAME_SELECTOR_EXCLUDED_APPIDS:
continue
- name = self._section_value(content, "AppState", "name") or f"App {appid}"
games[appid] = {
"appid": appid,
- "name": name,
+ "name": self._section_value(content, "AppState", "name") or f"App {appid}",
"nonSteam": False,
"transport": {"kind": "host"},
}
diff --git a/py_modules/lsfg_vk/types.py b/py_modules/lsfg_vk/types.py
index 7b85708..ce541ec 100644
--- a/py_modules/lsfg_vk/types.py
+++ b/py_modules/lsfg_vk/types.py
@@ -1,40 +1,17 @@
-"""
-Type definitions for the lsfg-vk plugin responses.
-"""
+from typing import List, Optional, TypedDict
-from typing import TypedDict, Optional, List
-
-class BaseResponse(TypedDict):
- """Base response structure"""
+class InstallationResponse(TypedDict):
success: bool
-
-
-class ErrorResponse(BaseResponse):
- """Response structure for errors"""
- error: str
-
-
-class MessageResponse(BaseResponse):
- """Response structure with message"""
- message: str
-
-
-class InstallationResponse(BaseResponse):
- """Response for installation operations"""
message: str
error: Optional[str]
-class UninstallationResponse(BaseResponse):
- """Response for uninstallation operations"""
- message: str
+class UninstallationResponse(InstallationResponse):
removed_files: Optional[List[str]]
- error: Optional[str]
class InstallationCheckResponse(TypedDict):
- """Response for installation check"""
installed: bool
lossless_scaling_installed: bool
lossless_scaling_status: str
diff --git a/src/api/lsfgApi.ts b/src/api/lsfgApi.ts
index 8179ef9..b96acec 100644
--- a/src/api/lsfgApi.ts
+++ b/src/api/lsfgApi.ts
@@ -1,11 +1,13 @@
import { callable } from "@decky/api";
import { ConfigurationData } from "../config/configSchema";
-// Type definitions for API responses
-export interface InstallationResult {
+interface ApiResult {
success: boolean;
- error?: string;
message?: string;
+ error?: string | null;
+}
+
+export interface InstallationResult extends ApiResult {
removed_files?: string[];
}
@@ -16,10 +18,8 @@ export interface InstallationStatus {
error?: string;
}
-export interface SteamBranchStatus {
- success: boolean;
+export interface SteamBranchStatus extends ApiResult {
message: string;
- error?: string;
installed: boolean;
manifest_path?: string;
selected_branch?: string;
@@ -29,36 +29,16 @@ export interface SteamBranchStatus {
restart_required: boolean;
}
-// Use centralized configuration data type
export type LsfgConfig = ConfigurationData;
-
-export interface ConfigUpdateResult {
- success: boolean;
- message?: string;
- error?: string;
-}
-
-export interface GameConfigEntry {
- appid: string;
- profile: string;
- config: LsfgConfig;
-}
export type TargetTransport =
| { kind: "host" }
| { kind: "flatpak"; flatpakAppId: string };
-
export type FlatpakTargetSupportStatus = "ready" | "needs-runtime" | "unsupported" | "error";
-export interface FlatpakTargetSupport {
- success: boolean;
- message?: string;
- error?: string | null;
- flatpak_app_id?: string;
- runtime?: string | null;
- runtime_branch?: string | null;
- support_status: FlatpakTargetSupportStatus;
- extension_installed: boolean;
- installed_branches: string[];
+export interface GameConfigEntry {
+ appid: string;
+ profile: string;
+ config: LsfgConfig;
}
export interface InstalledGame {
@@ -71,20 +51,19 @@ export interface InstalledGame {
startDir?: string;
flatpakSupport?: FlatpakTargetSupport;
}
-export interface InstalledGamesResult { success: boolean; games?: InstalledGame[]; error?: string; }
-export interface GlobalConfig { dll: string; no_fp16: boolean; }
-export interface GameConfigsResult {
- success: boolean;
- global_config?: GlobalConfig;
- games?: GameConfigEntry[];
- error?: string;
+export interface GlobalConfig {
+ dll: string;
+ no_fp16: boolean;
}
-export interface GameConfigResult extends ConfigUpdateResult {
- appid?: string;
- exists?: boolean;
- config?: LsfgConfig;
+export interface FlatpakTargetSupport extends ApiResult {
+ flatpak_app_id?: string;
+ runtime?: string | null;
+ runtime_branch?: string | null;
+ support_status: FlatpakTargetSupportStatus;
+ extension_installed: boolean;
+ installed_branches: string[];
}
export interface WorkaroundState {
@@ -96,10 +75,7 @@ export interface WorkaroundState {
enableZink: boolean;
}
-export interface WorkaroundStateResult {
- success: boolean;
- message?: string;
- error?: string;
+export interface WorkaroundStateResult extends ApiResult {
appid?: string;
state?: WorkaroundState | null;
wrapper_path?: string;
@@ -109,47 +85,50 @@ export interface WorkaroundStateResult {
transport?: TargetTransport | null;
}
-export interface FileContentResult {
- success: boolean;
+export interface GameConfigsResult extends ApiResult {
+ global_config?: GlobalConfig;
+ games?: GameConfigEntry[];
+}
+
+export interface GameConfigResult extends ApiResult {
+ appid?: string;
+ exists?: boolean;
+ config?: LsfgConfig;
+}
+
+export interface InstalledGamesResult extends ApiResult {
+ games?: InstalledGame[];
+}
+
+export interface FileContentResult extends ApiResult {
content?: string;
path?: string;
- error?: string;
}
-export interface FlatpakExtensionStatus {
- success: boolean;
+export interface FlatpakExtensionStatus extends ApiResult {
message: string;
- error?: string | null;
available: boolean;
extension_id: string;
supported_branches: string[];
installed_branches: string[];
}
-export interface FlatpakExtensionToggleResult {
- success: boolean;
+export interface FlatpakExtensionToggleResult extends ApiResult {
message: string;
- error?: string | null;
runtime_branch: string;
enabled: boolean;
installed: boolean;
}
-// API functions
export const installLsfgVk = callable<[], InstallationResult>("install_lsfg_vk");
export const uninstallLsfgVk = callable<[], InstallationResult>("uninstall_lsfg_vk");
export const checkLsfgVkInstalled = callable<[], InstallationStatus>("check_lsfg_vk_installed");
export const getLosslessScalingBranchStatus = callable<[], SteamBranchStatus>("get_lossless_scaling_branch_status");
export const getConfigFileContent = callable<[], FileContentResult>("get_config_file_content");
-
export const getFlatpakSupportStatus = callable<[], FlatpakExtensionStatus>("get_flatpak_support_status");
export const ensureFlatpakSupport = callable<[string], FlatpakTargetSupport>("ensure_flatpak_support");
export const repairFlatpakSupport = callable<[string], FlatpakTargetSupport>("repair_flatpak_support");
-export const setFlatpakExtensionEnabled = callable<
- [string, boolean],
- FlatpakExtensionToggleResult
->("set_flatpak_extension_enabled");
-
+export const setFlatpakExtensionEnabled = callable<[string, boolean], FlatpakExtensionToggleResult>("set_flatpak_extension_enabled");
export const getGameConfigs = callable<[], GameConfigsResult>("get_game_configs");
export const getInstalledGames = callable<[], InstalledGamesResult>("get_installed_games");
export const updateGameConfig = callable<[string, string, LsfgConfig], GameConfigResult>("update_game_config");
diff --git a/src/components/Content.tsx b/src/components/Content.tsx
index d4f54e9..d92ef86 100644
--- a/src/components/Content.tsx
+++ b/src/components/Content.tsx
@@ -2,12 +2,11 @@ import { Tabs } from "@decky/ui";
import { useEffect, useRef, useState } from "react";
import { FaFileAlt, FaGamepad, FaList, FaTools } from "react-icons/fa";
import { ConfigurationData } from "../config/configSchema";
-import { tabStyles } from "../styles";
import { useGameConfiguration } from "../hooks/useGameConfiguration";
-import { useInstallationActions } from "../hooks/useInstallationActions";
-import { useInstallationStatus } from "../hooks/useLsfgHooks";
-import { ConfigurationTab } from "./ConfigurationTab";
+import { useInstallation } from "../hooks/useLsfgHooks";
+import { tabStyles } from "../styles";
import { ConfigFileTab } from "./ConfigFileTab";
+import { ConfigurationTab } from "./ConfigurationTab";
import { NowPlayingTab } from "./NowPlayingTab";
import { SetupTab } from "./SetupTab";
@@ -19,16 +18,6 @@ const tabIcons = {
};
export function Content() {
- const {
- isInstalled,
- installationStatus,
- setIsInstalled,
- setInstallationStatus,
- losslessScalingInstalled,
- losslessScalingStatus,
- steamBranchStatus,
- checkInstallation,
- } = useInstallationStatus();
const {
config,
targets,
@@ -42,15 +31,25 @@ export function Content() {
resetAll,
reload,
} = useGameConfiguration();
- const { isInstalling, isUninstalling, handleInstall, handleUninstall } = useInstallationActions();
+ const {
+ isInstalled,
+ installationStatus,
+ losslessScalingInstalled,
+ losslessScalingStatus,
+ steamBranchStatus,
+ isInstalling,
+ isUninstalling,
+ install,
+ uninstall,
+ } = useInstallation(reload);
const [tab, setTab] = useState("Setup");
+ const previousRunningAppId = useRef(null);
const setupComplete =
isInstalled &&
losslessScalingInstalled &&
steamBranchStatus?.success === true &&
steamBranchStatus.installed &&
!steamBranchStatus.needs_switch;
- const previousRunningAppId = useRef(null);
useEffect(() => {
if (!setupComplete) {
@@ -65,10 +64,9 @@ export function Content() {
const appid = runningGame?.appid || null;
const previous = previousRunningAppId.current;
previousRunningAppId.current = appid;
- if (appid && appid !== previous) {
- setTab("NowPlaying");
- } else if (!appid && previous) {
- setTab((currentTab) => currentTab === "NowPlaying" ? "Games" : currentTab);
+ if (appid && appid !== previous) setTab("NowPlaying");
+ else if (!appid && previous) {
+ setTab((current) => current === "NowPlaying" ? "Games" : current);
}
}, [runningGame?.appid, runningGame?.configured, setupComplete]);
@@ -80,19 +78,9 @@ export function Content() {
fieldName: keyof ConfigurationData,
value: boolean | number | string | string[],
cleanupLaunchOptions = false,
- ) => {
- await save({ ...config, [fieldName]: value }, cleanupLaunchOptions);
- };
-
- const onInstall = () => {
- void handleInstall(setIsInstalled, setInstallationStatus, reload, checkInstallation);
- };
-
- const onUninstall = () => {
- void handleUninstall(setIsInstalled, setInstallationStatus, checkInstallation);
- };
+ ) => save({ ...config, [fieldName]: value }, cleanupLaunchOptions);
- const setupContent = (
+ const setup = (
void install()}
+ onUninstall={() => void uninstall()}
+ flatpakRelevant={targets.some((target) => target.transport.kind === "flatpak")}
/>
);
@@ -115,7 +104,7 @@ export function Content() {
handleConfigChange(fieldName, value)}
+ onConfigChange={(field, value) => handleConfigChange(field, value)}
onEnable={enable}
onRepair={repair}
/>
@@ -130,7 +119,7 @@ export function Content() {
targets={targets}
runningGame={runningGame}
onSelect={setSelectedAppId}
- onConfigChange={(fieldName, value) => handleConfigChange(fieldName, value, true)}
+ onConfigChange={(field, value) => handleConfigChange(field, value, true)}
onEnable={enable}
onEnableAll={enableAll}
onRepair={repair}
@@ -139,16 +128,10 @@ export function Content() {
/>
),
},
- {
- id: "ConfigFile",
- title: tabIcons.configFile,
- content:
- {collapsed ? (
-
void;
- onUninstall: () => void;
-}
-
-export function InstallationButton({
- isInstalled,
- isInstalling,
- isUninstalling,
- onInstall,
- onUninstall
-}: InstallationButtonProps) {
- const label = isInstalling
- ? t('INSTALL_INSTALLING', 'Installing...')
- : isUninstalling
- ? t('INSTALL_UNINSTALLING', 'Uninstalling...')
- : isInstalled
- ? t('INSTALL_UNINSTALL_BTN', 'Uninstall LSFG-VK')
- : t('INSTALL_INSTALL_BTN', 'Install LSFG-VK');
-
- return (
-
-
- {label}
-
-
- );
-}
diff --git a/src/components/SetupTab.tsx b/src/components/SetupTab.tsx
index 6bf1fad..e936049 100644
--- a/src/components/SetupTab.tsx
+++ b/src/components/SetupTab.tsx
@@ -1,4 +1,4 @@
-import { Field, PanelSection, PanelSectionRow, ToggleField } from "@decky/ui";
+import { ButtonItem, Field, PanelSection, PanelSectionRow, ToggleField } from "@decky/ui";
import { useEffect, useState } from "react";
import {
getFlatpakSupportStatus,
@@ -6,8 +6,7 @@ import {
type FlatpakExtensionStatus,
type SteamBranchStatus,
} from "../api/lsfgApi";
-import { InstallationButton } from "./InstallationButton";
-import { StatusDisplay } from "./StatusDisplay";
+import t from "../i18n/i18n";
import { showErrorToast } from "../utils/toastUtils";
interface SetupTabProps {
@@ -20,10 +19,12 @@ interface SetupTabProps {
isUninstalling: boolean;
onInstall: () => void;
onUninstall: () => void;
+ flatpakRelevant: boolean;
}
-function FlatpakSupportDiagnostics() {
+function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
const [status, setStatus] = useState(null);
+ const [advanced, setAdvanced] = useState(false);
const [operation, setOperation] = useState(null);
const refresh = async () => {
@@ -43,16 +44,15 @@ function FlatpakSupportDiagnostics() {
};
useEffect(() => {
- void refresh();
- }, []);
+ if (relevant) void refresh();
+ }, [relevant]);
- if (!status?.available) return null;
+ if (!relevant || !status?.available) return null;
- const runExtensionOperation = async (version: string, enabled: boolean) => {
- const operationKey = `${enabled ? "enable" : "disable"}-${version}`;
- setOperation(operationKey);
+ const setEnabled = async (branch: string, enabled: boolean) => {
+ setOperation(`${enabled ? "enable" : "disable"}-${branch}`);
try {
- const result = await setFlatpakExtensionEnabled(version, enabled);
+ const result = await setFlatpakExtensionEnabled(branch, enabled);
if (!result.success) throw new Error(result.error || result.message || "Flatpak runtime update failed");
await refresh();
} catch (error) {
@@ -62,70 +62,91 @@ function FlatpakSupportDiagnostics() {
}
};
- const handleExtensionToggle = (version: string, enabled: boolean) => {
- void runExtensionOperation(version, enabled);
- };
-
return (
-
+
- {status.supported_branches.map((branch) => (
-
- handleExtensionToggle(branch, enabled)}
- disabled={operation !== null}
- />
-
- ))}
+
+ setAdvanced((value) => !value)}>
+ {advanced ? "Hide runtime details" : "Show runtime details"}
+
+
+ {advanced && status.supported_branches.map((branch) => {
+ const installed = status.installed_branches.includes(branch);
+ const pending = operation?.endsWith(`-${branch}`);
+ return (
+
+ void setEnabled(branch, enabled)}
+ disabled={operation !== null}
+ />
+
+ );
+ })}
);
}
-export function SetupTab({
- isInstalled,
- installationStatus,
- losslessScalingInstalled,
- losslessScalingStatus,
- steamBranchStatus,
- isInstalling,
- isUninstalling,
- onInstall,
- onUninstall,
-}: SetupTabProps) {
+export function SetupTab(props: SetupTabProps) {
+ const {
+ isInstalled,
+ installationStatus,
+ losslessScalingInstalled,
+ losslessScalingStatus,
+ steamBranchStatus,
+ isInstalling,
+ isUninstalling,
+ onInstall,
+ onUninstall,
+ flatpakRelevant,
+ } = props;
+ const losslessScalingAppInstalled = losslessScalingInstalled || steamBranchStatus?.installed === true;
+ const buttonLabel = isInstalling
+ ? t("INSTALL_INSTALLING", "Installing...")
+ : isUninstalling
+ ? t("INSTALL_UNINSTALLING", "Uninstalling...")
+ : isInstalled
+ ? t("INSTALL_UNINSTALL_BTN", "Uninstall LSFG-VK")
+ : t("INSTALL_INSTALL_BTN", "Install LSFG-VK");
+
return (
<>
-
+
+
+
+ {steamBranchStatus?.installed && (
+
+
+ )}
+
+
+ {buttonLabel}
+
+
-
-
-
-
-
- {steamBranchStatus?.installed && (
-
-
- )}
-
- );
-}
diff --git a/src/components/index.ts b/src/components/index.ts
index 6856e76..bca6f6f 100644
--- a/src/components/index.ts
+++ b/src/components/index.ts
@@ -1,6 +1,4 @@
export { Content } from "./Content";
-export { StatusDisplay } from "./StatusDisplay";
-export { InstallationButton } from "./InstallationButton";
export { ConfigurationSection } from "./ConfigurationSection";
export { FpsMultiplierControl } from "./FpsMultiplierControl";
export { ConfigurationTab } from "./ConfigurationTab";
diff --git a/src/hooks/useInstallationActions.ts b/src/hooks/useInstallationActions.ts
deleted file mode 100644
index 41189bd..0000000
--- a/src/hooks/useInstallationActions.ts
+++ /dev/null
@@ -1,84 +0,0 @@
-import { useState } from "react";
-import { installLsfgVk, uninstallLsfgVk } from "../api/lsfgApi";
-import {
- showInstallSuccessToast,
- showInstallErrorToast,
- showUninstallSuccessToast,
- showUninstallErrorToast
-} from "../utils/toastUtils";
-
-export function useInstallationActions() {
- const [isInstalling, setIsInstalling] = useState(false);
- const [isUninstalling, setIsUninstalling] = useState(false);
-
- const handleInstall = async (
- setIsInstalled: (value: boolean) => void,
- setInstallationStatus: (value: string) => void,
- reloadConfig?: () => Promise,
- reloadStatus?: () => Promise
- ) => {
- setIsInstalling(true);
- setInstallationStatus("Installing lsfg-vk...");
-
- try {
- const result = await installLsfgVk();
- if (result.success) {
- setIsInstalled(true);
- setInstallationStatus("lsfg-vk installed");
- showInstallSuccessToast();
-
- // Reload lsfg config after installation
- if (reloadConfig) {
- await reloadConfig();
- }
- if (reloadStatus) {
- await reloadStatus();
- }
- } else {
- setInstallationStatus(`Installation failed: ${result.error}`);
- showInstallErrorToast(result.error);
- }
- } catch (error) {
- setInstallationStatus(`Installation failed: ${error}`);
- showInstallErrorToast(String(error));
- } finally {
- setIsInstalling(false);
- }
- };
-
- const handleUninstall = async (
- setIsInstalled: (value: boolean) => void,
- setInstallationStatus: (value: string) => void,
- reloadStatus?: () => Promise
- ) => {
- setIsUninstalling(true);
- setInstallationStatus("Uninstalling lsfg-vk...");
-
- try {
- const result = await uninstallLsfgVk();
- if (result.success) {
- setIsInstalled(false);
- setInstallationStatus("lsfg-vk uninstalled successfully!");
- if (reloadStatus) {
- await reloadStatus();
- }
- showUninstallSuccessToast();
- } else {
- setInstallationStatus(`Uninstallation failed: ${result.error}`);
- showUninstallErrorToast(result.error);
- }
- } catch (error) {
- setInstallationStatus(`Uninstallation failed: ${error}`);
- showUninstallErrorToast(String(error));
- } finally {
- setIsUninstalling(false);
- }
- };
-
- return {
- isInstalling,
- isUninstalling,
- handleInstall,
- handleUninstall
- };
-}
diff --git a/src/hooks/useLsfgHooks.ts b/src/hooks/useLsfgHooks.ts
index 0b71ee9..73cfa0c 100644
--- a/src/hooks/useLsfgHooks.ts
+++ b/src/hooks/useLsfgHooks.ts
@@ -1,16 +1,26 @@
-import { useState, useEffect } from "react";
+import { useEffect, useState } from "react";
import {
checkLsfgVkInstalled,
getLosslessScalingBranchStatus,
- type SteamBranchStatus
+ installLsfgVk,
+ uninstallLsfgVk,
+ type SteamBranchStatus,
} from "../api/lsfgApi";
+import {
+ showInstallErrorToast,
+ showInstallSuccessToast,
+ showUninstallErrorToast,
+ showUninstallSuccessToast,
+} from "../utils/toastUtils";
-export function useInstallationStatus() {
- const [isInstalled, setIsInstalled] = useState(false);
- const [installationStatus, setInstallationStatus] = useState("");
- const [losslessScalingInstalled, setLosslessScalingInstalled] = useState(false);
- const [losslessScalingStatus, setLosslessScalingStatus] = useState("");
+export function useInstallation(reloadConfig?: () => Promise) {
+ const [isInstalled, setIsInstalled] = useState(false);
+ const [installationStatus, setInstallationStatus] = useState("");
+ const [losslessScalingInstalled, setLosslessScalingInstalled] = useState(false);
+ const [losslessScalingStatus, setLosslessScalingStatus] = useState("");
const [steamBranchStatus, setSteamBranchStatus] = useState(null);
+ const [isInstalling, setIsInstalling] = useState(false);
+ const [isUninstalling, setIsUninstalling] = useState(false);
const checkInstallation = async () => {
try {
@@ -25,13 +35,9 @@ export function useInstallationStatus() {
setIsInstalled(status.installed);
setLosslessScalingInstalled(status.lossless_scaling_installed);
setLosslessScalingStatus(status.lossless_scaling_status || "Lossless Scaling Not Installed");
- if (status.installed) {
- setInstallationStatus("lsfg-vk Installed");
- } else {
- setInstallationStatus("lsfg-vk Not Installed");
- }
+ setInstallationStatus(status.installed ? "lsfg-vk Installed" : "lsfg-vk Not Installed");
return status.installed;
- } catch (error) {
+ } catch {
setSteamBranchStatus(null);
setLosslessScalingInstalled(false);
setLosslessScalingStatus("Lossless Scaling Not Installed");
@@ -41,17 +47,64 @@ export function useInstallationStatus() {
};
useEffect(() => {
- checkInstallation();
+ void checkInstallation();
}, []);
+ const install = async () => {
+ setIsInstalling(true);
+ setInstallationStatus("Installing lsfg-vk...");
+ try {
+ const result = await installLsfgVk();
+ if (!result.success) {
+ setInstallationStatus(`Installation failed: ${result.error}`);
+ showInstallErrorToast(result.error);
+ return;
+ }
+ setIsInstalled(true);
+ setInstallationStatus("lsfg-vk installed");
+ showInstallSuccessToast();
+ await reloadConfig?.();
+ await checkInstallation();
+ } catch (error) {
+ setInstallationStatus(`Installation failed: ${error}`);
+ showInstallErrorToast(String(error));
+ } finally {
+ setIsInstalling(false);
+ }
+ };
+
+ const uninstall = async () => {
+ setIsUninstalling(true);
+ setInstallationStatus("Uninstalling lsfg-vk...");
+ try {
+ const result = await uninstallLsfgVk();
+ if (!result.success) {
+ setInstallationStatus(`Uninstallation failed: ${result.error}`);
+ showUninstallErrorToast(result.error);
+ return;
+ }
+ setIsInstalled(false);
+ setInstallationStatus("lsfg-vk uninstalled successfully!");
+ await checkInstallation();
+ showUninstallSuccessToast();
+ } catch (error) {
+ setInstallationStatus(`Uninstallation failed: ${error}`);
+ showUninstallErrorToast(String(error));
+ } finally {
+ setIsUninstalling(false);
+ }
+ };
+
return {
isInstalled,
installationStatus,
- setIsInstalled,
- setInstallationStatus,
losslessScalingInstalled,
losslessScalingStatus,
steamBranchStatus,
- checkInstallation
+ isInstalling,
+ isUninstalling,
+ install,
+ uninstall,
+ checkInstallation,
};
}
diff --git a/src/utils/steamLaunchOptions.ts b/src/utils/steamLaunchOptions.ts
index e00b32d..0af1bbf 100644
--- a/src/utils/steamLaunchOptions.ts
+++ b/src/utils/steamLaunchOptions.ts
@@ -12,27 +12,14 @@ export const LEGACY_WRAPPER_TOKENS = new Set([
]);
const LEGACY_ABSOLUTE_WRAPPER = /^\/(?:home|Users)\/[^/]+\/(?:lsfg|\.local\/bin\/(?:lsfg|lsfg-vk-experimental|mako-run|mako-launch))$/;
-
const MANAGED_ENV_KEYS = new Set([
- "ENABLE_GAMESCOPE_WSI",
- "DISABLE_GAMESCOPE_WSI",
- "DXVK_HDR",
- "SteamDeck",
- "DISABLE_VKBASALT",
- "ENABLE_VKBASALT",
- "MESA_LOADER_DRIVER_OVERRIDE",
- "__GLX_VENDOR_LIBRARY_NAME",
- "GALLIUM_DRIVER",
- "DXVK_FRAME_RATE",
+ "ENABLE_GAMESCOPE_WSI", "DISABLE_GAMESCOPE_WSI", "DXVK_HDR", "SteamDeck",
+ "DISABLE_VKBASALT", "ENABLE_VKBASALT", "MESA_LOADER_DRIVER_OVERRIDE",
+ "__GLX_VENDOR_LIBRARY_NAME", "GALLIUM_DRIVER", "DXVK_FRAME_RATE",
]);
-
const DXVK_FRAME_RATE_SEGMENT = /^(?:dxvk\.maxFrameRate|dxgi\.maxFrameRate|d3d9\.maxFrameRate)\s*=/i;
-interface LaunchToken {
- raw: string;
- value: string;
-}
-
+interface LaunchToken { raw: string; value: string; }
export interface SteamLaunchOptionsSnapshot {
appId: number;
nonSteam: boolean;
@@ -40,42 +27,33 @@ export interface SteamLaunchOptionsSnapshot {
target: string;
details: SteamAppDetails;
}
-
export interface WrapperIntegrationResult {
snapshot: SteamLaunchOptionsSnapshot;
originalExecutable?: string;
commandTokenAdded: boolean;
}
-function validateAppId(appId: number): void {
- if (!Number.isSafeInteger(appId) || appId <= 0) throw new Error("Invalid Steam App ID");
+function asError(error: unknown): Error {
+ return error instanceof Error ? error : new Error(String(error));
}
-function getSteamApps(): Partial | undefined {
- return (globalThis as typeof globalThis & {
- SteamClient?: { Apps?: Partial };
- }).SteamClient?.Apps;
+function apps(): Partial | undefined {
+ return (globalThis as typeof globalThis & { SteamClient?: { Apps?: Partial } }).SteamClient?.Apps;
}
-interface TimerHost {
- setTimeout(handler: () => void, timeout: number): number;
- clearTimeout(timeout: number): void;
+function validateAppId(appId: number): void {
+ if (!Number.isSafeInteger(appId) || appId <= 0) throw new Error("Invalid Steam App ID");
}
-function timerHost(): TimerHost {
- if (typeof window !== "undefined") {
- return {
- setTimeout: (handler, timeout) => window.setTimeout(handler, timeout),
- clearTimeout: (timeout) => window.clearTimeout(timeout),
- };
- }
+function timer() {
+ const host = typeof window !== "undefined" ? window : globalThis;
return {
- setTimeout: (handler, timeout) => globalThis.setTimeout(handler, timeout) as unknown as number,
- clearTimeout: (timeout) => globalThis.clearTimeout(timeout),
+ set: (handler: () => void, ms: number) => host.setTimeout(handler, ms) as unknown as number,
+ clear: (id: number) => host.clearTimeout(id),
};
}
-function snapshotFromDetails(appId: number, nonSteam: boolean, details: SteamAppDetails): SteamLaunchOptionsSnapshot {
+function snapshot(appId: number, nonSteam: boolean, details: SteamAppDetails): SteamLaunchOptionsSnapshot {
return {
appId,
nonSteam,
@@ -85,73 +63,39 @@ function snapshotFromDetails(appId: number, nonSteam: boolean, details: SteamApp
};
}
-function asError(error: unknown): Error {
- return error instanceof Error ? error : new Error(String(error));
-}
-
-function registerSteamAppDetails(
- appId: number,
- onDetails: (details: SteamAppDetails) => boolean | void,
-): () => void {
+function registerDetails(appId: number, onDetails: (details: SteamAppDetails) => boolean | void): () => void {
validateAppId(appId);
- const apps = getSteamApps();
- const registerForAppDetails = apps?.RegisterForAppDetails;
- if (!registerForAppDetails) throw new Error("Steam app-details API is unavailable");
-
+ const register = apps()?.RegisterForAppDetails;
+ if (!register) throw new Error("Steam app-details API is unavailable");
let active = true;
- let unregisterPending = false;
let registration: SteamAppDetailsRegistration | undefined;
const unsubscribe = () => {
active = false;
- if (!registration) {
- unregisterPending = true;
- return;
- }
- try {
- registration.unregister();
- } catch {
- // Steam can invalidate a registration while details are refreshing.
- }
+ try { registration?.unregister(); } catch {}
};
-
- try {
- registration = registerForAppDetails.call(apps, appId, (details) => {
- if (!active) return;
- if (onDetails(details || {}) === false && active) unsubscribe();
- });
- if (unregisterPending) {
- try {
- registration.unregister();
- } catch {
- // A synchronous callback can invalidate the registration before return.
- }
- }
- } catch (error) {
- throw asError(error);
- }
+ registration = register.call(apps(), appId, (details) => {
+ if (active && onDetails(details || {}) === false) unsubscribe();
+ });
+ if (!active) unsubscribe();
return unsubscribe;
}
export async function readSteamLaunchOptions(appId: number, nonSteam: boolean): Promise {
return new Promise((resolve, reject) => {
- let settled = false;
- let timeout: number | undefined;
+ let done = false;
let unsubscribe = () => {};
+ const clock = timer();
+ const timeout = clock.set(() => finish(new Error("Timed out reading Steam app details")), 5000);
const finish = (error?: unknown, details?: SteamAppDetails) => {
- if (settled) return;
- settled = true;
- if (timeout !== undefined) timerHost().clearTimeout(timeout);
+ if (done) return;
+ done = true;
+ clock.clear(timeout);
unsubscribe();
- if (error) {
- reject(asError(error));
- return;
- }
- resolve(snapshotFromDetails(appId, nonSteam, details || {}));
+ if (error) reject(asError(error));
+ else resolve(snapshot(appId, nonSteam, details || {}));
};
-
- timeout = timerHost().setTimeout(() => finish(new Error("Timed out reading Steam app details")), 5000);
try {
- unsubscribe = registerSteamAppDetails(appId, (details) => {
+ unsubscribe = registerDetails(appId, (details) => {
finish(undefined, details);
return false;
});
@@ -164,34 +108,24 @@ export async function readSteamLaunchOptions(appId: number, nonSteam: boolean):
export function subscribeSteamLaunchOptions(
appId: number,
nonSteam: boolean,
- onSnapshot: (snapshot: SteamLaunchOptionsSnapshot) => void,
+ onSnapshot: (value: SteamLaunchOptionsSnapshot) => void,
onError: (error: Error) => void,
): () => void {
- return registerSteamAppDetails(appId, (details) => {
- try {
- onSnapshot(snapshotFromDetails(appId, nonSteam, details));
- } catch (error) {
- onError(asError(error));
- }
+ return registerDetails(appId, (details) => {
+ try { onSnapshot(snapshot(appId, nonSteam, details)); }
+ catch (error) { onError(asError(error)); }
});
}
function decodeToken(raw: string): string {
let value = "";
let quote: "'" | '"' | null = null;
- for (let index = 0; index < raw.length; index += 1) {
- const character = raw[index];
- if (character === "\\" && quote !== "'" && index + 1 < raw.length) {
- value += raw[index + 1];
- index += 1;
- } else if (quote !== null) {
- if (character === quote) quote = null;
- else value += character;
- } else if (character === "'" || character === '"') {
- quote = character;
- } else {
- value += character;
- }
+ for (let i = 0; i < raw.length; i++) {
+ const c = raw[i];
+ if (c === "\\" && quote !== "'" && i + 1 < raw.length) value += raw[++i];
+ else if (quote) { if (c === quote) quote = null; else value += c; }
+ else if (c === "'" || c === '"') quote = c;
+ else value += c;
}
return value;
}
@@ -201,299 +135,184 @@ function tokenize(options: string): LaunchToken[] {
let start = -1;
let quote: "'" | '"' | null = null;
let escaped = false;
- for (let index = 0; index < options.length; index += 1) {
- const character = options[index];
- if (start < 0) {
- if (/\s/.test(character)) continue;
- start = index;
- }
- if (escaped) escaped = false;
- else if (character === "\\" && quote !== "'") escaped = true;
- else if (quote !== null) {
- if (character === quote) quote = null;
- } else if (character === "'" || character === '"') quote = character;
- else if (/\s/.test(character)) {
- const raw = options.slice(start, index);
- tokens.push({ raw, value: decodeToken(raw) });
- start = -1;
- }
- }
- if (start >= 0) {
- const raw = options.slice(start);
+ const push = (end: number) => {
+ if (start < 0) return;
+ const raw = options.slice(start, end);
tokens.push({ raw, value: decodeToken(raw) });
+ start = -1;
+ };
+ for (let i = 0; i < options.length; i++) {
+ const c = options[i];
+ if (start < 0) { if (/\s/.test(c)) continue; start = i; }
+ if (escaped) escaped = false;
+ else if (c === "\\" && quote !== "'") escaped = true;
+ else if (quote) { if (c === quote) quote = null; }
+ else if (c === "'" || c === '"') quote = c;
+ else if (/\s/.test(c)) push(i);
}
+ push(options.length);
return tokens;
}
-function serialize(tokens: readonly LaunchToken[]): string {
- return tokens.map((token) => token.raw).join(" ");
-}
-
-export function normalizeLaunchOptions(options: string): string {
- return serialize(tokenize(options));
-}
-
-function isCommandToken(token: LaunchToken): boolean {
- return token.raw.toLowerCase() === COMMAND_TOKEN;
-}
+const serialize = (tokens: readonly LaunchToken[]) => tokens.map(({ raw }) => raw).join(" ");
+const commandIndex = (tokens: readonly LaunchToken[]) => tokens.findIndex((token) => token.raw.toLowerCase() === COMMAND_TOKEN);
+const isAssignment = (token: LaunchToken) => /^[A-Za-z_][A-Za-z0-9_]*=/.test(token.value);
+const isLegacyToken = (value: string) => LEGACY_WRAPPER_TOKENS.has(value) || LEGACY_ABSOLUTE_WRAPPER.test(value);
+const isWrapperToken = (value: string, wrapperPath: string) => decodeToken(value) === wrapperPath || isLegacyWrapperToken(value);
-function commandIndex(tokens: readonly LaunchToken[]): number {
- return tokens.findIndex(isCommandToken);
-}
+export const normalizeLaunchOptions = (options: string) => serialize(tokenize(options));
+export const isLegacyWrapperToken = (value: string) => isLegacyToken(decodeToken(value));
-function isAssignment(token: LaunchToken): boolean {
- return /^[A-Za-z_][A-Za-z0-9_]*=/.test(token.value);
-}
-
-function isLegacyToken(value: string): boolean {
- return LEGACY_WRAPPER_TOKENS.has(value) || LEGACY_ABSOLUTE_WRAPPER.test(value);
-}
-
-export function isLegacyWrapperToken(value: string): boolean {
- return isLegacyToken(decodeToken(value));
-}
-
-function isWrapperToken(value: string, wrapperPath: string): boolean {
- return decodeToken(value) === wrapperPath || isLegacyWrapperToken(value);
-}
-
-function removeWrapperTokens(tokens: LaunchToken[], wrapperPath: string): boolean {
- const index = commandIndex(tokens);
- const prefixEnd = index >= 0 ? index : tokens.length;
- const retained = tokens.filter((token, tokenIndex) => tokenIndex >= prefixEnd || !isWrapperToken(token.value, wrapperPath));
- if (retained.length === tokens.length) return false;
- tokens.splice(0, tokens.length, ...retained);
+function removeMatchingWrappers(tokens: LaunchToken[], predicate: (value: string) => boolean): boolean {
+ const command = commandIndex(tokens);
+ const prefixEnd = command >= 0 ? command : tokens.length;
+ const kept = tokens.filter((token, i) => i >= prefixEnd || !predicate(token.value));
+ if (kept.length === tokens.length) return false;
+ tokens.splice(0, tokens.length, ...kept);
return true;
}
-function removeLegacyTokens(tokens: LaunchToken[]): boolean {
- const index = commandIndex(tokens);
- const prefixEnd = index >= 0 ? index : tokens.length;
- const retained = tokens.filter((token, tokenIndex) => tokenIndex >= prefixEnd || !isLegacyToken(token.value));
- if (retained.length === tokens.length) return false;
- tokens.splice(0, tokens.length, ...retained);
- return true;
-}
-
-function leadingAssignments(tokens: readonly LaunchToken[]): number {
- let count = 0;
- while (count < tokens.length && isAssignment(tokens[count])) count += 1;
- return count;
-}
-
-function wrapperToken(wrapperPath: string): LaunchToken {
- return { raw: wrapperPath, value: wrapperPath };
-}
-
-export interface LaunchOptionRewrite {
- options: string;
- commandTokenAdded: boolean;
-}
-
-/** Add one exact wrapper token immediately before Steam's command macro. */
-export function installWrapperLaunchOption(options: string, wrapperPath = DEFAULT_WRAPPER_PATH): LaunchOptionRewrite {
+export function installWrapperLaunchOption(options: string, wrapperPath = DEFAULT_WRAPPER_PATH) {
const tokens = tokenize(options);
- removeLegacyTokens(tokens);
- let index = commandIndex(tokens);
- if (index >= 0) {
- const currentWrapper = tokens[index - 1];
- if (currentWrapper && currentWrapper.value === wrapperPath) {
- return { options: serialize(tokens), commandTokenAdded: false };
- }
- const retained = tokens.filter((token, tokenIndex) => tokenIndex >= index || token.value !== wrapperPath);
- tokens.splice(0, tokens.length, ...retained);
- index = commandIndex(tokens);
- tokens.splice(index, 0, wrapperToken(wrapperPath));
+ removeMatchingWrappers(tokens, isLegacyToken);
+ let command = commandIndex(tokens);
+ if (command >= 0) {
+ if (tokens[command - 1]?.value === wrapperPath) return { options: serialize(tokens), commandTokenAdded: false };
+ removeMatchingWrappers(tokens, (value) => decodeToken(value) === wrapperPath);
+ command = commandIndex(tokens);
+ tokens.splice(command, 0, { raw: wrapperPath, value: wrapperPath });
return { options: serialize(tokens), commandTokenAdded: false };
}
-
- const insertion = leadingAssignments(tokens);
- const argumentsOnly = insertion === tokens.length || tokens[insertion]?.value.startsWith("-");
- if (tokens.length !== insertion && !argumentsOnly) {
+ let insertion = 0;
+ while (insertion < tokens.length && isAssignment(tokens[insertion])) insertion++;
+ if (insertion < tokens.length && !tokens[insertion].value.startsWith("-")) {
throw new Error("Launch options do not contain %command%; refusing to guess a launcher command");
}
- tokens.splice(insertion, 0, wrapperToken(wrapperPath), { raw: COMMAND_TOKEN, value: COMMAND_TOKEN });
+ tokens.splice(insertion, 0,
+ { raw: wrapperPath, value: wrapperPath },
+ { raw: COMMAND_TOKEN, value: COMMAND_TOKEN },
+ );
return { options: serialize(tokens), commandTokenAdded: true };
}
-/** Remove the wrapper and known legacy tokens, preserving the user's arguments. */
export function removeWrapperLaunchOption(
options: string,
wrapperPath = DEFAULT_WRAPPER_PATH,
commandTokenAdded = false,
): string {
const tokens = tokenize(options);
- const removed = removeWrapperTokens(tokens, wrapperPath);
- if (removed && commandTokenAdded) {
- const index = commandIndex(tokens);
- if (index >= 0) tokens.splice(index, 1);
+ if (removeMatchingWrappers(tokens, (value) => isWrapperToken(value, wrapperPath)) && commandTokenAdded) {
+ const command = commandIndex(tokens);
+ if (command >= 0) tokens.splice(command, 1);
}
return serialize(tokens);
}
function encodeAssignmentValue(value: string): string {
- if (/^[A-Za-z0-9_./:+,%=-]+$/.test(value)) return value;
- return `"${value.replace(/\\/g, "\\\\").replace(/"/g, '\\"')}"`;
-}
-
-function cleanDxvkConfigValue(value: string): string | null {
- const retained = value
- .split(";")
- .map((segment) => segment.trim())
- .filter((segment) => segment && !DXVK_FRAME_RATE_SEGMENT.test(segment));
- return retained.length > 0 ? retained.join("; ") : null;
+ return /^[A-Za-z0-9_./:+,%=-]+$/.test(value)
+ ? value
+ : `"${value.replace(/\\/g, "\\\\").replace(/"/g, '\\"')}"`;
}
-/** Remove only the old plugin's direct assignments; unrelated prefixes remain. */
export function cleanupPluginAssignments(options: string): string {
const tokens = tokenize(options);
- const index = commandIndex(tokens);
- const prefixEnd = index >= 0 ? index : tokens.length;
- const retained: LaunchToken[] = [];
- for (let tokenIndex = 0; tokenIndex < tokens.length; tokenIndex += 1) {
- const token = tokens[tokenIndex];
- if (tokenIndex >= prefixEnd || !isAssignment(token)) {
- retained.push(token);
- continue;
- }
- const separator = token.value.indexOf("=");
- const key = token.value.slice(0, separator);
+ const command = commandIndex(tokens);
+ const prefixEnd = command >= 0 ? command : tokens.length;
+ return serialize(tokens.flatMap((token, i) => {
+ if (i >= prefixEnd || !isAssignment(token)) return [token];
+ const split = token.value.indexOf("=");
+ const key = token.value.slice(0, split);
if (key === "DXVK_CONFIG") {
- const cleaned = cleanDxvkConfigValue(token.value.slice(separator + 1));
- if (cleaned) retained.push({ raw: `DXVK_CONFIG=${encodeAssignmentValue(cleaned)}`, value: `DXVK_CONFIG=${cleaned}` });
- continue;
+ const value = token.value.slice(split + 1).split(";").map((part) => part.trim())
+ .filter((part) => part && !DXVK_FRAME_RATE_SEGMENT.test(part)).join("; ");
+ return value ? [{ raw: `DXVK_CONFIG=${encodeAssignmentValue(value)}`, value: `DXVK_CONFIG=${value}` }] : [];
}
- if (!MANAGED_ENV_KEYS.has(key)) retained.push(token);
- }
- return serialize(retained);
+ return MANAGED_ENV_KEYS.has(key) ? [] : [token];
+ }));
}
export function cleanupLegacyLaunchOptions(options: string): string {
const tokens = tokenize(options);
- removeLegacyTokens(tokens);
+ removeMatchingWrappers(tokens, isLegacyToken);
return serialize(tokens);
}
-
-export function cleanupPluginLaunchOptions(options: string, wrapperPath = DEFAULT_WRAPPER_PATH): string {
- const tokens = tokenize(options);
- removeWrapperTokens(tokens, wrapperPath);
- return cleanupPluginAssignments(serialize(tokens));
-}
-
-export function cleanupLegacyWrapper(options: string, wrapperPath = DEFAULT_WRAPPER_PATH): string {
- return cleanupPluginLaunchOptions(options, wrapperPath);
-}
-
+export const cleanupPluginLaunchOptions = (options: string, wrapperPath = DEFAULT_WRAPPER_PATH) =>
+ cleanupPluginAssignments(removeWrapperLaunchOption(options, wrapperPath));
+export const cleanupLegacyWrapper = cleanupPluginLaunchOptions;
export function hasWrapperLaunchIntegration(options: string, wrapperPath = DEFAULT_WRAPPER_PATH): boolean {
const tokens = tokenize(options);
- const index = commandIndex(tokens);
- return index > 0 && tokens[index - 1].value === wrapperPath;
-}
-
-function delay(milliseconds: number): Promise {
- return new Promise((resolve) => timerHost().setTimeout(resolve, milliseconds));
-}
-
-async function setSteamLaunchOptions(appId: number, nonSteam: boolean, options: string): Promise {
- const apps = getSteamApps();
- const setter = nonSteam ? apps?.SetShortcutLaunchOptions : apps?.SetAppLaunchOptions;
- if (!setter) throw new Error(`Steam ${nonSteam ? "shortcut " : ""}launch options API is unavailable`);
- await Promise.resolve(setter.call(apps, appId, options));
+ const command = commandIndex(tokens);
+ return command > 0 && tokens[command - 1].value === wrapperPath;
}
-async function setShortcutExecutable(appId: number, executable: string): Promise {
- const apps = getSteamApps();
- if (!apps?.SetShortcutExe) throw new Error("Steam shortcut Target API is unavailable");
- await Promise.resolve(apps.SetShortcutExe.call(apps, appId, executable));
+const queues = new Map>();
+function queued(appId: number, nonSteam: boolean, operation: () => Promise): Promise {
+ const key = `${nonSteam ? "shortcut" : "app"}:${appId}`;
+ const previous = queues.get(key) || Promise.resolve();
+ const current = previous.catch(() => undefined).then(operation);
+ const cleanup = current.then(
+ () => { if (queues.get(key) === cleanup) queues.delete(key); },
+ () => { if (queues.get(key) === cleanup) queues.delete(key); },
+ );
+ queues.set(key, cleanup);
+ return current;
}
-async function waitForSnapshot(
+async function waitFor(
appId: number,
nonSteam: boolean,
- matches: (snapshot: SteamLaunchOptionsSnapshot) => boolean,
+ matches: (value: SteamLaunchOptionsSnapshot) => boolean,
message: string,
): Promise {
const deadline = Date.now() + 5000;
let lastError: Error | null = null;
while (Date.now() <= deadline) {
try {
- const snapshot = await readSteamLaunchOptions(appId, nonSteam);
- if (matches(snapshot)) return snapshot;
- } catch (error) {
- lastError = asError(error);
- }
- if (Date.now() >= deadline) break;
- await delay(100);
+ const value = await readSteamLaunchOptions(appId, nonSteam);
+ if (matches(value)) return value;
+ } catch (error) { lastError = asError(error); }
+ if (Date.now() < deadline) await new Promise((resolve) => timer().set(resolve as () => void, 100));
}
- if (lastError) throw new Error(`${message}: ${lastError.message}`);
- throw new Error(`${message} before the readback timeout`);
+ throw lastError ? new Error(`${message}: ${lastError.message}`) : new Error(`${message} before the readback timeout`);
}
-async function writeLaunchOptionsAndVerify(
+async function writeVerified(
appId: number,
nonSteam: boolean,
previous: string,
next: string,
+ write: (value: string) => Promise,
+ read: (value: SteamLaunchOptionsSnapshot) => string,
message: string,
): Promise {
+ const normalized = read === readOptions ? normalizeLaunchOptions : (value: string) => value;
try {
- await setSteamLaunchOptions(appId, nonSteam, next);
- return await waitForSnapshot(
- appId,
- nonSteam,
- (snapshot) => normalizeLaunchOptions(snapshot.options) === normalizeLaunchOptions(next),
- message,
- );
- } catch (error) {
- const failure = asError(error);
- try {
- await setSteamLaunchOptions(appId, nonSteam, previous);
- await waitForSnapshot(
- appId,
- nonSteam,
- (snapshot) => normalizeLaunchOptions(snapshot.options) === normalizeLaunchOptions(previous),
- "Steam did not restore the previous launch options",
- );
- } catch (rollbackError) {
- throw new Error(`${failure.message}; rollback also failed: ${asError(rollbackError).message}`);
- }
- throw failure;
- }
-}
-
-async function writeShortcutExecutableAndVerify(
- appId: number,
- previous: string,
- next: string,
- message: string,
-): Promise {
- try {
- await setShortcutExecutable(appId, next);
- return await waitForSnapshot(appId, true, (snapshot) => snapshot.target === next, message);
+ await write(next);
+ return await waitFor(appId, nonSteam, (value) => normalized(read(value)) === normalized(next), message);
} catch (error) {
const failure = asError(error);
try {
- await setShortcutExecutable(appId, previous);
- await waitForSnapshot(appId, true, (snapshot) => snapshot.target === previous, "Steam did not restore the previous shortcut Target");
- } catch (rollbackError) {
- throw new Error(`${failure.message}; rollback also failed: ${asError(rollbackError).message}`);
+ await write(previous);
+ await waitFor(appId, nonSteam, (value) => normalized(read(value)) === normalized(previous), `Steam did not restore the previous ${read === readOptions ? "launch options" : "shortcut Target"}`);
+ } catch (rollback) {
+ throw new Error(`${failure.message}; rollback also failed: ${asError(rollback).message}`);
}
throw failure;
}
}
-const operationQueues = new Map>();
+const readOptions = (value: SteamLaunchOptionsSnapshot) => value.options;
+const readTarget = (value: SteamLaunchOptionsSnapshot) => value.target;
-function queueSteamOperation(appId: number, nonSteam: boolean, operation: () => Promise): Promise {
- const key = `${nonSteam ? "shortcut" : "app"}:${appId}`;
- const previous = operationQueues.get(key) || Promise.resolve();
- const queued = previous.catch(() => undefined).then(operation);
- const cleanup = queued.then(
- () => { if (operationQueues.get(key) === cleanup) operationQueues.delete(key); },
- () => { if (operationQueues.get(key) === cleanup) operationQueues.delete(key); },
- );
- operationQueues.set(key, cleanup);
- return queued;
+function writeOptions(appId: number, nonSteam: boolean, value: string): Promise {
+ const setter = nonSteam ? apps()?.SetShortcutLaunchOptions : apps()?.SetAppLaunchOptions;
+ if (!setter) return Promise.reject(new Error(`Steam ${nonSteam ? "shortcut " : ""}launch options API is unavailable`));
+ return Promise.resolve(setter.call(apps(), appId, value));
+}
+function writeTarget(appId: number, value: string): Promise {
+ const setter = apps()?.SetShortcutExe;
+ if (!setter) return Promise.reject(new Error("Steam shortcut Target API is unavailable"));
+ return Promise.resolve(setter.call(apps(), appId, value));
}
export function updateSteamLaunchOptions(
@@ -501,11 +320,14 @@ export function updateSteamLaunchOptions(
nonSteam: boolean,
transform: (options: string) => string,
): Promise {
- return queueSteamOperation(appId, nonSteam, async () => {
+ return queued(appId, nonSteam, async () => {
const current = await readSteamLaunchOptions(appId, nonSteam);
const next = transform(current.options);
- if (next === current.options) return current;
- return writeLaunchOptionsAndVerify(appId, nonSteam, current.options, next, "Steam did not accept the launch options");
+ return next === current.options ? current : writeVerified(
+ appId, nonSteam, current.options, next,
+ (value) => writeOptions(appId, nonSteam, value), readOptions,
+ "Steam did not accept the launch options",
+ );
});
}
@@ -515,33 +337,41 @@ export function installWrapperIntegration(
wrapperPath: string,
commandTokenAdded = false,
): Promise {
- return queueSteamOperation(appId, nonSteam, async () => {
- const current = await readSteamLaunchOptions(appId, nonSteam);
+ return queued(appId, nonSteam, async () => {
+ let current = await readSteamLaunchOptions(appId, nonSteam);
if (nonSteam) {
if (!current.target) throw new Error("Steam shortcut Target is empty; refusing to replace it");
if (current.target !== wrapperPath && isWrapperToken(current.target, wrapperPath)) {
throw new Error("The shortcut Target points to a legacy frame-generation wrapper; restore it first");
}
- const cleanedOptions = cleanupPluginLaunchOptions(current.options, wrapperPath);
- if (cleanedOptions !== current.options) {
- await writeLaunchOptionsAndVerify(appId, true, current.options, cleanedOptions, "Steam did not accept shortcut launch options");
- }
- if (current.target === wrapperPath) {
- return { snapshot: await readSteamLaunchOptions(appId, true), originalExecutable: undefined, commandTokenAdded: false };
+ const cleaned = cleanupPluginLaunchOptions(current.options, wrapperPath);
+ if (cleaned !== current.options) {
+ current = await writeVerified(
+ appId, true, current.options, cleaned,
+ (value) => writeOptions(appId, true, value), readOptions,
+ "Steam did not accept shortcut launch options",
+ );
}
+ if (current.target === wrapperPath) return { snapshot: current, commandTokenAdded: false };
const originalExecutable = current.target;
- const snapshot = await writeShortcutExecutableAndVerify(appId, originalExecutable, wrapperPath, "Steam did not accept the shortcut Target");
- return { snapshot, originalExecutable, commandTokenAdded: false };
+ const value = await writeVerified(
+ appId, true, originalExecutable, wrapperPath,
+ (target) => writeTarget(appId, target), readTarget,
+ "Steam did not accept the shortcut Target",
+ );
+ return { snapshot: value, originalExecutable, commandTokenAdded: false };
}
const cleaned = cleanupPluginAssignments(cleanupLegacyLaunchOptions(current.options));
const alreadyInstalled = hasWrapperLaunchIntegration(current.options, wrapperPath);
const rewrite = installWrapperLaunchOption(cleaned, wrapperPath);
- if (rewrite.options === current.options) {
- return { snapshot: current, commandTokenAdded };
- }
- const snapshot = await writeLaunchOptionsAndVerify(appId, false, current.options, rewrite.options, "Steam did not accept the launch options");
- return { snapshot, commandTokenAdded: alreadyInstalled ? commandTokenAdded : rewrite.commandTokenAdded };
+ if (rewrite.options === current.options) return { snapshot: current, commandTokenAdded };
+ const value = await writeVerified(
+ appId, false, current.options, rewrite.options,
+ (options) => writeOptions(appId, false, options), readOptions,
+ "Steam did not accept the launch options",
+ );
+ return { snapshot: value, commandTokenAdded: alreadyInstalled ? commandTokenAdded : rewrite.commandTokenAdded };
});
}
@@ -552,8 +382,8 @@ export function removeWrapperIntegration(
originalExecutable?: string,
commandTokenAdded = false,
): Promise {
- return queueSteamOperation(appId, nonSteam, async () => {
- const current = await readSteamLaunchOptions(appId, nonSteam);
+ return queued(appId, nonSteam, async () => {
+ let current = await readSteamLaunchOptions(appId, nonSteam);
if (nonSteam) {
if (!originalExecutable || isWrapperToken(originalExecutable, wrapperPath)) {
throw new Error("Original shortcut Target is unavailable; refusing to overwrite the current Target");
@@ -563,34 +393,32 @@ export function removeWrapperIntegration(
}
const cleaned = cleanupPluginLaunchOptions(current.options, wrapperPath);
if (cleaned !== current.options) {
- await writeLaunchOptionsAndVerify(appId, true, current.options, cleaned, "Steam did not clean shortcut launch options");
+ current = await writeVerified(
+ appId, true, current.options, cleaned,
+ (value) => writeOptions(appId, true, value), readOptions,
+ "Steam did not clean shortcut launch options",
+ );
}
- if (current.target === originalExecutable) {
- return readSteamLaunchOptions(appId, true);
- }
- return writeShortcutExecutableAndVerify(appId, wrapperPath, originalExecutable, "Steam did not restore the shortcut Target");
+ if (current.target === originalExecutable) return current;
+ return writeVerified(
+ appId, true, wrapperPath, originalExecutable,
+ (target) => writeTarget(appId, target), readTarget,
+ "Steam did not restore the shortcut Target",
+ );
}
-
- const withoutWrapper = removeWrapperLaunchOption(current.options, wrapperPath, commandTokenAdded);
- const next = cleanupPluginAssignments(withoutWrapper);
- if (next === current.options) return current;
- return writeLaunchOptionsAndVerify(appId, false, current.options, next, "Steam did not clean the launch options");
+ const next = cleanupPluginAssignments(removeWrapperLaunchOption(current.options, wrapperPath, commandTokenAdded));
+ return next === current.options ? current : writeVerified(
+ appId, false, current.options, next,
+ (options) => writeOptions(appId, false, options), readOptions,
+ "Steam did not clean the launch options",
+ );
});
}
-export function cleanupLegacySteamLaunchOptions(
+export const cleanupLegacySteamLaunchOptions = (
appId: number,
nonSteam: boolean,
wrapperPath = DEFAULT_WRAPPER_PATH,
-): Promise {
- return queueSteamOperation(appId, nonSteam, async () => {
- const current = await readSteamLaunchOptions(appId, nonSteam);
- const next = cleanupPluginLaunchOptions(current.options, wrapperPath);
- if (next === current.options) return current;
- return writeLaunchOptionsAndVerify(appId, nonSteam, current.options, next, "Steam did not clean legacy launch options");
- });
-}
+) => updateSteamLaunchOptions(appId, nonSteam, (options) => cleanupPluginLaunchOptions(options, wrapperPath));
-export function getDefaultWrapperPath(): string {
- return DEFAULT_WRAPPER_PATH;
-}
+export const getDefaultWrapperPath = () => DEFAULT_WRAPPER_PATH;
diff --git a/src/utils/toastUtils.ts b/src/utils/toastUtils.ts
index cbbbc55..3468064 100644
--- a/src/utils/toastUtils.ts
+++ b/src/utils/toastUtils.ts
@@ -1,8 +1,3 @@
-/**
- * Centralized toast notification utilities
- * Provides consistent success/error messaging patterns
- */
-
import { toaster } from "@decky/api";
export interface ToastOptions {
@@ -10,84 +5,44 @@ export interface ToastOptions {
body: string;
}
-/**
- * Show a success toast notification
- */
-export function showSuccessToast(title: string, body: string): void {
- toaster.toast({
- title,
- body
- });
-}
+const showToast = (title: string, body: string): void => toaster.toast({ title, body });
+export const showSuccessToast = showToast;
+export const showErrorToast = showToast;
-/**
- * Show an error toast notification
- */
-export function showErrorToast(title: string, body: string): void {
- toaster.toast({
- title,
- body
- });
-}
-
-/**
- * Standard success messages for common operations
- */
export const ToastMessages = {
INSTALL_SUCCESS: {
title: "Installation Complete",
- body: "lsfg-vk has been installed successfully"
+ body: "lsfg-vk has been installed successfully",
},
INSTALL_ERROR: {
title: "Installation Failed",
- body: "Unknown error occurred"
+ body: "Unknown error occurred",
},
UNINSTALL_SUCCESS: {
- title: "Uninstallation Complete",
- body: "lsfg-vk has been uninstalled successfully"
+ title: "Uninstallation Complete",
+ body: "lsfg-vk has been uninstalled successfully",
},
UNINSTALL_ERROR: {
title: "Uninstallation Failed",
- body: "Unknown error occurred"
+ body: "Unknown error occurred",
},
CONFIG_UPDATE_ERROR: {
title: "Update Failed",
- body: "Failed to update configuration"
- }
+ body: "Failed to update configuration",
+ },
} as const;
-/**
- * Show a toast with dynamic error message
- */
-export function showErrorToastWithMessage(title: string, error: unknown): void {
- const errorMessage = error instanceof Error ? error.message : String(error);
- showErrorToast(title, errorMessage);
-}
+export const showErrorToastWithMessage = (title: string, error: unknown): void =>
+ showErrorToast(title, error instanceof Error ? error.message : String(error));
-/**
- * Show installation success toast
- */
-export function showInstallSuccessToast(): void {
+export const showInstallSuccessToast = (): void =>
showSuccessToast(ToastMessages.INSTALL_SUCCESS.title, ToastMessages.INSTALL_SUCCESS.body);
-}
-/**
- * Show installation error toast
- */
-export function showInstallErrorToast(error?: string): void {
+export const showInstallErrorToast = (error?: string): void =>
showErrorToast(ToastMessages.INSTALL_ERROR.title, error || ToastMessages.INSTALL_ERROR.body);
-}
-/**
- * Show uninstallation success toast
- */
-export function showUninstallSuccessToast(): void {
+export const showUninstallSuccessToast = (): void =>
showSuccessToast(ToastMessages.UNINSTALL_SUCCESS.title, ToastMessages.UNINSTALL_SUCCESS.body);
-}
-/**
- * Show uninstallation error toast
- */
-export function showUninstallErrorToast(error?: string): void {
+export const showUninstallErrorToast = (error?: string): void =>
showErrorToast(ToastMessages.UNINSTALL_ERROR.title, error || ToastMessages.UNINSTALL_ERROR.body);
-}
--
cgit v1.2.3
From 1c520a2f72d0d25fc63a77e01ae07e5733c6773d Mon Sep 17 00:00:00 2001
From: Kurt Himebauch <136133082+xXJSONDeruloXx@users.noreply.github.com>
Date: Thu, 10 Sep 2026 07:26:02 -0400
Subject: fix: reset unsupported configs during migration
---
py_modules/lsfg_vk/installation.py | 25 ++++++++++++++++---------
1 file changed, 16 insertions(+), 9 deletions(-)
diff --git a/py_modules/lsfg_vk/installation.py b/py_modules/lsfg_vk/installation.py
index 5a583f5..a73706c 100644
--- a/py_modules/lsfg_vk/installation.py
+++ b/py_modules/lsfg_vk/installation.py
@@ -122,17 +122,24 @@ class InstallationService(BaseService):
if missing:
raise OSError("Archive is missing required files: " + ", ".join(missing))
+ def _default_config(self) -> ProfileData:
+ defaults = ConfigurationManager.get_defaults()
+ return ProfileData(
+ profiles={},
+ global_config={"dll": defaults["dll"], "no_fp16": defaults["no_fp16"]},
+ )
+
def _prepare_config(self) -> ProfileData:
- if self.config_file_path.exists():
- profile_data = ConfigurationManager.parse_toml_content_multi_profile(
- self.config_file_path.read_text(encoding="utf-8")
- )
- else:
- defaults = ConfigurationManager.get_defaults()
- profile_data = ProfileData(
- profiles={},
- global_config={"dll": defaults["dll"], "no_fp16": defaults["no_fp16"]},
+ try:
+ profile_data = (
+ ConfigurationManager.parse_toml_content_multi_profile(
+ self.config_file_path.read_text(encoding="utf-8")
+ )
+ if self.config_file_path.exists()
+ else self._default_config()
)
+ except ValueError:
+ profile_data = self._default_config()
self._resolve_dll_path(profile_data)
defaults = ConfigurationManager.get_defaults()
for name, profile in profile_data["profiles"].items():
--
cgit v1.2.3
From 6a927e30f743fac0a5451381ceed7f1d83e94a37 Mon Sep 17 00:00:00 2001
From: xXJSONDeruloXx
Date: Thu, 10 Sep 2026 07:47:39 -0400
Subject: fix: clean up simple migration type errors
---
src/hooks/useLsfgHooks.ts | 4 ++--
src/utils/toastUtils.ts | 4 +++-
2 files changed, 5 insertions(+), 3 deletions(-)
diff --git a/src/hooks/useLsfgHooks.ts b/src/hooks/useLsfgHooks.ts
index 73cfa0c..9beb749 100644
--- a/src/hooks/useLsfgHooks.ts
+++ b/src/hooks/useLsfgHooks.ts
@@ -57,7 +57,7 @@ export function useInstallation(reloadConfig?: () => Promise) {
const result = await installLsfgVk();
if (!result.success) {
setInstallationStatus(`Installation failed: ${result.error}`);
- showInstallErrorToast(result.error);
+ showInstallErrorToast(result.error ?? undefined);
return;
}
setIsInstalled(true);
@@ -80,7 +80,7 @@ export function useInstallation(reloadConfig?: () => Promise) {
const result = await uninstallLsfgVk();
if (!result.success) {
setInstallationStatus(`Uninstallation failed: ${result.error}`);
- showUninstallErrorToast(result.error);
+ showUninstallErrorToast(result.error ?? undefined);
return;
}
setIsInstalled(false);
diff --git a/src/utils/toastUtils.ts b/src/utils/toastUtils.ts
index 3468064..c41f4c0 100644
--- a/src/utils/toastUtils.ts
+++ b/src/utils/toastUtils.ts
@@ -5,7 +5,9 @@ export interface ToastOptions {
body: string;
}
-const showToast = (title: string, body: string): void => toaster.toast({ title, body });
+const showToast = (title: string, body: string): void => {
+ toaster.toast({ title, body });
+};
export const showSuccessToast = showToast;
export const showErrorToast = showToast;
--
cgit v1.2.3
From 840ea2802551a786de9b59f7aa00f04c5f335e2a Mon Sep 17 00:00:00 2001
From: xXJSONDeruloXx
Date: Thu, 10 Sep 2026 07:57:03 -0400
Subject: fix: keep Flatpak runtime controls simple
---
src/components/Content.tsx | 1 -
src/components/SetupTab.tsx | 26 +++++++++-----------------
2 files changed, 9 insertions(+), 18 deletions(-)
diff --git a/src/components/Content.tsx b/src/components/Content.tsx
index d92ef86..e5216ca 100644
--- a/src/components/Content.tsx
+++ b/src/components/Content.tsx
@@ -91,7 +91,6 @@ export function Content() {
isUninstalling={isUninstalling}
onInstall={() => void install()}
onUninstall={() => void uninstall()}
- flatpakRelevant={targets.some((target) => target.transport.kind === "flatpak")}
/>
);
diff --git a/src/components/SetupTab.tsx b/src/components/SetupTab.tsx
index e936049..624be54 100644
--- a/src/components/SetupTab.tsx
+++ b/src/components/SetupTab.tsx
@@ -19,12 +19,10 @@ interface SetupTabProps {
isUninstalling: boolean;
onInstall: () => void;
onUninstall: () => void;
- flatpakRelevant: boolean;
}
-function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
+function FlatpakSupportDiagnostics() {
const [status, setStatus] = useState(null);
- const [advanced, setAdvanced] = useState(false);
const [operation, setOperation] = useState(null);
const refresh = async () => {
@@ -44,10 +42,10 @@ function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
};
useEffect(() => {
- if (relevant) void refresh();
- }, [relevant]);
+ void refresh();
+ }, []);
- if (!relevant || !status?.available) return null;
+ if (!status?.available) return null;
const setEnabled = async (branch: string, enabled: boolean) => {
setOperation(`${enabled ? "enable" : "disable"}-${branch}`);
@@ -63,19 +61,14 @@ function FlatpakSupportDiagnostics({ relevant }: { relevant: boolean }) {
};
return (
-
+
-
- setAdvanced((value) => !value)}>
- {advanced ? "Hide runtime details" : "Show runtime details"}
-
-
- {advanced && status.supported_branches.map((branch) => {
+ {status.supported_branches.map((branch) => {
const installed = status.installed_branches.includes(branch);
const pending = operation?.endsWith(`-${branch}`);
return (
@@ -105,7 +98,6 @@ export function SetupTab(props: SetupTabProps) {
isUninstalling,
onInstall,
onUninstall,
- flatpakRelevant,
} = props;
const losslessScalingAppInstalled = losslessScalingInstalled || steamBranchStatus?.installed === true;
const buttonLabel = isInstalling
@@ -146,7 +138,7 @@ export function SetupTab(props: SetupTabProps) {
-
Date: Thu, 10 Sep 2026 09:53:55 -0400
Subject: simplify unhooked game behavior on mount
---
src/components/ConfigurationTab.tsx | 14 -------------
src/components/Content.tsx | 9 ++++----
src/components/NowPlayingTab.tsx | 42 ++++++-------------------------------
3 files changed, 10 insertions(+), 55 deletions(-)
diff --git a/src/components/ConfigurationTab.tsx b/src/components/ConfigurationTab.tsx
index 8f8690c..8150819 100644
--- a/src/components/ConfigurationTab.tsx
+++ b/src/components/ConfigurationTab.tsx
@@ -37,7 +37,6 @@ export function ConfigurationTab({
const [focusDetailAction, setFocusDetailAction] = useState<"enable" | "fps" | null>(null);
const [focusConfiguredToggle, setFocusConfiguredToggle] = useState(false);
const enableRef = useRef(null);
- const promptedRunningAppId = useRef(null);
const closeDetails = useCallback(() => {
setFocusFpsMultiplier(false);
setFocusDetailAction(null);
@@ -60,18 +59,6 @@ export function ConfigurationTab({
return () => cancelAnimationFrame(frame);
}, [focusDetailAction]);
- useEffect(() => {
- if (!runningGame || runningGame.configured) {
- promptedRunningAppId.current = null;
- return;
- }
- if (promptedRunningAppId.current !== runningGame.appid && detailAppId === null) {
- promptedRunningAppId.current = runningGame.appid;
- setFocusDetailAction("enable");
- setDetailAppId(runningGame.appid);
- }
- }, [detailAppId, runningGame?.appid, runningGame?.configured]);
-
const selectedTarget = detailAppId ? targets.find((target) => target.appid === detailAppId) : null;
if (detailAppId === null) {
@@ -106,7 +93,6 @@ export function ConfigurationTab({
: "Game is no longer available";
const handleProfileAction = async () => {
if (selectedTarget?.configured) {
- promptedRunningAppId.current = detailAppId;
await onReset();
setFocusConfiguredToggle(true);
closeDetails();
diff --git a/src/components/Content.tsx b/src/components/Content.tsx
index e5216ca..578f984 100644
--- a/src/components/Content.tsx
+++ b/src/components/Content.tsx
@@ -56,15 +56,15 @@ export function Content() {
setTab("Setup");
return;
}
- setTab((current) => current === "Setup" ? (runningGame ? "NowPlaying" : "Games") : current);
- }, [runningGame?.appid, setupComplete]);
+ setTab((current) => current === "Setup" ? (runningGame?.configured ? "NowPlaying" : "Games") : current);
+ }, [runningGame?.appid, runningGame?.configured, setupComplete]);
useEffect(() => {
if (!setupComplete) return;
const appid = runningGame?.appid || null;
const previous = previousRunningAppId.current;
previousRunningAppId.current = appid;
- if (appid && appid !== previous) setTab("NowPlaying");
+ if (appid && appid !== previous) setTab(runningGame?.configured ? "NowPlaying" : "Games");
else if (!appid && previous) {
setTab((current) => current === "NowPlaying" ? "Games" : current);
}
@@ -96,7 +96,7 @@ export function Content() {
const tabs = setupComplete
? [
- ...(runningGame ? [{
+ ...(runningGame?.configured ? [{
id: "NowPlaying",
title: tabIcons.nowPlaying,
content: (
@@ -104,7 +104,6 @@ export function Content() {
game={runningGame}
config={config}
onConfigChange={(field, value) => handleConfigChange(field, value)}
- onEnable={enable}
onRepair={repair}
/>
),
diff --git a/src/components/NowPlayingTab.tsx b/src/components/NowPlayingTab.tsx
index 5bce5c4..57858db 100644
--- a/src/components/NowPlayingTab.tsx
+++ b/src/components/NowPlayingTab.tsx
@@ -11,7 +11,6 @@ interface Props {
fieldName: keyof ConfigurationData,
value: boolean | number | string | string[],
) => Promise;
- onEnable: (appid: string) => Promise;
onRepair: (appid: string) => Promise;
}
@@ -24,25 +23,13 @@ export function NowPlayingTab({
game,
config,
onConfigChange,
- onEnable,
onRepair,
}: Props) {
const [busy, setBusy] = useState(false);
const supportNeedsRepair =
- game.configured &&
game.transport.kind === "flatpak" &&
game.flatpakSupport?.support_status !== "ready";
- const handleEnable = async () => {
- if (busy) return;
- setBusy(true);
- try {
- await onEnable(game.appid);
- } finally {
- setBusy(false);
- }
- };
-
const handleRepair = async () => {
if (busy) return;
setBusy(true);
@@ -60,22 +47,7 @@ export function NowPlayingTab({
- {!game.configured && (
-
-
-
-
- void handleEnable()}>
- {busy ? "Enabling..." : "Enable LSFG-VK"}
-
-
-
- )}
- {game.configured && supportNeedsRepair && (
+ {supportNeedsRepair && (
)}
- {game.configured && (
-
Date: Thu, 10 Sep 2026 10:33:08 -0400
Subject: only warn quit on real steam games
---
src/components/ConfigurationTab.tsx | 30 +++++++++++++++++++++++++++---
src/types.d.ts | 1 +
2 files changed, 28 insertions(+), 3 deletions(-)
diff --git a/src/components/ConfigurationTab.tsx b/src/components/ConfigurationTab.tsx
index 8150819..5ae4a87 100644
--- a/src/components/ConfigurationTab.tsx
+++ b/src/components/ConfigurationTab.tsx
@@ -1,4 +1,4 @@
-import { ButtonItem, DialogButton, Focusable, PanelSection, PanelSectionRow, gamepadDialogClasses } from "@decky/ui";
+import { ButtonItem, ConfirmModal, DialogButton, Focusable, PanelSection, PanelSectionRow, gamepadDialogClasses, showModal } from "@decky/ui";
import { useCallback, useEffect, useRef, useState } from "react";
import { FaArrowLeft } from "react-icons/fa";
import { ConfigurationData } from "../config/configSchema";
@@ -91,13 +91,37 @@ export function ConfigurationTab({
const profileDescription = selectedTarget
? `${profileTransport} · App ID ${selectedTarget.appid} · ${selectedTarget.configured ? "LSFG-VK Enabled" : "LSFG-VK not enabled"}`
: "Game is no longer available";
+ const enableProfile = async (appid: string, quitRunningGame = false) => {
+ if (!(await onEnable(appid))) return;
+ if (quitRunningGame) SteamClient.Apps.TerminateApp(appid, false);
+ setFocusFpsMultiplier(true);
+ };
const handleProfileAction = async () => {
if (selectedTarget?.configured) {
await onReset();
setFocusConfiguredToggle(true);
closeDetails();
- } else if (detailAppId && await onEnable(detailAppId)) {
- setFocusFpsMultiplier(true);
+ } else if (detailAppId) {
+ const isRunningUnconfigured = runningGame?.appid === detailAppId
+ && runningGame.nonSteam === false
+ && runningGame.transport.kind === "host"
+ && selectedTarget?.nonSteam === false
+ && selectedTarget?.transport.kind === "host"
+ && !runningGame.configured;
+ if (isRunningUnconfigured) {
+ showModal(
+ void enableProfile(detailAppId, true)}
+ onCancel={() => void enableProfile(detailAppId)}
+ />,
+ );
+ } else {
+ await enableProfile(detailAppId);
+ }
}
};
diff --git a/src/types.d.ts b/src/types.d.ts
index df433e0..e5db40d 100644
--- a/src/types.d.ts
+++ b/src/types.d.ts
@@ -32,6 +32,7 @@ interface SteamApps {
SetAppLaunchOptions(appId: number, options: string): void | Promise;
SetShortcutLaunchOptions(appId: number, options: string): void | Promise;
SetShortcutExe(appId: number, executable: string): void | Promise;
+ TerminateApp(appId: string, param1: boolean): void;
GetAllShortcuts?(): Promise;
}
--
cgit v1.2.3
From b197e25b45d53c6c7175a45dd0b14642f2aab198 Mon Sep 17 00:00:00 2001
From: xXJSONDeruloXx
Date: Thu, 10 Sep 2026 11:51:22 -0400
Subject: fixes for appimage and flatpak
---
py_modules/lsfg_vk/flatpak_service.py | 88 +++++++++++++----
src/components/SetupTab.tsx | 128 +++++--------------------
src/hooks/useGameConfiguration.ts | 39 ++++----
src/hooks/usePerAppWorkarounds.ts | 35 ++++---
src/utils/steamLaunchOptions.ts | 24 +++--
tests/steamLaunchOptions.test.ts | 62 +++++++++++-
tests/test_flatpak_service.py | 174 ++++++++++++++++++----------------
7 files changed, 306 insertions(+), 244 deletions(-)
diff --git a/py_modules/lsfg_vk/flatpak_service.py b/py_modules/lsfg_vk/flatpak_service.py
index d2241ab..f486b74 100644
--- a/py_modules/lsfg_vk/flatpak_service.py
+++ b/py_modules/lsfg_vk/flatpak_service.py
@@ -24,6 +24,8 @@ from .constants import (
class FlatpakService(BaseService):
EXTENSION_ID = "org.freedesktop.Platform.VulkanLayer.lsfgvk"
SUPPORTED_RUNTIMES = ("23.08", "24.08", "25.08")
+ DERIVED_RUNTIME_IDS = {"org.gnome.Platform", "org.kde.Platform"}
+ RUNTIME_METADATA_SECTION = "Extension org.freedesktop.Platform.GL"
OWNERSHIP_FILENAME = "flatpak_extensions.json"
OWNERSHIP_VERSION = 1
APP_ID_PATTERN = re.compile(
@@ -93,6 +95,26 @@ class FlatpakService(BaseService):
raise ValueError(f"Unsupported Flatpak runtime reference: {runtime_ref}")
return cls._validate_runtime(parts[2])
+ @classmethod
+ def runtime_branch_from_metadata(cls, metadata: str) -> str:
+ section = None
+ versions = []
+ for raw_line in metadata.splitlines() if isinstance(metadata, str) else []:
+ line = raw_line.strip()
+ if line.startswith("[") and line.endswith("]"):
+ section = line[1:-1].strip()
+ continue
+ if section != cls.RUNTIME_METADATA_SECTION:
+ continue
+ key, separator, value = line.partition("=")
+ if separator and key.strip() == "versions":
+ versions.extend(part.strip() for part in value.split(";"))
+ for value in versions:
+ for branch in cls.SUPPORTED_RUNTIMES:
+ if value == branch or value.startswith(f"{branch}-"):
+ return branch
+ raise ValueError("Could not determine a supported Freedesktop base runtime from Flatpak metadata")
+
@classmethod
def _extension_ref(cls, branch: str) -> str:
return f"{cls.EXTENSION_ID}/x86_64/{cls._validate_runtime(branch)}"
@@ -105,18 +127,22 @@ class FlatpakService(BaseService):
}[self._validate_runtime(branch)]
return Path(__file__).resolve().parent.parent.parent / BIN_DIR / filename
- def _installed_extension_branches(self) -> Set[str]:
- result = self._run_flatpak_command(
- ["list", "--runtime", "--columns=application,arch,branch"],
- capture_output=True,
- text=True,
- check=True,
- )
+ def _installed_extension_branches(self, scope: Optional[str] = None) -> Set[str]:
+ scopes = ("user", "system") if scope is None else (scope,)
+ if any(item not in ("user", "system") for item in scopes):
+ raise ValueError("Flatpak installation scope must be user or system")
installed = set()
- for line in result.stdout.splitlines():
- fields = line.split("\t") if "\t" in line else line.split()
- if len(fields) >= 3 and fields[0] == self.EXTENSION_ID and fields[1] == "x86_64":
- installed.add(fields[2])
+ for item in scopes:
+ result = self._run_flatpak_command(
+ ["list", f"--{item}", "--runtime", "--columns=application,arch,branch"],
+ capture_output=True,
+ text=True,
+ check=True,
+ )
+ for line in result.stdout.splitlines():
+ fields = line.split("\t") if "\t" in line else line.split()
+ if len(fields) >= 3 and fields[0] == self.EXTENSION_ID and fields[1] == "x86_64":
+ installed.add(fields[2])
return installed
def _owned_branches(self) -> Set[str]:
@@ -188,7 +214,26 @@ class FlatpakService(BaseService):
if result.returncode != 0:
raise OSError(result.stderr.strip() or f"Could not inspect Flatpak app {app_id}")
runtime = result.stdout.strip().splitlines()[0] if result.stdout.strip() else ""
- return runtime, self.runtime_branch_from_ref(runtime)
+ parts = runtime.split("/")
+ if len(parts) != 3:
+ raise ValueError(f"Unsupported Flatpak runtime reference: {runtime}")
+ if parts[0] == "org.freedesktop.Platform":
+ branch = self._validate_runtime(parts[2])
+ elif parts[0] in self.DERIVED_RUNTIME_IDS:
+ metadata_result = self._run_flatpak_command(
+ ["info", "--show-metadata", runtime],
+ capture_output=True,
+ text=True,
+ )
+ if metadata_result.returncode != 0:
+ raise OSError(
+ metadata_result.stderr.strip()
+ or f"Could not inspect Flatpak runtime {runtime}"
+ )
+ branch = self.runtime_branch_from_metadata(metadata_result.stdout)
+ else:
+ raise ValueError(f"Unsupported Flatpak runtime reference: {runtime}")
+ return runtime, branch
def resolve_app_support(self, app_id: str):
try:
@@ -249,7 +294,7 @@ class FlatpakService(BaseService):
)
if result.returncode != 0:
raise OSError(result.stderr.strip() or "Flatpak installation failed")
- if branch not in self._installed_extension_branches():
+ if branch not in self._installed_extension_branches("user"):
raise RuntimeError(f"Flatpak install completed but {self._extension_ref(branch)} was not visible afterwards")
owned = self._owned_branches()
owned.add(branch)
@@ -259,7 +304,7 @@ class FlatpakService(BaseService):
return self._error_response(dict, str(error), runtime_branch=branch, installed=False, enabled=False)
def _remove_extension(self, branch: str) -> bool:
- if branch not in self._installed_extension_branches():
+ if branch not in self._installed_extension_branches("user"):
return False
result = self._run_flatpak_command(
["uninstall", "--user", "--noninteractive", self._extension_ref(branch)],
@@ -268,7 +313,7 @@ class FlatpakService(BaseService):
)
if result.returncode != 0:
raise OSError(result.stderr.strip() or "Flatpak uninstall failed")
- if branch in self._installed_extension_branches():
+ if branch in self._installed_extension_branches("user"):
raise RuntimeError(f"Flatpak uninstall completed but {self._extension_ref(branch)} is still installed")
return True
@@ -288,12 +333,15 @@ class FlatpakService(BaseService):
if not self.check_flatpak_available():
raise FileNotFoundError("Flatpak is not available on this system")
with self._lock:
- removed = self._remove_extension(branch)
owned = self._owned_branches()
- if branch in owned:
- owned.remove(branch)
- self._write_owned_branches(owned)
- return self._extension_result(branch, False, removed, "uninstalled")
+ if branch not in owned:
+ installed = branch in self._installed_extension_branches()
+ return self._extension_result(branch, installed, False, "preserved (not plugin-owned)")
+ removed = self._remove_extension(branch)
+ owned.remove(branch)
+ self._write_owned_branches(owned)
+ installed = branch in self._installed_extension_branches()
+ return self._extension_result(branch, installed, removed, "uninstalled")
except Exception as error:
return self._error_response(
dict,
diff --git a/src/components/SetupTab.tsx b/src/components/SetupTab.tsx
index 624be54..d769200 100644
--- a/src/components/SetupTab.tsx
+++ b/src/components/SetupTab.tsx
@@ -1,13 +1,6 @@
-import { ButtonItem, Field, PanelSection, PanelSectionRow, ToggleField } from "@decky/ui";
-import { useEffect, useState } from "react";
-import {
- getFlatpakSupportStatus,
- setFlatpakExtensionEnabled,
- type FlatpakExtensionStatus,
- type SteamBranchStatus,
-} from "../api/lsfgApi";
+import { ButtonItem, Field, PanelSection, PanelSectionRow } from "@decky/ui";
+import { type SteamBranchStatus } from "../api/lsfgApi";
import t from "../i18n/i18n";
-import { showErrorToast } from "../utils/toastUtils";
interface SetupTabProps {
isInstalled: boolean;
@@ -21,72 +14,6 @@ interface SetupTabProps {
onUninstall: () => void;
}
-function FlatpakSupportDiagnostics() {
- const [status, setStatus] = useState(null);
- const [operation, setOperation] = useState(null);
-
- const refresh = async () => {
- try {
- setStatus(await getFlatpakSupportStatus());
- } catch (error) {
- setStatus({
- success: false,
- message: "",
- error: String(error),
- available: false,
- extension_id: "",
- supported_branches: [],
- installed_branches: [],
- });
- }
- };
-
- useEffect(() => {
- void refresh();
- }, []);
-
- if (!status?.available) return null;
-
- const setEnabled = async (branch: string, enabled: boolean) => {
- setOperation(`${enabled ? "enable" : "disable"}-${branch}`);
- try {
- const result = await setFlatpakExtensionEnabled(branch, enabled);
- if (!result.success) throw new Error(result.error || result.message || "Flatpak runtime update failed");
- await refresh();
- } catch (error) {
- showErrorToast("Flatpak runtime update failed", String(error));
- } finally {
- setOperation(null);
- }
- };
-
- return (
-
-
-
- {status.supported_branches.map((branch) => {
- const installed = status.installed_branches.includes(branch);
- const pending = operation?.endsWith(`-${branch}`);
- return (
-
- void setEnabled(branch, enabled)}
- disabled={operation !== null}
- />
-
- );
- })}
-
- );
-}
-
export function SetupTab(props: SetupTabProps) {
const {
isInstalled,
@@ -109,36 +36,33 @@ export function SetupTab(props: SetupTabProps) {
: t("INSTALL_INSTALL_BTN", "Install LSFG-VK");
return (
- <>
-
+
+
+
+
+
+ {steamBranchStatus?.installed && (
-
-
- {steamBranchStatus?.installed && (
-
-
- )}
-
-
- {buttonLabel}
-
-
-
-
+
+ {buttonLabel}
+
+
+
);
}
diff --git a/src/hooks/useGameConfiguration.ts b/src/hooks/useGameConfiguration.ts
index c70d589..e120426 100644
--- a/src/hooks/useGameConfiguration.ts
+++ b/src/hooks/useGameConfiguration.ts
@@ -48,11 +48,6 @@ function selectShortcutExecutable(
.map((candidate) => candidate?.trim())
.find((candidate) => candidate && candidate.startsWith("/"));
if (absolute) return absolute;
-
- // Steam's app-details API can report a Flatpak Target as just "flatpak"
- // even when the shortcut's canonical VDF executable is /usr/bin/flatpak.
- // Keep the stored original executable absolute so SetShortcutExe and the
- // generated dispatcher agree on the same direct transport.
if (target.transport.kind === "flatpak") return "/usr/bin/flatpak";
return candidates.map((candidate) => candidate?.trim()).find(Boolean);
}
@@ -158,25 +153,26 @@ export function useGameConfiguration() {
const oldShortcutExe = existing.shortcut_exe || undefined;
const oldCommandTokenAdded = existing.command_token_added === true;
const oldTransport = existing.transport || target.transport;
- if (target.nonSteam && oldState && current.target === wrapperPath && !oldShortcutExe) {
+ const usesShortcutTarget = target.nonSteam && target.transport.kind === "flatpak";
+ if (usesShortcutTarget && oldState && current.target === wrapperPath && !oldShortcutExe) {
throw new Error("Managed shortcut Target has no saved original executable");
}
- if (target.nonSteam && oldState && current.target !== wrapperPath && current.target !== oldShortcutExe) {
+ if (usesShortcutTarget && oldState && current.target !== wrapperPath && current.target !== oldShortcutExe) {
throw new Error("Shortcut Target changed externally; refusing to replace it");
}
- if (target.nonSteam && !oldState && current.target === wrapperPath) {
+ if (usesShortcutTarget && !oldState && current.target === wrapperPath) {
throw new Error("Shortcut Target is already the managed wrapper but its original Target is unknown");
}
const state = oldState || { ...DEFAULT_WORKAROUND_STATE };
- const originalExecutable = target.nonSteam
+ const originalExecutable = usesShortcutTarget
? selectShortcutExecutable(
target,
oldShortcutExe,
- target.transport.kind === "flatpak" ? target.executable : undefined,
+ target.executable,
current.target,
)
: undefined;
- const initialIntegration = target.nonSteam
+ const initialIntegration = usesShortcutTarget
? current.target === wrapperPath
: hasWrapperLaunchIntegration(current.options, wrapperPath);
const initialStateResult = await setWorkaroundState(
@@ -190,16 +186,22 @@ export function useGameConfiguration() {
let integration: Awaited> | null = null;
try {
- integration = await installWrapperIntegration(appId, target.nonSteam, wrapperPath, oldCommandTokenAdded);
+ integration = await installWrapperIntegration(
+ appId,
+ target.nonSteam,
+ wrapperPath,
+ oldCommandTokenAdded,
+ target.transport.kind,
+ );
const finalStateResult = await setWorkaroundState(
target.appid,
state,
- target.nonSteam
+ usesShortcutTarget
? (selectShortcutExecutable(
target,
integration.originalExecutable,
originalExecutable,
- target.transport.kind === "flatpak" ? target.executable : undefined,
+ target.executable,
) || null)
: null,
integration.commandTokenAdded,
@@ -215,15 +217,16 @@ export function useGameConfiguration() {
appId,
target.nonSteam,
wrapperPath,
- target.nonSteam
+ usesShortcutTarget
? (selectShortcutExecutable(
target,
integration?.originalExecutable,
originalExecutable,
- target.transport.kind === "flatpak" ? target.executable : undefined,
+ target.executable,
) || undefined)
: undefined,
integration?.commandTokenAdded ?? oldCommandTokenAdded,
+ target.transport.kind,
);
} catch (rollbackError) {
showErrorToast("Workaround rollback failed", asError(rollbackError).message);
@@ -257,6 +260,7 @@ export function useGameConfiguration() {
const existing = await getWorkaroundState(target.appid);
if (!existing.success) throw new Error(existing.error || "Could not read workaround state");
const wrapperPath = existing.wrapper_path || getDefaultWrapperPath();
+ const usesShortcutTarget = target.nonSteam && target.transport.kind === "flatpak";
if (existing.state) {
await removeWrapperIntegration(
appId,
@@ -264,10 +268,11 @@ export function useGameConfiguration() {
wrapperPath,
existing.shortcut_exe || undefined,
existing.command_token_added === true,
+ target.transport.kind,
);
} else {
const current = await readSteamLaunchOptions(appId, target.nonSteam);
- if (target.nonSteam && (current.target === wrapperPath || isLegacyWrapperToken(current.target))) {
+ if (usesShortcutTarget && (current.target === wrapperPath || isLegacyWrapperToken(current.target))) {
throw new Error("Shortcut Target is a frame-generation wrapper but its original Target is unknown");
}
await cleanupLegacySteamLaunchOptions(appId, target.nonSteam, wrapperPath);
diff --git a/src/hooks/usePerAppWorkarounds.ts b/src/hooks/usePerAppWorkarounds.ts
index e9e44e1..ebb12e2 100644
--- a/src/hooks/usePerAppWorkarounds.ts
+++ b/src/hooks/usePerAppWorkarounds.ts
@@ -73,22 +73,31 @@ function selectShortcutExecutable(
return candidates.map((candidate) => candidate?.trim()).find(Boolean);
}
+function usesShortcutTarget(nonSteam: boolean, transport: TargetTransport): boolean {
+ return nonSteam && transport.kind === "flatpak";
+}
+
function integrationIsInstalled(
steam: SteamLaunchOptionsSnapshot,
nonSteam: boolean,
+ transport: TargetTransport,
wrapperPath: string,
): boolean {
- return nonSteam ? steam.target === wrapperPath : hasWrapperLaunchIntegration(steam.options, wrapperPath);
+ return usesShortcutTarget(nonSteam, transport)
+ ? steam.target === wrapperPath
+ : hasWrapperLaunchIntegration(steam.options, wrapperPath);
}
function makeSnapshot(
steam: SteamLaunchOptionsSnapshot,
result: Awaited>,
nonSteam: boolean,
+ transport: TargetTransport,
): WorkaroundSnapshot {
if (!result.state) throw new Error("Workaround state is not initialized for this profile");
const wrapperPath = result.wrapper_path || getDefaultWrapperPath();
- if (nonSteam && steam.target === wrapperPath && !result.shortcut_exe) {
+ const selectedTransport = result.transport || transport;
+ if (usesShortcutTarget(nonSteam, selectedTransport) && steam.target === wrapperPath && !result.shortcut_exe) {
throw new Error("Managed shortcut Target has no saved original executable");
}
return {
@@ -96,10 +105,10 @@ function makeSnapshot(
state: result.state,
wrapperPath,
wrapperOwned: result.wrapper_owned === true,
- integrationInstalled: integrationIsInstalled(steam, nonSteam, wrapperPath),
+ integrationInstalled: integrationIsInstalled(steam, nonSteam, selectedTransport, wrapperPath),
commandTokenAdded: result.command_token_added === true,
shortcutExe: result.shortcut_exe,
- transport: result.transport || { kind: "host" },
+ transport: selectedTransport,
};
}
@@ -110,10 +119,11 @@ async function adoptWorkaroundState(
steam: SteamLaunchOptionsSnapshot,
wrapperPath: string,
): Promise {
- if (nonSteam && (!steam.target || steam.target === wrapperPath || isLegacyWrapperToken(steam.target))) {
+ const shortcutTarget = usesShortcutTarget(nonSteam, transport);
+ if (shortcutTarget && (!steam.target || steam.target === wrapperPath || isLegacyWrapperToken(steam.target))) {
throw new Error("Shortcut Target is a wrapper but its original Target is unknown");
}
- const originalExecutable = nonSteam
+ const originalExecutable = shortcutTarget
? selectShortcutExecutable(transport, steam.target)
: null;
const initial = await setWorkaroundState(
@@ -130,18 +140,20 @@ async function adoptWorkaroundState(
Number(appId),
nonSteam,
wrapperPath,
+ false,
+ transport.kind,
);
const finalized = await setWorkaroundState(
appId,
DEFAULT_WORKAROUND_STATE,
- nonSteam
+ shortcutTarget
? (selectShortcutExecutable(transport, integration.originalExecutable, originalExecutable) || null)
: null,
integration.commandTokenAdded,
transport,
);
if (!finalized.success) throw new Error(finalized.error || "Could not finalize workaround state");
- return makeSnapshot(integration.snapshot, finalized, nonSteam);
+ return makeSnapshot(integration.snapshot, finalized, nonSteam, transport);
} catch (error) {
let rollbackSucceeded = true;
if (integration) {
@@ -150,10 +162,11 @@ async function adoptWorkaroundState(
Number(appId),
nonSteam,
wrapperPath,
- nonSteam
+ shortcutTarget
? (selectShortcutExecutable(transport, integration?.originalExecutable, originalExecutable) || undefined)
: undefined,
integration?.commandTokenAdded ?? false,
+ transport.kind,
);
} catch {
// Leave the owned integration in place rather than guessing at cleanup.
@@ -194,7 +207,7 @@ export function usePerAppWorkarounds(
result.wrapper_path || getDefaultWrapperPath(),
);
}
- return makeSnapshot(steam, result, nonSteam);
+ return makeSnapshot(steam, result, nonSteam, transport);
}, [appId, nonSteam, numericAppId, transport]);
const applySnapshot = useCallback((next: WorkaroundSnapshot) => {
@@ -230,7 +243,7 @@ export function usePerAppWorkarounds(
setSnapshot((current) => current ? {
...current,
steam,
- integrationInstalled: integrationIsInstalled(steam, nonSteam, current.wrapperPath),
+ integrationInstalled: integrationIsInstalled(steam, nonSteam, current.transport, current.wrapperPath),
} : current);
},
(subscriptionError) => {
diff --git a/src/utils/steamLaunchOptions.ts b/src/utils/steamLaunchOptions.ts
index 0af1bbf..65541d8 100644
--- a/src/utils/steamLaunchOptions.ts
+++ b/src/utils/steamLaunchOptions.ts
@@ -172,7 +172,11 @@ function removeMatchingWrappers(tokens: LaunchToken[], predicate: (value: string
return true;
}
-export function installWrapperLaunchOption(options: string, wrapperPath = DEFAULT_WRAPPER_PATH) {
+export function installWrapperLaunchOption(
+ options: string,
+ wrapperPath = DEFAULT_WRAPPER_PATH,
+ allowCommandArgs = false,
+) {
const tokens = tokenize(options);
removeMatchingWrappers(tokens, isLegacyToken);
let command = commandIndex(tokens);
@@ -185,7 +189,7 @@ export function installWrapperLaunchOption(options: string, wrapperPath = DEFAUL
}
let insertion = 0;
while (insertion < tokens.length && isAssignment(tokens[insertion])) insertion++;
- if (insertion < tokens.length && !tokens[insertion].value.startsWith("-")) {
+ if (!allowCommandArgs && insertion < tokens.length && !tokens[insertion].value.startsWith("-")) {
throw new Error("Launch options do not contain %command%; refusing to guess a launcher command");
}
tokens.splice(insertion, 0,
@@ -336,10 +340,11 @@ export function installWrapperIntegration(
nonSteam: boolean,
wrapperPath: string,
commandTokenAdded = false,
+ transport: "host" | "flatpak" = "host",
): Promise {
return queued(appId, nonSteam, async () => {
let current = await readSteamLaunchOptions(appId, nonSteam);
- if (nonSteam) {
+ if (nonSteam && transport === "flatpak") {
if (!current.target) throw new Error("Steam shortcut Target is empty; refusing to replace it");
if (current.target !== wrapperPath && isWrapperToken(current.target, wrapperPath)) {
throw new Error("The shortcut Target points to a legacy frame-generation wrapper; restore it first");
@@ -364,11 +369,11 @@ export function installWrapperIntegration(
const cleaned = cleanupPluginAssignments(cleanupLegacyLaunchOptions(current.options));
const alreadyInstalled = hasWrapperLaunchIntegration(current.options, wrapperPath);
- const rewrite = installWrapperLaunchOption(cleaned, wrapperPath);
+ const rewrite = installWrapperLaunchOption(cleaned, wrapperPath, nonSteam);
if (rewrite.options === current.options) return { snapshot: current, commandTokenAdded };
const value = await writeVerified(
- appId, false, current.options, rewrite.options,
- (options) => writeOptions(appId, false, options), readOptions,
+ appId, nonSteam, current.options, rewrite.options,
+ (options) => writeOptions(appId, nonSteam, options), readOptions,
"Steam did not accept the launch options",
);
return { snapshot: value, commandTokenAdded: alreadyInstalled ? commandTokenAdded : rewrite.commandTokenAdded };
@@ -381,10 +386,11 @@ export function removeWrapperIntegration(
wrapperPath: string,
originalExecutable?: string,
commandTokenAdded = false,
+ transport: "host" | "flatpak" = "host",
): Promise {
return queued(appId, nonSteam, async () => {
let current = await readSteamLaunchOptions(appId, nonSteam);
- if (nonSteam) {
+ if (nonSteam && transport === "flatpak") {
if (!originalExecutable || isWrapperToken(originalExecutable, wrapperPath)) {
throw new Error("Original shortcut Target is unavailable; refusing to overwrite the current Target");
}
@@ -408,8 +414,8 @@ export function removeWrapperIntegration(
}
const next = cleanupPluginAssignments(removeWrapperLaunchOption(current.options, wrapperPath, commandTokenAdded));
return next === current.options ? current : writeVerified(
- appId, false, current.options, next,
- (options) => writeOptions(appId, false, options), readOptions,
+ appId, nonSteam, current.options, next,
+ (options) => writeOptions(appId, nonSteam, options), readOptions,
"Steam did not clean the launch options",
);
});
diff --git a/tests/steamLaunchOptions.test.ts b/tests/steamLaunchOptions.test.ts
index 3170fe8..215e3f7 100644
--- a/tests/steamLaunchOptions.test.ts
+++ b/tests/steamLaunchOptions.test.ts
@@ -37,6 +37,10 @@ test("normalizes blank and argument-only fields while refusing ambiguous launche
options: `FOO=bar ${wrapper} %command% --windowed`,
commandTokenAdded: true,
});
+ assert.deepEqual(installWrapperLaunchOption('FOO=bar "/home/deck/game.AppImage"', wrapper, true), {
+ options: 'FOO=bar ~/.lsfg %command% "/home/deck/game.AppImage"',
+ commandTokenAdded: true,
+ });
assert.throws(() => installWrapperLaunchOption("gamemoderun --windowed", wrapper), /refusing to guess/);
assert.throws(() => installWrapperLaunchOption('"%command%"', wrapper), /refusing to guess/);
});
@@ -122,11 +126,11 @@ test("reads the matching app-details field and installs/removes Steam integratio
assert.equal(appWrites.length, 1);
assert.equal(shortcutWrites.length, 0);
- const shortcut = await installWrapperIntegration(43, true, wrapper);
+ const shortcut = await installWrapperIntegration(43, true, wrapper, false, "flatpak");
assert.equal(shortcut.originalExecutable, "/usr/bin/example-game");
assert.equal(shortcut.snapshot.target, wrapper);
assert.deepEqual(targetWrites, [wrapper]);
- const restored = await removeWrapperIntegration(43, true, wrapper, shortcut.originalExecutable);
+ const restored = await removeWrapperIntegration(43, true, wrapper, shortcut.originalExecutable, false, "flatpak");
assert.equal(restored.target, "/usr/bin/example-game");
assert.deepEqual(targetWrites, [wrapper, "/usr/bin/example-game"]);
assert.equal(shortcutWrites.length, 0);
@@ -143,6 +147,54 @@ test("reads the matching app-details field and installs/removes Steam integratio
}
});
+test("uses shortcut launch options for a host shortcut without changing its Target", async () => {
+ const previousWindow = (globalThis as Record).window;
+ const previousSteamClient = (globalThis as Record).SteamClient;
+ const originalOptions = 'DESKTOPINTEGRATION=1 "/home/deck/AppImages/dusk.appimage"';
+ let shortcutOptions = originalOptions;
+ let shortcutTarget = "env";
+ const shortcutWrites: string[] = [];
+ const targetWrites: string[] = [];
+ const apps = {
+ RegisterForAppDetails(_appId: number, callback: (details: SteamAppDetails) => void) {
+ callback({ strShortcutExe: shortcutTarget, strShortcutLaunchOptions: shortcutOptions });
+ return { unregister() {} };
+ },
+ SetShortcutLaunchOptions(_appId: number, options: string) {
+ shortcutWrites.push(options);
+ shortcutOptions = options;
+ },
+ SetShortcutExe(_appId: number, executable: string) {
+ targetWrites.push(executable);
+ shortcutTarget = executable;
+ },
+ };
+ (globalThis as Record).window = { setTimeout, clearTimeout };
+ (globalThis as Record).SteamClient = { Apps: apps };
+ try {
+ const installed = await installWrapperIntegration(44, true, wrapper, false, "host");
+ assert.equal(installed.originalExecutable, undefined);
+ assert.equal(installed.snapshot.target, "env");
+ assert.equal(installed.snapshot.options, 'DESKTOPINTEGRATION=1 ~/.lsfg %command% "/home/deck/AppImages/dusk.appimage"');
+ assert.deepEqual(targetWrites, []);
+ assert.deepEqual(shortcutWrites, [installed.snapshot.options]);
+
+ const secondInstall = await installWrapperIntegration(44, true, wrapper, false, "host");
+ assert.equal(secondInstall.snapshot.options, installed.snapshot.options);
+ assert.deepEqual(shortcutWrites, [installed.snapshot.options]);
+
+ const restored = await removeWrapperIntegration(44, true, wrapper, undefined, installed.commandTokenAdded, "host");
+ assert.equal(restored.target, "env");
+ assert.equal(restored.options, originalOptions);
+ assert.deepEqual(targetWrites, []);
+ } finally {
+ if (previousWindow === undefined) delete (globalThis as Record).window;
+ else (globalThis as Record).window = previousWindow;
+ if (previousSteamClient === undefined) delete (globalThis as Record).SteamClient;
+ else (globalThis as Record).SteamClient = previousSteamClient;
+ }
+});
+
test("fails closed when shortcut Target ownership or setters are unavailable", async () => {
const previousWindow = (globalThis as Record).window;
const previousSteamClient = (globalThis as Record).SteamClient;
@@ -156,8 +208,8 @@ test("fails closed when shortcut Target ownership or setters are unavailable", a
},
};
try {
- await assert.rejects(installWrapperIntegration(99, true, wrapper), /Target API is unavailable/);
- await assert.rejects(removeWrapperIntegration(99, true, wrapper, "/usr/bin/original"), /Target changed externally/);
+ await assert.rejects(installWrapperIntegration(99, true, wrapper, false, "flatpak"), /Target API is unavailable/);
+ await assert.rejects(removeWrapperIntegration(99, true, wrapper, "/usr/bin/original", false, "flatpak"), /Target changed externally/);
} finally {
if (previousWindow === undefined) delete (globalThis as Record).window;
else (globalThis as Record).window = previousWindow;
@@ -198,7 +250,7 @@ test("restores launch options and shortcut Target when a setter fails after chan
assert.equal(appOptions, "FOO=bar %command%");
assert.deepEqual(appWrites, [`FOO=bar ${wrapper} %command%`, "FOO=bar %command%"]);
- await assert.rejects(installWrapperIntegration(43, true, wrapper), /simulated Target write failure/);
+ await assert.rejects(installWrapperIntegration(43, true, wrapper, false, "flatpak"), /simulated Target write failure/);
assert.equal(shortcutTarget, "/usr/bin/original");
assert.deepEqual(targetWrites, [wrapper, "/usr/bin/original"]);
} finally {
diff --git a/tests/test_flatpak_service.py b/tests/test_flatpak_service.py
index 70ba228..d5baf61 100644
--- a/tests/test_flatpak_service.py
+++ b/tests/test_flatpak_service.py
@@ -26,7 +26,12 @@ class FlatpakServiceTests(unittest.TestCase):
self.service.config_dir = self.home / ".config/lsfg-vk"
self.service.config_file_path = self.service.config_dir / "conf.toml"
self.service.check_flatpak_available = Mock(return_value=True)
- self.service._run_flatpak_command = Mock()
+ self.service._run_flatpak_command = Mock(side_effect=self._run_flatpak_command)
+ self.runtime_ref = "org.freedesktop.Platform/x86_64/24.08"
+ self.runtime_metadata = ""
+ self.user_branches = set()
+ self.system_branches = set()
+ self.install_branch = "24.08"
self.bundle = self.home / "lsfg-vk-24.08.flatpak"
self.bundle.write_bytes(b"bundle")
self.service._bundled_extension_path = Mock(return_value=self.bundle)
@@ -42,6 +47,22 @@ class FlatpakServiceTests(unittest.TestCase):
def _extension_line(branch):
return f"org.freedesktop.Platform.VulkanLayer.lsfgvk\tx86_64\t{branch}\n"
+ def _run_flatpak_command(self, args, **_kwargs):
+ if args[0] == "info" and args[1] == "--show-runtime":
+ return self._result(self.runtime_ref + "\n")
+ if args[0] == "info" and args[1] == "--show-metadata":
+ return self._result(self.runtime_metadata)
+ if args[0] == "list":
+ branches = self.user_branches if "--user" in args else self.system_branches
+ return self._result("".join(self._extension_line(branch) for branch in sorted(branches)))
+ if args[0] == "install":
+ self.user_branches.add(self.install_branch)
+ return self._result()
+ if args[0] == "uninstall":
+ self.user_branches.discard(args[-1].rsplit("/", 1)[-1])
+ return self._result()
+ raise AssertionError(f"Unexpected Flatpak command: {args}")
+
def test_runtime_branch_mapping_is_strict_and_branch_specific(self):
self.assertEqual(
FlatpakService.runtime_branch_from_ref(
@@ -62,11 +83,20 @@ class FlatpakServiceTests(unittest.TestCase):
"org.freedesktop.Platform/x86_64/26.08"
)
+ def test_runtime_branch_mapping_reads_documented_gl_metadata(self):
+ metadata = """
+[Extension org.freedesktop.Platform.GL]
+versions=25.08;25.08-extra;1.4
+version=1.4
+"""
+ self.assertEqual(FlatpakService.runtime_branch_from_metadata(metadata), "25.08")
+ with self.assertRaises(ValueError):
+ FlatpakService.runtime_branch_from_metadata(
+ "[Extension org.freedesktop.Platform.GL]\nversions=26.08;26.08-extra;1.4\n"
+ )
+
def test_resolve_reads_required_runtime_instead_of_any_installed_branch(self):
- self.service._run_flatpak_command.side_effect = [
- self._result("org.freedesktop.Platform/x86_64/24.08\n"),
- self._result(self._extension_line("23.08")),
- ]
+ self.user_branches = {"23.08"}
response = self.service.resolve_app_support("com.example.Game")
@@ -80,22 +110,48 @@ class FlatpakServiceTests(unittest.TestCase):
)
self.assertEqual(
self.service._run_flatpak_command.call_args_list[1].args[0],
- ["list", "--runtime", "--columns=application,arch,branch"],
+ ["list", "--user", "--runtime", "--columns=application,arch,branch"],
+ )
+ self.assertEqual(
+ self.service._run_flatpak_command.call_args_list[2].args[0],
+ ["list", "--system", "--runtime", "--columns=application,arch,branch"],
)
- def test_install_records_only_a_new_user_owned_branch(self):
- self.service._run_flatpak_command.side_effect = [
- self._result(""),
- self._result(""),
- self._result(self._extension_line("24.08")),
- ]
+ def test_resolve_maps_kde_and_gnome_runtimes_from_gl_metadata(self):
+ metadata = "[Extension org.freedesktop.Platform.GL]\nversions=25.08;25.08-extra;1.4\n"
+ for runtime in ("org.kde.Platform/x86_64/6.10", "org.gnome.Platform/x86_64/49"):
+ with self.subTest(runtime=runtime):
+ self.service._run_flatpak_command.reset_mock()
+ self.runtime_ref = runtime
+ self.runtime_metadata = metadata
+ response = self.service.resolve_app_support("com.example.Game")
+ self.assertEqual(response["runtime_branch"], "25.08")
+ self.assertEqual(response["support_status"], "needs-runtime")
+ self.assertEqual(
+ self.service._run_flatpak_command.call_args_list[1].args[0],
+ ["info", "--show-metadata", runtime],
+ )
+
+ def test_system_extension_is_ready_without_installing_a_user_copy(self):
+ self.system_branches = {"24.08"}
+
+ response = self.service.ensure_app_support("com.example.Game")
+
+ self.assertTrue(response["success"])
+ self.assertEqual(response["support_status"], "ready")
+ self.assertEqual(
+ [call.args[0][0] for call in self.service._run_flatpak_command.call_args_list],
+ ["info", "list", "list"],
+ )
+ self.assertFalse(any(call.args[0][0] == "install" for call in self.service._run_flatpak_command.call_args_list))
+ def test_install_records_only_a_new_user_owned_branch(self):
response = self.service.install_extension("24.08")
self.assertTrue(response["success"])
self.assertTrue(response["enabled"])
self.assertTrue(response["installed"])
- install_args = self.service._run_flatpak_command.call_args_list[1].args[0]
+ install_args = self.service._run_flatpak_command.call_args_list[2].args[0]
self.assertEqual(install_args[:4], ["install", "--user", "--noninteractive", "--or-update"])
self.assertEqual(
json.loads(self.service.ownership_path.read_text(encoding="utf-8")),
@@ -103,9 +159,7 @@ class FlatpakServiceTests(unittest.TestCase):
)
def test_preexisting_branch_is_not_claimed_or_removed(self):
- self.service._run_flatpak_command.return_value = self._result(
- self._extension_line("24.08")
- )
+ self.user_branches = {"24.08"}
install_response = self.service.install_extension("24.08")
cleanup_response = self.service.remove_plugin_owned_extensions()
@@ -115,15 +169,10 @@ class FlatpakServiceTests(unittest.TestCase):
self.assertTrue(install_response["installed"])
self.assertFalse(self.service.ownership_path.exists())
self.assertTrue(cleanup_response["success"])
- self.assertEqual(self.service._run_flatpak_command.call_count, 1)
-
- def test_extension_toggle_installs_and_uninstalls_preexisting_branch(self):
- self.service._run_flatpak_command.side_effect = [
- self._result(self._extension_line("24.08")),
- self._result(self._extension_line("24.08")),
- self._result(""),
- self._result(""),
- ]
+ self.assertEqual(self.service._run_flatpak_command.call_count, 2)
+
+ def test_extension_toggle_preserves_preexisting_branch(self):
+ self.user_branches = {"24.08"}
enable_response = self.service.set_extension_enabled("24.08", True)
disable_response = self.service.set_extension_enabled("24.08", False)
@@ -132,36 +181,36 @@ class FlatpakServiceTests(unittest.TestCase):
self.assertTrue(enable_response["enabled"])
self.assertTrue(enable_response["installed"])
self.assertTrue(disable_response["success"])
- self.assertFalse(disable_response["enabled"])
- self.assertFalse(disable_response["installed"])
- self.assertTrue(disable_response["removed"])
+ self.assertTrue(disable_response["enabled"])
+ self.assertTrue(disable_response["installed"])
+ self.assertFalse(disable_response["removed"])
+ self.assertEqual(self.user_branches, {"24.08"})
self.assertEqual(
[call.args[0][0] for call in self.service._run_flatpak_command.call_args_list],
- ["list", "list", "uninstall", "list"],
+ ["list", "list", "list", "list"],
)
- def test_extension_toggle_removes_owned_branch_and_can_repeat_disable(self):
+ def test_extension_toggle_removes_owned_user_branch_but_preserves_system_branch(self):
self.service.ownership_path.parent.mkdir(parents=True, exist_ok=True)
self.service.ownership_path.write_text(
json.dumps({"version": 1, "plugin_owned_branches": ["24.08"]}),
encoding="utf-8",
)
- self.service._run_flatpak_command.side_effect = [
- self._result(self._extension_line("24.08")),
- self._result(""),
- self._result(""),
- self._result(""),
- ]
+ self.user_branches = {"24.08"}
+ self.system_branches = {"24.08"}
disable_response = self.service.set_extension_enabled("24.08", False)
repeat_response = self.service.set_extension_enabled("24.08", False)
self.assertTrue(disable_response["success"])
- self.assertFalse(disable_response["enabled"])
+ self.assertTrue(disable_response["enabled"])
self.assertTrue(disable_response["removed"])
self.assertTrue(repeat_response["success"])
- self.assertFalse(repeat_response["enabled"])
- self.assertFalse(repeat_response["installed"])
+ self.assertTrue(repeat_response["enabled"])
+ self.assertTrue(repeat_response["installed"])
+ self.assertEqual(self.user_branches, set())
+ self.assertEqual(self.system_branches, {"24.08"})
+ self.assertFalse(self.service.ownership_path.exists())
uninstall_commands = [
call.args[0]
for call in self.service._run_flatpak_command.call_args_list
@@ -190,23 +239,16 @@ class FlatpakServiceTests(unittest.TestCase):
self.assertEqual(self.service._run_flatpak_command.call_count, 0)
def test_ensure_app_support_installs_only_the_app_runtime_branch(self):
- self.service._run_flatpak_command.side_effect = [
- self._result("org.freedesktop.Platform/x86_64/24.08\n"),
- self._result(""),
- self._result(""),
- self._result(""),
- self._result(""),
- self._result(self._extension_line("24.08")),
- self._result("org.freedesktop.Platform/x86_64/24.08\n"),
- self._result(self._extension_line("24.08")),
- ]
-
response = self.service.ensure_app_support("com.example.Game")
self.assertTrue(response["success"])
self.assertEqual(response["support_status"], "ready")
self.assertEqual(response["runtime_branch"], "24.08")
- install_args = self.service._run_flatpak_command.call_args_list[4].args[0]
+ install_args = next(
+ call.args[0]
+ for call in self.service._run_flatpak_command.call_args_list
+ if call.args[0][0] == "install"
+ )
self.assertEqual(install_args[0], "install")
self.assertIn("--user", install_args)
self.assertNotIn("23.08", install_args)
@@ -216,19 +258,6 @@ class FlatpakServiceTests(unittest.TestCase):
)
def test_two_shortcuts_using_one_flatpak_share_one_extension_branch(self):
- self.service._run_flatpak_command.side_effect = [
- self._result("org.freedesktop.Platform/x86_64/24.08\n"),
- self._result(""),
- self._result(""),
- self._result(""),
- self._result(""),
- self._result(self._extension_line("24.08")),
- self._result("org.freedesktop.Platform/x86_64/24.08\n"),
- self._result(self._extension_line("24.08")),
- self._result("org.freedesktop.Platform/x86_64/24.08\n"),
- self._result(self._extension_line("24.08")),
- ]
-
first = self.service.ensure_app_support("net.pcsx2.PCSX2")
second = self.service.ensure_app_support("net.pcsx2.PCSX2.Dev")
@@ -251,22 +280,7 @@ class FlatpakServiceTests(unittest.TestCase):
json.dumps({"version": 1, "plugin_owned_branches": ["23.08", "24.08"]}),
encoding="utf-8",
)
- self.service._run_flatpak_command.side_effect = [
- self._result(
- "\n".join(
- [
- "\t".join([FlatpakService.EXTENSION_ID, "x86_64", "23.08"]),
- "\t".join([FlatpakService.EXTENSION_ID, "x86_64", "24.08"]),
- ]
- )
- + "\n"
- ),
- self._result(""),
- self._result("\t".join([FlatpakService.EXTENSION_ID, "x86_64", "24.08"]) + "\n"),
- self._result("\t".join([FlatpakService.EXTENSION_ID, "x86_64", "24.08"]) + "\n"),
- self._result(""),
- self._result(""),
- ]
+ self.user_branches = {"23.08", "24.08"}
response = self.service.remove_plugin_owned_extensions()
--
cgit v1.2.3
From 670f36e8cc75da9c8b1b174c24e722657bbf2a56 Mon Sep 17 00:00:00 2001
From: xXJSONDeruloXx
Date: Thu, 10 Sep 2026 12:15:05 -0400
Subject: cleanup flatpak handles
---
py_modules/lsfg_vk/wrapper_service.py | 11 ++-
src/hooks/useGameConfiguration.ts | 176 ++++++++++------------------------
src/hooks/usePerAppWorkarounds.ts | 83 ++++------------
src/utils/steamLaunchOptions.ts | 95 +++++++++++++-----
tests/steamLaunchOptions.test.ts | 20 ++--
tests/test_wrapper_service.py | 19 ++++
6 files changed, 176 insertions(+), 228 deletions(-)
diff --git a/py_modules/lsfg_vk/wrapper_service.py b/py_modules/lsfg_vk/wrapper_service.py
index dae565b..1ed39bc 100644
--- a/py_modules/lsfg_vk/wrapper_service.py
+++ b/py_modules/lsfg_vk/wrapper_service.py
@@ -119,7 +119,7 @@ class WrapperService(BaseService):
}
if type(entry["command_token_added"]) is not bool:
raise ValueError("command_token_added must be a boolean")
- if "shortcut_exe" in raw and raw["shortcut_exe"] is not None:
+ if entry["transport"]["kind"] == "flatpak" and "shortcut_exe" in raw and raw["shortcut_exe"] is not None:
shortcut_exe = raw["shortcut_exe"]
if (
not isinstance(shortcut_exe, str)
@@ -475,10 +475,11 @@ class WrapperService(BaseService):
"command_token_added": bool(command_token_added),
"transport": selected_transport,
}
- if shortcut_exe is not None:
- entry = self._validate_entry({**entry, "shortcut_exe": shortcut_exe})
- elif previous_entry and "shortcut_exe" in previous_entry:
- entry["shortcut_exe"] = previous_entry["shortcut_exe"]
+ if selected_transport["kind"] == "flatpak":
+ if shortcut_exe is not None:
+ entry = self._validate_entry({**entry, "shortcut_exe": shortcut_exe})
+ elif previous_entry and "shortcut_exe" in previous_entry:
+ entry["shortcut_exe"] = previous_entry["shortcut_exe"]
document["apps"][normalized] = entry
self._write_pair(document)
return self._response(document, normalized)
diff --git a/src/hooks/useGameConfiguration.ts b/src/hooks/useGameConfiguration.ts
index e120426..3260019 100644
--- a/src/hooks/useGameConfiguration.ts
+++ b/src/hooks/useGameConfiguration.ts
@@ -3,7 +3,7 @@ import { useQuickAccessVisible } from "@decky/api";
import { Router } from "@decky/ui";
import { ensureFlatpakSupport, getGameConfigs, getInstalledGames, getWorkaroundState, removeWorkaroundState, repairFlatpakSupport, resetGameConfig, resetAllGameConfigs, setWorkaroundState, updateGameConfig, type GameConfigEntry, type GlobalConfig, type InstalledGame, type WorkaroundState } from "../api/lsfgApi";
import { ConfigurationData, getDefaults } from "../config/configSchema";
-import { cleanupLegacySteamLaunchOptions, getDefaultWrapperPath, hasWrapperLaunchIntegration, installWrapperIntegration, isLegacyWrapperToken, readSteamLaunchOptions, removeWrapperIntegration } from "../utils/steamLaunchOptions";
+import { getDefaultWrapperPath, installWrapperIntegration, removeWrapperIntegration } from "../utils/steamLaunchOptions";
import { showErrorToast } from "../utils/toastUtils";
export interface GameTarget extends InstalledGame { configured: boolean; }
@@ -40,18 +40,6 @@ function mergeInstalledGames(backendGames: InstalledGame[], shortcutGames: Insta
return Array.from(games.values());
}
-function selectShortcutExecutable(
- target: GameTarget,
- ...candidates: Array
-): string | undefined {
- const absolute = candidates
- .map((candidate) => candidate?.trim())
- .find((candidate) => candidate && candidate.startsWith("/"));
- if (absolute) return absolute;
- if (target.transport.kind === "flatpak") return "/usr/bin/flatpak";
- return candidates.map((candidate) => candidate?.trim()).find(Boolean);
-}
-
const DEFAULT_WORKAROUND_STATE: WorkaroundState = {
dxvkFrameRate: 0,
disableGamescopeWsi: true,
@@ -144,110 +132,59 @@ export function useGameConfiguration() {
const ensureTargetWorkarounds = useCallback(async (target: GameTarget): Promise => {
if (!installedGames.some((game) => game.appid === target.appid)) return true;
const appId = Number(target.appid);
+ let integration: Awaited> | null = null;
+ let newState = false;
+ let stateWriteAttempted = false;
+ let wrapperPath = getDefaultWrapperPath();
try {
const existing = await getWorkaroundState(target.appid);
if (!existing.success) throw new Error(existing.error || "Could not read workaround state");
- const current = await readSteamLaunchOptions(appId, target.nonSteam);
- const wrapperPath = existing.wrapper_path || getDefaultWrapperPath();
- const oldState = existing.state;
- const oldShortcutExe = existing.shortcut_exe || undefined;
- const oldCommandTokenAdded = existing.command_token_added === true;
- const oldTransport = existing.transport || target.transport;
- const usesShortcutTarget = target.nonSteam && target.transport.kind === "flatpak";
- if (usesShortcutTarget && oldState && current.target === wrapperPath && !oldShortcutExe) {
- throw new Error("Managed shortcut Target has no saved original executable");
- }
- if (usesShortcutTarget && oldState && current.target !== wrapperPath && current.target !== oldShortcutExe) {
- throw new Error("Shortcut Target changed externally; refusing to replace it");
- }
- if (usesShortcutTarget && !oldState && current.target === wrapperPath) {
- throw new Error("Shortcut Target is already the managed wrapper but its original Target is unknown");
- }
- const state = oldState || { ...DEFAULT_WORKAROUND_STATE };
- const originalExecutable = usesShortcutTarget
- ? selectShortcutExecutable(
- target,
- oldShortcutExe,
- target.executable,
- current.target,
- )
- : undefined;
- const initialIntegration = usesShortcutTarget
- ? current.target === wrapperPath
- : hasWrapperLaunchIntegration(current.options, wrapperPath);
- const initialStateResult = await setWorkaroundState(
+ wrapperPath = existing.wrapper_path || getDefaultWrapperPath();
+ const state = existing.state || { ...DEFAULT_WORKAROUND_STATE };
+ const commandTokenAdded = existing.command_token_added === true;
+ newState = !existing.state;
+ integration = await installWrapperIntegration(
+ appId,
+ target.nonSteam,
+ wrapperPath,
+ commandTokenAdded,
+ target.transport,
+ target.transport.kind === "flatpak" ? existing.shortcut_exe || undefined : undefined,
+ );
+ stateWriteAttempted = true;
+ const saved = await setWorkaroundState(
target.appid,
state,
- originalExecutable || null,
- oldCommandTokenAdded,
+ integration.originalExecutable ?? null,
+ integration.commandTokenAdded,
target.transport,
);
- if (!initialStateResult.success) throw new Error(initialStateResult.error || "Could not create workaround state");
-
- let integration: Awaited> | null = null;
- try {
- integration = await installWrapperIntegration(
- appId,
- target.nonSteam,
- wrapperPath,
- oldCommandTokenAdded,
- target.transport.kind,
- );
- const finalStateResult = await setWorkaroundState(
- target.appid,
- state,
- usesShortcutTarget
- ? (selectShortcutExecutable(
- target,
- integration.originalExecutable,
- originalExecutable,
- target.executable,
- ) || null)
- : null,
- integration.commandTokenAdded,
- target.transport,
- );
- if (!finalStateResult.success) throw new Error(finalStateResult.error || "Could not finalize workaround state");
- return true;
- } catch (error) {
- let rollbackSucceeded = true;
- if (!initialIntegration && integration) {
- try {
- await removeWrapperIntegration(
- appId,
- target.nonSteam,
- wrapperPath,
- usesShortcutTarget
- ? (selectShortcutExecutable(
- target,
- integration?.originalExecutable,
- originalExecutable,
- target.executable,
- ) || undefined)
- : undefined,
- integration?.commandTokenAdded ?? oldCommandTokenAdded,
- target.transport.kind,
- );
- } catch (rollbackError) {
- showErrorToast("Workaround rollback failed", asError(rollbackError).message);
- rollbackSucceeded = false;
- }
+ if (!saved.success) throw new Error(saved.error || "Could not save workaround state");
+ return true;
+ } catch (error) {
+ let rollbackSucceeded = true;
+ if (integration?.changed) {
+ try {
+ await removeWrapperIntegration(
+ appId,
+ target.nonSteam,
+ wrapperPath,
+ integration.originalExecutable,
+ integration.commandTokenAdded,
+ target.transport,
+ );
+ } catch (rollbackError) {
+ showErrorToast("Workaround rollback failed", asError(rollbackError).message);
+ rollbackSucceeded = false;
}
- if (rollbackSucceeded) {
- const restored = oldState
- ? await setWorkaroundState(
- target.appid,
- oldState,
- oldShortcutExe || null,
- oldCommandTokenAdded,
- oldTransport,
- )
- : await removeWorkaroundState(target.appid);
- if (!restored.success) throw new Error(restored.error || "Could not roll back workaround state");
+ }
+ if (rollbackSucceeded && newState && stateWriteAttempted) {
+ const restored = await removeWorkaroundState(target.appid);
+ if (!restored.success) {
+ showErrorToast("Workaround rollback failed", restored.error || "Could not roll back workaround state");
+ rollbackSucceeded = false;
}
- throw error;
}
- } catch (error) {
showErrorToast("Could not initialize workarounds", asError(error).message);
return false;
}
@@ -260,23 +197,14 @@ export function useGameConfiguration() {
const existing = await getWorkaroundState(target.appid);
if (!existing.success) throw new Error(existing.error || "Could not read workaround state");
const wrapperPath = existing.wrapper_path || getDefaultWrapperPath();
- const usesShortcutTarget = target.nonSteam && target.transport.kind === "flatpak";
- if (existing.state) {
- await removeWrapperIntegration(
- appId,
- target.nonSteam,
- wrapperPath,
- existing.shortcut_exe || undefined,
- existing.command_token_added === true,
- target.transport.kind,
- );
- } else {
- const current = await readSteamLaunchOptions(appId, target.nonSteam);
- if (usesShortcutTarget && (current.target === wrapperPath || isLegacyWrapperToken(current.target))) {
- throw new Error("Shortcut Target is a frame-generation wrapper but its original Target is unknown");
- }
- await cleanupLegacySteamLaunchOptions(appId, target.nonSteam, wrapperPath);
- }
+ await removeWrapperIntegration(
+ appId,
+ target.nonSteam,
+ wrapperPath,
+ target.transport.kind === "flatpak" ? existing.shortcut_exe || undefined : undefined,
+ existing.command_token_added === true,
+ target.transport,
+ );
const removed = await removeWorkaroundState(target.appid);
if (!removed.success) throw new Error(removed.error || "Could not remove workaround state");
return true;
diff --git a/src/hooks/usePerAppWorkarounds.ts b/src/hooks/usePerAppWorkarounds.ts
index ebb12e2..29e1181 100644
--- a/src/hooks/usePerAppWorkarounds.ts
+++ b/src/hooks/usePerAppWorkarounds.ts
@@ -7,10 +7,10 @@ import {
type WorkaroundState,
} from "../api/lsfgApi";
import {
+ assertKnownShortcutTarget,
getDefaultWrapperPath,
- hasWrapperLaunchIntegration,
installWrapperIntegration,
- isLegacyWrapperToken,
+ isWrapperIntegrationInstalled,
readSteamLaunchOptions,
removeWrapperIntegration,
subscribeSteamLaunchOptions,
@@ -61,33 +61,6 @@ function asError(error: unknown): Error {
return error instanceof Error ? error : new Error(String(error));
}
-function selectShortcutExecutable(
- transport: TargetTransport,
- ...candidates: Array
-): string | undefined {
- const absolute = candidates
- .map((candidate) => candidate?.trim())
- .find((candidate) => candidate && candidate.startsWith("/"));
- if (absolute) return absolute;
- if (transport.kind === "flatpak") return "/usr/bin/flatpak";
- return candidates.map((candidate) => candidate?.trim()).find(Boolean);
-}
-
-function usesShortcutTarget(nonSteam: boolean, transport: TargetTransport): boolean {
- return nonSteam && transport.kind === "flatpak";
-}
-
-function integrationIsInstalled(
- steam: SteamLaunchOptionsSnapshot,
- nonSteam: boolean,
- transport: TargetTransport,
- wrapperPath: string,
-): boolean {
- return usesShortcutTarget(nonSteam, transport)
- ? steam.target === wrapperPath
- : hasWrapperLaunchIntegration(steam.options, wrapperPath);
-}
-
function makeSnapshot(
steam: SteamLaunchOptionsSnapshot,
result: Awaited>,
@@ -97,17 +70,16 @@ function makeSnapshot(
if (!result.state) throw new Error("Workaround state is not initialized for this profile");
const wrapperPath = result.wrapper_path || getDefaultWrapperPath();
const selectedTransport = result.transport || transport;
- if (usesShortcutTarget(nonSteam, selectedTransport) && steam.target === wrapperPath && !result.shortcut_exe) {
- throw new Error("Managed shortcut Target has no saved original executable");
- }
+ const shortcutExe = selectedTransport.kind === "flatpak" ? result.shortcut_exe : undefined;
+ assertKnownShortcutTarget(steam, nonSteam, selectedTransport, wrapperPath, shortcutExe);
return {
steam,
state: result.state,
wrapperPath,
wrapperOwned: result.wrapper_owned === true,
- integrationInstalled: integrationIsInstalled(steam, nonSteam, selectedTransport, wrapperPath),
+ integrationInstalled: isWrapperIntegrationInstalled(steam, nonSteam, selectedTransport, wrapperPath),
commandTokenAdded: result.command_token_added === true,
- shortcutExe: result.shortcut_exe,
+ shortcutExe,
transport: selectedTransport,
};
}
@@ -116,24 +88,8 @@ async function adoptWorkaroundState(
appId: string,
nonSteam: boolean,
transport: TargetTransport,
- steam: SteamLaunchOptionsSnapshot,
wrapperPath: string,
): Promise {
- const shortcutTarget = usesShortcutTarget(nonSteam, transport);
- if (shortcutTarget && (!steam.target || steam.target === wrapperPath || isLegacyWrapperToken(steam.target))) {
- throw new Error("Shortcut Target is a wrapper but its original Target is unknown");
- }
- const originalExecutable = shortcutTarget
- ? selectShortcutExecutable(transport, steam.target)
- : null;
- const initial = await setWorkaroundState(
- appId,
- DEFAULT_WORKAROUND_STATE,
- originalExecutable,
- false,
- transport,
- );
- if (!initial.success) throw new Error(initial.error || "Could not create workaround state");
let integration: Awaited> | null = null;
try {
integration = await installWrapperIntegration(
@@ -141,14 +97,12 @@ async function adoptWorkaroundState(
nonSteam,
wrapperPath,
false,
- transport.kind,
+ transport,
);
const finalized = await setWorkaroundState(
appId,
DEFAULT_WORKAROUND_STATE,
- shortcutTarget
- ? (selectShortcutExecutable(transport, integration.originalExecutable, originalExecutable) || null)
- : null,
+ integration.originalExecutable ?? null,
integration.commandTokenAdded,
transport,
);
@@ -156,17 +110,15 @@ async function adoptWorkaroundState(
return makeSnapshot(integration.snapshot, finalized, nonSteam, transport);
} catch (error) {
let rollbackSucceeded = true;
- if (integration) {
+ if (integration?.changed) {
try {
await removeWrapperIntegration(
Number(appId),
nonSteam,
wrapperPath,
- shortcutTarget
- ? (selectShortcutExecutable(transport, integration?.originalExecutable, originalExecutable) || undefined)
- : undefined,
- integration?.commandTokenAdded ?? false,
- transport.kind,
+ integration.originalExecutable,
+ integration.commandTokenAdded,
+ transport,
);
} catch {
// Leave the owned integration in place rather than guessing at cleanup.
@@ -203,7 +155,6 @@ export function usePerAppWorkarounds(
appId,
nonSteam,
transport,
- steam,
result.wrapper_path || getDefaultWrapperPath(),
);
}
@@ -243,7 +194,7 @@ export function usePerAppWorkarounds(
setSnapshot((current) => current ? {
...current,
steam,
- integrationInstalled: integrationIsInstalled(steam, nonSteam, current.transport, current.wrapperPath),
+ integrationInstalled: isWrapperIntegrationInstalled(steam, nonSteam, current.transport, current.wrapperPath),
} : current);
},
(subscriptionError) => {
@@ -278,22 +229,24 @@ export function usePerAppWorkarounds(
setError(null);
const nextState = { ...current.state, [field]: value } as WorkaroundState;
try {
+ const shortcutExe = current.transport.kind === "flatpak" ? current.shortcutExe ?? null : null;
const result = await setWorkaroundState(
appId,
nextState,
- current.shortcutExe ?? null,
+ shortcutExe,
current.commandTokenAdded,
current.transport,
);
if (!result.success || !result.state) throw new Error(result.error || "Could not save workaround state");
+ const selectedTransport = result.transport || current.transport;
applySnapshot({
...current,
state: result.state,
wrapperPath: result.wrapper_path || current.wrapperPath,
wrapperOwned: result.wrapper_owned === true,
- shortcutExe: result.shortcut_exe,
+ shortcutExe: selectedTransport.kind === "flatpak" ? result.shortcut_exe : undefined,
commandTokenAdded: result.command_token_added === true,
- transport: result.transport || current.transport,
+ transport: selectedTransport,
});
return true;
} catch (updateError) {
diff --git a/src/utils/steamLaunchOptions.ts b/src/utils/steamLaunchOptions.ts
index 65541d8..959ce9e 100644
--- a/src/utils/steamLaunchOptions.ts
+++ b/src/utils/steamLaunchOptions.ts
@@ -1,3 +1,5 @@
+import type { TargetTransport } from "../api/lsfgApi";
+
const DEFAULT_WRAPPER_PATH = "~/.lsfg";
const COMMAND_TOKEN = "%command%";
@@ -31,6 +33,7 @@ export interface WrapperIntegrationResult {
snapshot: SteamLaunchOptionsSnapshot;
originalExecutable?: string;
commandTokenAdded: boolean;
+ changed: boolean;
}
function asError(error: unknown): Error {
@@ -159,6 +162,13 @@ const commandIndex = (tokens: readonly LaunchToken[]) => tokens.findIndex((token
const isAssignment = (token: LaunchToken) => /^[A-Za-z_][A-Za-z0-9_]*=/.test(token.value);
const isLegacyToken = (value: string) => LEGACY_WRAPPER_TOKENS.has(value) || LEGACY_ABSOLUTE_WRAPPER.test(value);
const isWrapperToken = (value: string, wrapperPath: string) => decodeToken(value) === wrapperPath || isLegacyWrapperToken(value);
+const usesShortcutTarget = (nonSteam: boolean, transport: TargetTransport) => nonSteam && transport.kind === "flatpak";
+
+function selectFlatpakExecutable(transport: TargetTransport, candidate?: string | null): string | undefined {
+ if (transport.kind !== "flatpak") return undefined;
+ const value = candidate?.trim();
+ return value ? (value.startsWith("/") ? value : "/usr/bin/flatpak") : undefined;
+}
export const normalizeLaunchOptions = (options: string) => serialize(tokenize(options));
export const isLegacyWrapperToken = (value: string) => isLegacyToken(decodeToken(value));
@@ -172,10 +182,10 @@ function removeMatchingWrappers(tokens: LaunchToken[], predicate: (value: string
return true;
}
-export function installWrapperLaunchOption(
+function installLaunchOption(
options: string,
wrapperPath = DEFAULT_WRAPPER_PATH,
- allowCommandArgs = false,
+ shortcutLaunchOptions = false,
) {
const tokens = tokenize(options);
removeMatchingWrappers(tokens, isLegacyToken);
@@ -189,7 +199,7 @@ export function installWrapperLaunchOption(
}
let insertion = 0;
while (insertion < tokens.length && isAssignment(tokens[insertion])) insertion++;
- if (!allowCommandArgs && insertion < tokens.length && !tokens[insertion].value.startsWith("-")) {
+ if (!shortcutLaunchOptions && insertion < tokens.length && !tokens[insertion].value.startsWith("-")) {
throw new Error("Launch options do not contain %command%; refusing to guess a launcher command");
}
tokens.splice(insertion, 0,
@@ -199,6 +209,10 @@ export function installWrapperLaunchOption(
return { options: serialize(tokens), commandTokenAdded: true };
}
+export function installWrapperLaunchOption(options: string, wrapperPath = DEFAULT_WRAPPER_PATH) {
+ return installLaunchOption(options, wrapperPath);
+}
+
export function removeWrapperLaunchOption(
options: string,
wrapperPath = DEFAULT_WRAPPER_PATH,
@@ -249,6 +263,29 @@ export function hasWrapperLaunchIntegration(options: string, wrapperPath = DEFAU
return command > 0 && tokens[command - 1].value === wrapperPath;
}
+export function isWrapperIntegrationInstalled(
+ steam: SteamLaunchOptionsSnapshot,
+ nonSteam: boolean,
+ transport: TargetTransport,
+ wrapperPath = DEFAULT_WRAPPER_PATH,
+): boolean {
+ return usesShortcutTarget(nonSteam, transport)
+ ? steam.target === wrapperPath
+ : hasWrapperLaunchIntegration(steam.options, wrapperPath);
+}
+
+export function assertKnownShortcutTarget(
+ steam: SteamLaunchOptionsSnapshot,
+ nonSteam: boolean,
+ transport: TargetTransport,
+ wrapperPath: string,
+ originalExecutable?: string | null,
+): void {
+ if (usesShortcutTarget(nonSteam, transport) && steam.target === wrapperPath && !originalExecutable) {
+ throw new Error("Managed shortcut Target has no saved original executable");
+ }
+}
+
const queues = new Map>();
function queued(appId: number, nonSteam: boolean, operation: () => Promise): Promise