Add support for passing parameters via protocol

The new `arg` parameter can be used (multiple times if necessary) to specify
extra parameters to pass to runners/the game

Author: CommandMC

src/backend/launcher.ts

@@ -101,7 +101,8 @@ const launchEventCallback: (args: LaunchParams) => StatusPromise = async ({
   appName,
   launchArguments,
   runner,
-  skipVersionCheck
+  skipVersionCheck,
+  args
 }) => {
   const game = gameManagerMap[runner].getGameInfo(appName)
   const gameSettings = await gameManagerMap[runner].getSettings(appName)
@@ -203,6 +204,7 @@ const launchEventCallback: (args: LaunchParams) => StatusPromise = async ({
   const command = gameManagerMap[runner].launch(
     appName,
     launchArguments,
+    args,
     skipVersionCheck
   )
 

src/backend/protocol.ts

@@ -35,6 +35,7 @@ function handlePing(url: URL) {
 async function handleLaunch(url: URL) {
   let appName
   let runnerStr
+  let args: string[] = []
 
   if (url.pathname) {
     // Old-style pathname URLs:
@@ -48,6 +49,7 @@ async function handleLaunch(url: URL) {
     // `heroic://launch?appName=Quail&runner=legendary&arg=foo&arg=bar`
     appName = url.searchParams.get('appName')
     runnerStr = url.searchParams.get('runner')
+    args = url.searchParams.getAll('arg')
   }
 
   if (!appName) {
@@ -75,7 +77,8 @@ async function handleLaunch(url: URL) {
     return launchEventCallback({
       appName: appName,
       runner: gameInfo.runner,
-      skipVersionCheck: settings.ignoreGameUpdates
+      skipVersionCheck: settings.ignoreGameUpdates,
+      args
     })
   }
 

src/backend/storeManagers/gog/games.ts

@@ -485,7 +485,8 @@ export async function removeShortcuts(appName: string) {
 
 export async function launch(
   appName: string,
-  launchArguments?: LaunchOption
+  launchArguments?: LaunchOption,
+  args: string[] = []
 ): Promise<boolean> {
   const gameSettings = await getSettings(appName)
   const gameInfo = getGameInfo(appName)
@@ -600,7 +601,8 @@ export async function launch(
     ...shlex.split(
       (launchArguments as BaseLaunchOption | undefined)?.parameters ?? ''
     ),
-    ...shlex.split(gameSettings.launcherArgs ?? '')
+    ...shlex.split(gameSettings.launcherArgs ?? ''),
+    ...args
   ]
 
   if (gameInfo.install.cyberpunk?.modsEnabled) {

src/backend/storeManagers/legendary/games.ts

@@ -838,6 +838,7 @@ export async function syncSaves(
 export async function launch(
   appName: string,
   launchArguments?: LaunchOption,
+  args: string[] = [],
   skipVersionCheck = false
 ): Promise<boolean> {
   const gameSettings = await getSettings(appName)
@@ -929,6 +930,7 @@ export async function launch(
     subcommand: 'launch',
     appName: LegendaryAppName.parse(appNameToLaunch),
     extraArguments: [
+      ...args,
       launchArguments?.type !== 'dlc' ? launchArguments?.parameters : undefined,
       gameSettings.launcherArgs
     ]

src/backend/storeManagers/nile/games.ts

@@ -310,7 +310,8 @@ export async function removeShortcuts(appName: string) {
 
 export async function launch(
   appName: string,
-  launchArguments?: LaunchOption
+  launchArguments?: LaunchOption,
+  args: string[] = []
 ): Promise<boolean> {
   const gameSettings = await getSettings(appName)
   const gameInfo = getGameInfo(appName)
@@ -407,7 +408,8 @@ export async function launch(
       (launchArguments as BaseLaunchOption | undefined)?.parameters ?? ''
     ),
     ...shlex.split(gameSettings.launcherArgs ?? ''),
-    appName
+    appName,
+    ...args
   ]
   const fullCommand = getRunnerCallWithoutCredentials(
     commandParts,

src/backend/storeManagers/sideload/games.ts

@@ -68,10 +68,10 @@ export async function isGameAvailable(appName: string): Promise<boolean> {
 
 export async function launch(
   appName: string,
-  /* eslint-disable-next-line @typescript-eslint/no-unused-vars */
-  launchArguments?: LaunchOption
+  launchArguments?: LaunchOption,
+  args: string[] = []
 ): Promise<boolean> {
-  return launchGame(appName, getGameInfo(appName), 'sideload')
+  return launchGame(appName, getGameInfo(appName), 'sideload', args)
 }
 
 export async function stop(appName: string): Promise<void> {

src/backend/storeManagers/storeManagerCommon/games.ts

@@ -120,7 +120,8 @@ const openNewBrowserGameWindow = async ({
 export async function launchGame(
   appName: string,
   gameInfo: GameInfo,
-  runner: Runner
+  runner: Runner,
+  args: string[] = []
 ): Promise<boolean> {
   if (!gameInfo) {
     return false
@@ -151,7 +152,7 @@ export async function launchGame(
 
   const gameSettings = await getAppSettings(appName)
   const { launcherArgs } = gameSettings
-  const extraArgs = shlex.split(launcherArgs ?? '')
+  const extraArgs = [...shlex.split(launcherArgs ?? ''), ...args]
   const extraArgsJoined = extraArgs.join(' ')
 
   if (executable) {

src/common/types.ts

@@ -29,6 +29,7 @@ export type LaunchParams = {
   launchArguments?: LaunchOption
   runner: Runner
   skipVersionCheck?: boolean
+  args?: string[]
 }
 
 export type LaunchOption = BaseLaunchOption | DLCLaunchOption

src/common/types/frontend_messages.ts

@@ -34,7 +34,7 @@ type FrontendMessages = {
     status: ConnectivityStatus
     retryIn: number
   }) => void
-  launchGame: (appName: string, runner: Runner) => void
+  launchGame: (appName: string, runner: Runner, args: string[]) => void
   installGame: (appName: string, runner: Runner) => void
   recentGamesChanged: (newRecentGames: RecentGame[]) => void
   pushGameToLibrary: (info: GameInfo) => void

src/common/types/game_manager.ts

@@ -43,6 +43,7 @@ export interface GameManager {
   launch: (
     appName: string,
     launchArguments?: LaunchOption,
+    args?: string[],
     skipVersionCheck?: boolean
   ) => Promise<boolean>
   moveInstall: (