[UX] Enable/disable logs game-by-game instead of globally

public/locales/en/translation.json

@@ -744,6 +744,9 @@
         "showMetalOverlay": "Show Stats Overlay",
         "start-in-tray": "Start Minimized",
         "steamruntime": "Use Steam Runtime",
+        "verboseLogs": {
+            "description": "Enable verbose logs"
+        },
         "winecrossoverbottle": "CrossOver Bottle",
         "wineprefix": "WinePrefix folder",
         "wineversion": "Wine Version"

src/backend/config.ts

@@ -322,7 +322,8 @@ class GlobalConfigV0 extends GlobalConfig {
       framelessWindow: false,
       beforeLaunchScriptPath: '',
       afterLaunchScriptPath: '',
-      disableUMU: false
+      disableUMU: false,
+      verboseLogs: false
     }
     // @ts-expect-error TODO: We need to settle on *one* place to define settings defaults
     return settings

src/backend/game_config.ts

@@ -234,7 +234,8 @@ class GameConfigV0 extends GameConfig {
       battlEyeRuntime,
       beforeLaunchScriptPath,
       afterLaunchScriptPath,
-      gamescope
+      gamescope,
+      verboseLogs
     } = GlobalConfig.get().getSettings()
 
     // initialize generic defaults
@@ -266,7 +267,8 @@ class GameConfigV0 extends GameConfig {
       language: '', // we want to fallback to '' always here, fallback lang for games should be ''
       beforeLaunchScriptPath,
       afterLaunchScriptPath,
-      gamescope
+      gamescope,
+      verboseLogs
     } as GameSettings
 
     let gameSettings = {} as GameSettings

src/backend/launcher.ts

@@ -161,13 +161,6 @@ const launchEventCallback: (args: LaunchParams) => StatusPromise = async ({
 
   initGamePlayLog(game)
 
-  if (logsDisabled) {
-    appendGamePlayLog(
-      game,
-      'IMPORTANT: Logs are disabled. Enable logs before reporting an issue.'
-    )
-  }
-
   const isNative = gameManagerMap[runner].isNative(appName)
 
   // check if isNative, if not, check if wine is valid
@@ -1695,23 +1688,27 @@ async function runScriptForGame(
       env: scriptEnv
     })
 
-    child.stdout.on('data', (data) => {
-      appendGamePlayLog(gameInfo, data.toString())
-    })
+    if (gameSettings.verboseLogs) {
+      child.stdout.on('data', (data) => {
+        appendGamePlayLog(gameInfo, data.toString())
+      })
+
+      child.stderr.on('data', (data) => {
+        appendGamePlayLog(gameInfo, data.toString())
+      })
+    }
 
-    child.stderr.on('data', (data) => {
-      appendGamePlayLog(gameInfo, data.toString())
+    child.on('error', (err: Error) => {
+      if (gameSettings.verboseLogs) {
+        appendGamePlayLog(gameInfo, err.message)
+        if (err.stack) appendGamePlayLog(gameInfo, err.stack)
+      }
+      reject(err.message)
     })
 
     child.on('exit', () => {
       resolve(true)
     })
-
-    child.on('error', (err: Error) => {
-      appendGamePlayLog(gameInfo, err.message)
-      if (err.stack) appendGamePlayLog(gameInfo, err.stack)
-      reject(err.message)
-    })
   })
 }
 

src/backend/storeManagers/gog/games.ts

@@ -63,7 +63,6 @@ import {
   logFileLocation,
   logInfo,
   LogPrefix,
-  logsDisabled,
   logWarning
 } from '../../logger/logger'
 import { GOGUser } from './user'
@@ -688,6 +687,13 @@ export async function launch(
   )
   appendGamePlayLog(gameInfo, `Launch Command: ${fullCommand}\n\nGame Log:\n`)
 
+  if (!gameSettings.verboseLogs) {
+    appendGamePlayLog(
+      gameInfo,
+      'IMPORTANT: Logs are disabled. Enable verbose logs before reporting an issue.'
+    )
+  }
+
   const userData: UserData | undefined = configStore.get_nodefault('userData')
 
   sendGameStatusUpdate({ appName, runner: 'gog', status: 'playing' })
@@ -722,7 +728,7 @@ export async function launch(
     wrappers,
     logMessagePrefix: `Launching ${gameInfo.title}`,
     onOutput: (output: string) => {
-      if (!logsDisabled) appendGamePlayLog(gameInfo, output)
+      if (gameSettings.verboseLogs) appendGamePlayLog(gameInfo, output)
     }
   })
 

src/backend/storeManagers/legendary/games.ts

@@ -48,8 +48,7 @@ import {
   logError,
   logFileLocation,
   logInfo,
-  LogPrefix,
-  logsDisabled
+  LogPrefix
 } from '../../logger/logger'
 import {
   prepareLaunch,
@@ -953,6 +952,13 @@ export async function launch(
   )
   appendGamePlayLog(gameInfo, `Launch Command: ${fullCommand}\n\nGame Log:\n`)
 
+  if (!gameSettings.verboseLogs) {
+    appendGamePlayLog(
+      gameInfo,
+      'IMPORTANT: Logs are disabled. Enable verbose logs before reporting an issue.'
+    )
+  }
+
   sendGameStatusUpdate({ appName, runner: 'legendary', status: 'playing' })
 
   const { error } = await runLegendaryCommand(command, {
@@ -961,7 +967,7 @@ export async function launch(
     wrappers: wrappers,
     logMessagePrefix: `Launching ${gameInfo.title}`,
     onOutput: (output) => {
-      if (!logsDisabled) appendGamePlayLog(gameInfo, output)
+      if (gameSettings.verboseLogs) appendGamePlayLog(gameInfo, output)
     }
   })
 

src/backend/storeManagers/nile/games.ts

@@ -25,8 +25,7 @@ import {
   logDebug,
   logError,
   logFileLocation,
-  logInfo,
-  logsDisabled
+  logInfo
 } from 'backend/logger/logger'
 import { isLinux, isWindows } from 'backend/constants'
 import { GameConfig } from 'backend/game_config'
@@ -418,6 +417,13 @@ export async function launch(
   )
   appendGamePlayLog(gameInfo, `Launch Command: ${fullCommand}\n\nGame Log:\n`)
 
+  if (!gameSettings.verboseLogs) {
+    appendGamePlayLog(
+      gameInfo,
+      'IMPORTANT: Logs are disabled. Enable verbose logs before reporting an issue.'
+    )
+  }
+
   sendGameStatusUpdate({ appName, runner: 'nile', status: 'playing' })
 
   const { error } = await runNileCommand(commandParts, {
@@ -426,7 +432,7 @@ export async function launch(
     wrappers,
     logMessagePrefix: `Launching ${gameInfo.title}`,
     onOutput(output) {
-      if (!logsDisabled) appendGamePlayLog(gameInfo, output)
+      if (gameSettings.verboseLogs) appendGamePlayLog(gameInfo, output)
     }
   })
 

src/backend/storeManagers/storeManagerCommon/games.ts

@@ -7,7 +7,6 @@ import {
   lastPlayLogFileLocation,
   logInfo,
   LogPrefix,
-  logsDisabled,
   logWarning
 } from '../../logger/logger'
 import { basename, dirname } from 'path'
@@ -264,7 +263,7 @@ export async function launchGame(
         logFile: lastPlayLogFileLocation(appName),
         logMessagePrefix: LogPrefix.Backend,
         onOutput: (output) => {
-          if (!logsDisabled) appendGamePlayLog(gameInfo, output)
+          if (gameSettings.verboseLogs) appendGamePlayLog(gameInfo, output)
         }
       }
     })

src/backend/utils.ts

@@ -971,7 +971,9 @@ export async function checkWineBeforeLaunch(
         `Wine version ${gameSettings.wineVersion.name} is not valid, trying another one.`,
         LogPrefix.Backend
       )
+    }
 
+    if (gameSettings.verboseLogs) {
       appendGamePlayLog(
         gameInfo,
         `Wine version ${gameSettings.wineVersion.name} is not valid, trying another one.\n`
@@ -989,10 +991,12 @@ export async function checkWineBeforeLaunch(
 
       if (response === 0) {
         logInfo(`Changing wine version to ${defaultwine.name}`)
-        appendGamePlayLog(
-          gameInfo,
-          `Changing wine version to ${defaultwine.name}\n`
-        )
+        if (gameSettings.verboseLogs) {
+          appendGamePlayLog(
+            gameInfo,
+            `Changing wine version to ${defaultwine.name}\n`
+          )
+        }
         gameSettings.wineVersion = defaultwine
         GameConfig.get(gameInfo.app_name).setSetting('wineVersion', defaultwine)
         return true

src/common/types.ts

@@ -102,6 +102,7 @@ export interface AppSettings extends GameSettings {
   startInTray: boolean
   allowInstallationBrokenAnticheat: boolean
   disableUMU: boolean
+  verboseLogs: boolean
 }
 
 export type LibraryTopSectionOptions =
@@ -203,6 +204,7 @@ export interface GameSettings {
   beforeLaunchScriptPath: string
   afterLaunchScriptPath: string
   disableUMU: boolean
+  verboseLogs: boolean
 }
 
 export type Status =

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

@@ -0,0 +1,30 @@
+import React, { useContext } from 'react'
+import { useTranslation } from 'react-i18next'
+import { ToggleSwitch } from 'frontend/components/UI'
+import useSetting from 'frontend/hooks/useSetting'
+import SettingsContext from '../SettingsContext'
+
+const VerboseLogs = () => {
+  const { t } = useTranslation()
+
+  const { isDefault } = useContext(SettingsContext)
+
+  const [verboseLogs, setVerboseLogs] = useSetting('verboseLogs', false)
+
+  if (isDefault) {
+    return <></>
+  }
+
+  return (
+    <div className="toggleRow">
+      <ToggleSwitch
+        htmlId="verboseLogs"
+        value={verboseLogs}
+        handleChange={() => setVerboseLogs(!verboseLogs)}
+        title={t('setting.verboseLogs.description', 'Enable verbose logs')}
+      />
+    </div>
+  )
+}
+
+export default VerboseLogs

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

@@ -47,6 +47,7 @@ import FooterInfo from '../FooterInfo'
 import { Tabs, Tab } from '@mui/material'
 import { GameInfo } from 'common/types'
 import DisableUMU from '../../components/DisableUMU'
+import VerboseLogs from '../../components/VerboseLogs'
 
 const windowsPlatforms = ['Win32', 'Windows', 'windows']
 function getStartingTab(platform: string, gameInfo?: GameInfo | null): string {
@@ -215,6 +216,7 @@ export default function GamesSettings() {
             <OfflineMode />
           </>
         )}
+        <VerboseLogs />
         <DisableUMU />
         <AlternativeExe />
         <LauncherArgs />