proper fix for disabling sandbox on steamos (#206)

Co-authored-by: Vendicated <vendicated@riseup.net>

package.json

@@ -1,6 +1,6 @@
 {
     "name": "VencordDesktop",
-    "version": "0.4.2",
+    "version": "0.4.3",
     "private": true,
     "description": "",
     "keywords": [],
@@ -26,7 +26,7 @@
         "arrpc": "github:OpenAsar/arrpc#89f4da610ccfac93f461826a446a17cd3b23953d"
     },
     "optionalDependencies": {
-        "@vencord/venmic": "^1.6.0"
+        "@vencord/venmic": "^1.7.0"
     },
     "devDependencies": {
         "@fal-works/esbuild-plugin-global-externals": "^2.1.2",
@@ -68,6 +68,7 @@
             "package.json",
             "LICENSE"
         ],
+        "beforePack": "scripts/build/sandboxFix.js",
         "linux": {
             "icon": "build/icon.icns",
             "category": "Network",

pnpm-lock.yaml

@@ -11,8 +11,8 @@ dependencies:
 
 optionalDependencies:
   '@vencord/venmic':
-    specifier: ^1.6.0
-    version: 1.6.0
+    specifier: ^1.7.0
+    version: 1.7.0
 
 devDependencies:
   '@fal-works/esbuild-plugin-global-externals':
@@ -960,8 +960,8 @@ packages:
       type-fest: 3.13.1
     dev: true
 
-  /@vencord/venmic@1.6.0:
-    resolution: {integrity: sha512-Agh5+gDiHpqsSrrxyazeU+1JmZD286QoKj41t/omw6EmtSS8EPiENQSn7eXmXt/ooSEfa9qoXEG+Hn6hXb3rvw==}
+  /@vencord/venmic@1.7.0:
+    resolution: {integrity: sha512-WtIfoPaFWMU0Q98KQx9BTjTQQgevb0hwpTiJTDi5uL274JRSt5lm/J5qIwsYrPNsvLv0AJvyUV0Zc8dU+hUc5w==}
     engines: {node: '>=14.15'}
     os: [linux]
     requiresBuild: true

scripts/build/sandboxFix.js

@@ -0,0 +1,74 @@
+/*
+ * SPDX-License-Identifier: GPL-3.0
+ * Vesktop, a desktop app aiming to give you a snappier Discord Experience
+ * Copyright (c) 2023 Vendicated and Vencord contributors
+ */
+
+// Based on https://github.com/gergof/electron-builder-sandbox-fix/blob/master/lib/index.js
+
+const fs = require("fs/promises");
+const path = require("path");
+let isApplied = false;
+
+const hook = async () => {
+    if (isApplied) return;
+    isApplied = true;
+    if (process.platform !== "linux") {
+        // this fix is only required on linux
+        return;
+    }
+    const AppImageTarget = require("app-builder-lib/out/targets/AppImageTarget");
+    const oldBuildMethod = AppImageTarget.default.prototype.build;
+    AppImageTarget.default.prototype.build = async function (...args) {
+        console.log("Running AppImage builder hook", args);
+        const oldPath = args[0];
+        const newPath = oldPath + "-appimage-sandbox-fix";
+        // just in case
+        try {
+            await fs.rm(newPath, {
+                recursive: true
+            });
+        } catch {}
+
+        console.log("Copying to apply appimage fix", oldPath, newPath);
+        await fs.cp(oldPath, newPath, {
+            recursive: true
+        });
+        args[0] = newPath;
+
+        const executable = path.join(newPath, this.packager.executableName);
+
+        const loaderScript = `
+#!/usr/bin/env bash
+
+SCRIPT_DIR="$( cd "$( dirname "\${BASH_SOURCE[0]}" )" && pwd )"
+IS_STEAMOS=0
+
+if [[ "$SteamOS" == "1" && "$SteamGamepadUI" == "1" ]]; then
+    echo "Running Vesktop on SteamOS, disabling sandbox"
+    IS_STEAMOS=1
+fi
+
+exec "$SCRIPT_DIR/${this.packager.executableName}.bin" "$([ "$IS_STEAMOS" == 1 ] && echo '--no-sandbox')" "$@"
+                `.trim();
+
+        try {
+            await fs.rename(executable, executable + ".bin");
+            await fs.writeFile(executable, loaderScript);
+            await fs.chmod(executable, 0o755);
+        } catch (e) {
+            console.error("failed to create loder for sandbox fix: " + e.message);
+            throw new Error("Failed to create loader for sandbox fix");
+        }
+
+        const ret = await oldBuildMethod.apply(this, args);
+
+        await fs.rm(newPath, {
+            recursive: true
+        });
+
+        return ret;
+    };
+};
+
+module.exports = hook;

src/main/constants.ts

@@ -34,3 +34,8 @@ const UserAgents = {
 };
 
 export const UserAgent = UserAgents[process.platform] || UserAgents.windows;
+
+export const enum MessageBoxChoice {
+    Default,
+    Cancel
+}

src/main/mainWindow.ts

@@ -28,6 +28,7 @@ import {
     DATA_DIR,
     DEFAULT_HEIGHT,
     DEFAULT_WIDTH,
+    MessageBoxChoice,
     MIN_HEIGHT,
     MIN_WIDTH,
     UserAgent,
@@ -36,11 +37,14 @@ import {
 import { Settings, VencordSettings } from "./settings";
 import { createSplashWindow } from "./splash";
 import { makeLinksOpenExternally } from "./utils/makeLinksOpenExternally";
+import { applyDeckKeyboardFix, askToApplySteamLayout, isDeckGameMode } from "./utils/steamOS";
 import { downloadVencordFiles, ensureVencordFiles } from "./utils/vencordLoader";
 
 let isQuitting = false;
 let tray: Tray;
 
+applyDeckKeyboardFix();
+
 app.on("before-quit", () => {
     isQuitting = true;
 });
@@ -128,11 +132,6 @@ function initTray(win: BrowserWindow) {
     });
 }
 
-const enum MessageBoxChoice {
-    Default,
-    Cancel
-}
-
 async function clearData(win: BrowserWindow) {
     const { response } = await dialog.showMessageBox(win, {
         message: "Are you sure you want to reset Vesktop?",
@@ -266,6 +265,9 @@ function initMenuBar(win: BrowserWindow) {
 }
 
 function getWindowBoundsOptions(): BrowserWindowConstructorOptions {
+    // We want the default window behaivour to apply in game mode since it expects everything to be fullscreen and maximized.
+    if (isDeckGameMode) return {};
+
     const { x, y, width, height } = Settings.store.windowBounds ?? {};
 
     const options = {
@@ -288,7 +290,8 @@ function getWindowBoundsOptions(): BrowserWindowConstructorOptions {
 
 function getDarwinOptions(): BrowserWindowConstructorOptions {
     const options = {
-        titleBarStyle: "hiddenInset"
+        titleBarStyle: "hidden",
+        trafficLightPosition: { x: 10, y: 10 }
     } as BrowserWindowConstructorOptions;
 
     const { splashTheming, splashBackground } = Settings.store;
@@ -404,7 +407,7 @@ function createMainWindow() {
     win.setMenuBarVisibility(false);
 
     win.on("close", e => {
-        const useTray = Settings.store.minimizeToTray !== false && Settings.store.tray !== false;
+        const useTray = !isDeckGameMode && Settings.store.minimizeToTray !== false && Settings.store.tray !== false;
         if (isQuitting || (process.platform !== "darwin" && !useTray)) return;
 
         e.preventDefault();
@@ -418,7 +421,7 @@ function createMainWindow() {
     if (Settings.store.staticTitle) win.on("page-title-updated", e => e.preventDefault());
 
     initWindowBoundsListeners(win);
-    if ((Settings.store.tray ?? true) && process.platform !== "darwin") initTray(win);
+    if (!isDeckGameMode && (Settings.store.tray ?? true) && process.platform !== "darwin") initTray(win);
     initMenuBar(win);
     makeLinksOpenExternally(win);
     initSettingsListeners(win);
@@ -440,19 +443,27 @@ const runVencordMain = once(() => require(join(VENCORD_FILES_DIR, "vencordDeskto
 
 export async function createWindows() {
     const splash = createSplashWindow();
-
+    // SteamOS letterboxes and scales it terribly, so just full screen it
+    if (isDeckGameMode) splash.setFullScreen(true);
     await ensureVencordFiles();
     runVencordMain();
 
     mainWin = createMainWindow();
 
-    mainWin.once("ready-to-show", () => {
+    mainWin.webContents.on("did-finish-load", () => {
         splash.destroy();
         mainWin!.show();
 
-        if (Settings.store.maximized) {
+        if (Settings.store.maximized && !isDeckGameMode) {
             mainWin!.maximize();
         }
+
+        if (isDeckGameMode) {
+            // always use entire display
+            mainWin!.setFullScreen(true);
+
+            askToApplySteamLayout(mainWin);
+        }
     });
 
     initArRPC();

src/main/utils/steamOS.ts

@@ -0,0 +1,84 @@
+/*
+ * SPDX-License-Identifier: GPL-3.0
+ * Vesktop, a desktop app aiming to give you a snappier Discord Experience
+ * Copyright (c) 2023 Vendicated and Vencord contributors
+ */
+
+import { exec as callbackExec } from "child_process";
+import { BrowserWindow, dialog } from "electron";
+import { sleep } from "shared/utils/sleep";
+import { promisify } from "util";
+
+import { MessageBoxChoice } from "../constants";
+import { Settings } from "../settings";
+
+const exec = promisify(callbackExec);
+
+// Bump this to re-show the prompt
+const layoutVersion = 1;
+// Get this from "show details" on the profile after exporting as a shared personal layout or using share with community
+const layoutId = "3063409873"; // Vesktop Layout v1
+const numberRegex = /^[0-9]*$/;
+
+export const isDeckGameMode = process.env.SteamOS === "1" && process.env.SteamGamepadUI === "1";
+
+export function applyDeckKeyboardFix() {
+    if (!isDeckGameMode) return;
+    // Prevent constant virtual keyboard spam that eventually crashes Steam.
+    process.env.GTK_IM_MODULE = "None";
+}
+
+// For some reason SteamAppId is always 0 for non-steam apps so we do this insanity instead.
+function getAppId(): string | null {
+    // /home/deck/.local/share/Steam/steamapps/shadercache/APPID/fozmediav1
+    const path = process.env.STEAM_COMPAT_MEDIA_PATH;
+    if (!path) return null;
+    const pathElems = path?.split("/");
+    const appId = pathElems[pathElems.length - 2];
+    if (appId.match(numberRegex)) {
+        console.log(`Got Steam App ID ${appId}`);
+        return appId;
+    }
+    return null;
+}
+
+async function execSteamURL(url: string): Promise<void> {
+    await exec(`steam -ifrunning ${url}`);
+}
+
+async function showLayout(appId: string) {
+    await execSteamURL(`steam://controllerconfig/${appId}/${layoutId}`);
+    // because the UI doesn't consistently reload after the data for the config has loaded...
+    // HOW HAS NOBODY AT VALVE RUN INTO THIS YET
+    await sleep(100);
+    await execSteamURL(`steam://controllerconfig/${appId}/${layoutId}`);
+}
+
+export async function askToApplySteamLayout(win: BrowserWindow) {
+    const appId = getAppId();
+    if (!appId) return;
+    if (Settings.store.steamOSLayoutVersion === layoutVersion) return;
+    const update = Boolean(Settings.store.steamOSLayoutVersion);
+
+    // Touch screen breaks in some menus when native touch mode is enabled on latest SteamOS beta, remove most of the update specific text once that's fixed.
+    const { response } = await dialog.showMessageBox(win, {
+        message: `${update ? "Update" : "Apply"} Vesktop Steam Input Layout?`,
+        detail: `Would you like to ${update ? "Update" : "Apply"} Vesktop's recommended Steam Deck controller settings?
+${update ? "Click yes using the touchpad" : "Tap yes"}, then press the X button or tap Apply Layout to confirm.${
+            update ? " Doing so will undo any customizations you have made." : ""
+        }
+${update ? "Click" : "Tap"} no to keep your current layout.`,
+        buttons: ["Yes", "No"],
+        cancelId: MessageBoxChoice.Cancel,
+        defaultId: MessageBoxChoice.Default,
+        type: "question"
+    });
+
+    if (Settings.store.steamOSLayoutVersion !== layoutVersion) {
+        Settings.store.steamOSLayoutVersion = layoutVersion;
+    }
+
+    if (response === MessageBoxChoice.Cancel) return;
+
+    await showLayout(appId);
+}

src/shared/settings.d.ts

@@ -31,4 +31,6 @@ export interface Settings {
     splashTheming?: boolean;
     splashColor?: string;
     splashBackground?: string;
+
+    steamOSLayoutVersion?: number;
 }

src/shared/utils/sleep.ts

@@ -0,0 +1,9 @@
+/*
+ * SPDX-License-Identifier: GPL-3.0
+ * Vesktop, a desktop app aiming to give you a snappier Discord Experience
+ * Copyright (c) 2023 Vendicated and Vencord contributors
+ */
+
+export function sleep(ms: number): Promise<void> {
+    return new Promise(r => setTimeout(r, ms));
+}