[Feature] Configure scripts to run before and after a game is launched (#3565)

* Feature: before/after launch scripts for games

* Add i18next

* Say 'after exists' instead of 'after launched' to avoid confusion

* Fix log output

* Address feedback from PR review

* Use `Select script...` for the placeholder instead of `Select EXE...`

* File picker dialog title change

* Set default value for before/after launch script setting

* Update src/backend/launcher.ts

Co-authored-by: Mathis Dröge <[email protected]>

* Remove ...execOptions from spawn call

* Reorder inputs

---------

Co-authored-by: Mathis Dröge <[email protected]>

Author: arielj

public/locales/en/translation.json

@@ -119,7 +119,8 @@
         },
         "select": {
             "button": "Select",
-            "exe": "Select EXE"
+            "exe": "Select EXE",
+            "script": "Select script ..."
         },
         "shortcuts": {
             "message": "Shortcuts were created on Desktop and Start Menu",
@@ -572,6 +573,7 @@
         "addgamestoapplications": "Add games to Applications automatically",
         "addgamestostartmenu": "Add games to start menu automatically",
         "addgamestosteam": "Add games to Steam automatically",
+        "after-launch-script-path": "Select a script to run after the game exits",
         "alt-gogdl-bin": "Choose an Alternative GOGDL Binary to use",
         "alt-legendary-bin": "Choose an Alternative Legendary Binary",
         "alt-nile-bin": "Choose an Alternative Nile Binary",
@@ -580,6 +582,7 @@
         "autosync": "Autosync Saves",
         "autoUpdateGames": "Automatically update games",
         "autovkd3d": "Auto Install/Update VKD3D on Prefix",
+        "before-launch-script-path": "Select a script to run before the game is launched",
         "change-target-exe": "Select an alternative EXE to run",
         "checkForUpdatesOnStartup": "Check for Heroic Updates on Startup",
         "crossover-version": "Crossover/Wine Version",

src/backend/config.ts

@@ -316,7 +316,9 @@ class GlobalConfigV0 extends GlobalConfig {
       enableMsync: isMac,
       eacRuntime: isLinux,
       battlEyeRuntime: isLinux,
-      framelessWindow: false
+      framelessWindow: false,
+      beforeLaunchScriptPath: '',
+      afterLaunchScriptPath: ''
     }
     // @ts-expect-error TODO: We need to settle on *one* place to define settings defaults
     return settings

src/backend/game_config.ts

@@ -231,7 +231,9 @@ class GameConfigV0 extends GameConfig {
       wineVersion,
       useSteamRuntime,
       eacRuntime,
-      battlEyeRuntime
+      battlEyeRuntime,
+      beforeLaunchScriptPath,
+      afterLaunchScriptPath
     } = GlobalConfig.get().getSettings()
 
     // initialize generic defaults
@@ -260,7 +262,9 @@ class GameConfigV0 extends GameConfig {
       useSteamRuntime,
       battlEyeRuntime,
       eacRuntime,
-      language: '' // we want to fallback to '' always here, fallback lang for games should be ''
+      language: '', // we want to fallback to '' always here, fallback lang for games should be ''
+      beforeLaunchScriptPath,
+      afterLaunchScriptPath
     } as GameSettings
 
     let gameSettings = {} as GameSettings

src/backend/launcher.ts

@@ -44,6 +44,7 @@ import {
 import {
   appendFileLog,
   appendGameLog,
+  appendGamePlayLog,
   appendRunnerLog,
   initFileLog,
   initGameLog,
@@ -1306,6 +1307,86 @@ async function getWinePath({
   return stdout.trim()
 }
 
+async function runBeforeLaunchScript(
+  gameInfo: GameInfo,
+  gameSettings: GameSettings
+) {
+  if (!gameSettings.beforeLaunchScriptPath) {
+    return true
+  }
+
+  appendGamePlayLog(
+    gameInfo,
+    `Running script before ${gameInfo.title} (${gameSettings.beforeLaunchScriptPath})\n`
+  )
+
+  return runScriptForGame(gameInfo, gameSettings.beforeLaunchScriptPath)
+}
+
+async function runAfterLaunchScript(
+  gameInfo: GameInfo,
+  gameSettings: GameSettings
+) {
+  if (!gameSettings.afterLaunchScriptPath) {
+    return true
+  }
+
+  appendGamePlayLog(
+    gameInfo,
+    `Running script after ${gameInfo.title} (${gameSettings.afterLaunchScriptPath})\n`
+  )
+  return runScriptForGame(gameInfo, gameSettings.afterLaunchScriptPath)
+}
+
+/* Execute script before launch/after exit, wait until the script
+ * exits to continue
+ *
+ * The script can start sub-processes with `bash another-command &`
+ * if `another-command` should run asynchronously
+ *
+ * For example:
+ *
+ * ```
+ * #!/bin/bash
+ *
+ * echo "this runs before/after the game"
+ * bash ./another.bash & # this is launched before/after the game but is not waited
+ * echo "this also runs before/after the game too" > someoutput.txt
+ * ```
+ *
+ * Notes:
+ * - Output and logs are printed in the game's log
+ * - Make sure the script is executable
+ * - Make sure any async process is not stuck running in the background forever,
+ *   use the after script to kill any running process if that's the case
+ */
+async function runScriptForGame(
+  gameInfo: GameInfo,
+  scriptPath: string
+): Promise<boolean | string> {
+  return new Promise((resolve, reject) => {
+    const child = spawn(scriptPath, { cwd: gameInfo.install.install_path })
+
+    child.stdout.on('data', (data) => {
+      appendGamePlayLog(gameInfo, data.toString())
+    })
+
+    child.stderr.on('data', (data) => {
+      appendGamePlayLog(gameInfo, data.toString())
+    })
+
+    child.on('exit', () => {
+      resolve(true)
+    })
+
+    child.on('error', (err: Error) => {
+      appendGamePlayLog(gameInfo, err.message)
+      if (err.stack) appendGamePlayLog(gameInfo, err.stack)
+      reject(err.message)
+    })
+  })
+}
+
 export {
   prepareLaunch,
   launchCleanup,
@@ -1317,5 +1398,7 @@ export {
   runWineCommand,
   callRunner,
   getRunnerCallWithoutCredentials,
-  getWinePath
+  getWinePath,
+  runAfterLaunchScript,
+  runBeforeLaunchScript
 }

src/backend/main.ts

@@ -110,7 +110,11 @@ import {
 } from './logger/logger'
 import { gameInfoStore } from 'backend/storeManagers/legendary/electronStores'
 import { getFonts } from 'font-list'
-import { runWineCommand } from './launcher'
+import {
+  runAfterLaunchScript,
+  runBeforeLaunchScript,
+  runWineCommand
+} from './launcher'
 import shlex from 'shlex'
 import { initQueue } from './downloadmanager/downloadqueue'
 import {
@@ -1033,6 +1037,8 @@ ipcMain.handle(
       }
     }
 
+    await runBeforeLaunchScript(game, gameSettings)
+
     sendGameStatusUpdate({
       appName,
       runner,
@@ -1055,7 +1061,10 @@ ipcMain.handle(
 
         return false
       })
-      .finally(() => stopLogger(appName))
+      .finally(async () => {
+        await runAfterLaunchScript(game, gameSettings)
+        stopLogger(appName)
+      })
 
     // Stop display sleep blocker
     if (powerDisplayId !== null) {

src/common/types.ts

@@ -194,6 +194,8 @@ export interface GameSettings {
   wrapperOptions: WrapperVariable[]
   savesPath: string
   gogSaves?: GOGCloudSavesLocation[]
+  beforeLaunchScriptPath: string
+  afterLaunchScriptPath: string
 }
 
 export type Status =

src/frontend/screens/Settings/components/AfterLaunchScriptPath.tsx

@@ -0,0 +1,34 @@
+import React, { useContext } from 'react'
+import { useTranslation } from 'react-i18next'
+import SettingsContext from '../SettingsContext'
+import useSetting from 'frontend/hooks/useSetting'
+import { PathSelectionBox } from 'frontend/components/UI'
+
+const AfterLaunchScriptPath = () => {
+  const { t } = useTranslation()
+  const { isDefault, gameInfo } = useContext(SettingsContext)
+
+  const [scriptPath, setScriptPath] = useSetting('afterLaunchScriptPath', '')
+
+  if (isDefault) {
+    return <></>
+  }
+
+  return (
+    <PathSelectionBox
+      type="file"
+      onPathChange={setScriptPath}
+      path={scriptPath}
+      pathDialogTitle={t('box.select.script', 'Select script ...')}
+      pathDialogDefaultPath={gameInfo?.install.install_path}
+      placeholder={scriptPath || t('box.select.script', 'Select script ...')}
+      label={t(
+        'setting.after-launch-script-path',
+        'Select a script to run after the game exits'
+      )}
+      htmlId="after-launch-script-path"
+    />
+  )
+}
+
+export default AfterLaunchScriptPath

src/frontend/screens/Settings/components/BeforeLaunchScriptPath.tsx

@@ -0,0 +1,34 @@
+import React, { useContext } from 'react'
+import { useTranslation } from 'react-i18next'
+import SettingsContext from '../SettingsContext'
+import useSetting from 'frontend/hooks/useSetting'
+import { PathSelectionBox } from 'frontend/components/UI'
+
+const BeforeLaunchScriptPath = () => {
+  const { t } = useTranslation()
+  const { isDefault, gameInfo } = useContext(SettingsContext)
+
+  const [scriptPath, setScriptPath] = useSetting('beforeLaunchScriptPath', '')
+
+  if (isDefault) {
+    return <></>
+  }
+
+  return (
+    <PathSelectionBox
+      type="file"
+      onPathChange={setScriptPath}
+      path={scriptPath}
+      pathDialogTitle={t('box.select.script', 'Select script ...')}
+      pathDialogDefaultPath={gameInfo?.install.install_path}
+      placeholder={scriptPath || t('box.select.script', 'Select script ...')}
+      label={t(
+        'setting.before-launch-script-path',
+        'Select a script to run before the game is launched'
+      )}
+      htmlId="before-launch-script-path"
+    />
+  )
+}
+
+export default BeforeLaunchScriptPath

src/frontend/screens/Settings/components/index.ts

@@ -52,3 +52,5 @@ export { default as EnableDXVKFpsLimit } from './EnableDXVKFpsLimit'
 export { default as PlaytimeSync } from './PlaytimeSync'
 export { default as ClearCache } from './ClearCache'
 export { default as ResetHeroic } from './ResetHeroic'
+export { default as BeforeLaunchScriptPath } from './BeforeLaunchScriptPath'
+export { default as AfterLaunchScriptPath } from './AfterLaunchScriptPath'

src/frontend/screens/Settings/sections/GamesSettings/index.tsx

@@ -30,7 +30,9 @@ import {
   WrappersTable,
   EnableDXVKFpsLimit,
   IgnoreGameUpdates,
-  Gamescope
+  Gamescope,
+  BeforeLaunchScriptPath,
+  AfterLaunchScriptPath
 } from '../../components'
 import ContextProvider from 'frontend/state/ContextProvider'
 import Tools from '../../components/Tools'
@@ -234,6 +236,11 @@ export default function GamesSettings() {
         )}
         <AlternativeExe />
         <LauncherArgs />
+        <div className="Field">
+          <label>Scripts:</label>
+          <BeforeLaunchScriptPath />
+          <AfterLaunchScriptPath />
+        </div>
         <WrappersTable />
         <EnvVariablesTable />
         {!isSideloaded && <PreferedLanguage />}