[Experimental] Automatic installation of known winetricks fixes (#3335)

* Initial basic implementation of automatic winetricks fixes

* Fix i18next

* AutoWinetricks: ignore on windows, experimental feature flag, create fixes folder

* Use repo from heroic org

* Catch error so launch doesn't fail if wenetricks installs fails

* Hide winetricks experimental flag on windows

* Update i18next

* Remove unnecessary import

public/locales/en/gamepage.json

@@ -161,7 +161,8 @@
         "prerequisites": "Installing Prerequisites",
         "saves": {
             "syncing": "Syncing Saves"
-        }
+        },
+        "winetricks": "Installing Winetricks Packages"
     },
     "launch": {
         "options": "Launch Options..."
@@ -229,7 +230,8 @@
         "this-game-uses-third-party": "This game uses third party launcher and it is not supported yet",
         "totalDownloaded": "Total Downloaded",
         "uninstalling": "Uninstalling",
-        "updating": "Updating Game"
+        "updating": "Updating Game",
+        "winetricks": "Applying Winetricks fixes"
     },
     "submenu": {
         "addShortcut": "Add shortcut",

public/locales/en/translation.json

@@ -591,6 +591,7 @@
         "esync": "Enable Esync",
         "exit-to-tray": "Exit to System Tray",
         "experimental_features": {
+            "automaticWinetricksFixes": "Apply known Winetricks fixes automatically",
             "enableHelp": "Help component",
             "enableNewDesign": "New design"
         },

src/backend/constants.ts

@@ -68,6 +68,7 @@ const defaultWinePrefixDir = join(userHome, 'Games', 'Heroic', 'Prefixes')
 const defaultWinePrefix = join(defaultWinePrefixDir, 'default')
 const anticheatDataPath = join(appFolder, 'areweanticheatyet.json')
 const imagesCachePath = join(appFolder, 'images-cache')
+const fixesPath = join(appFolder, 'fixes')
 
 const {
   currentLogFile,
@@ -276,5 +277,6 @@ export {
   nileConfigPath,
   nileInstalled,
   nileLibrary,
-  nileUserData
+  nileUserData,
+  fixesPath
 }

src/backend/downloadmanager/utils.ts

@@ -1,10 +1,18 @@
 import { gameManagerMap } from 'backend/storeManagers'
 import { logError, LogPrefix, logWarning } from '../logger/logger'
-import { isEpicServiceOffline, sendGameStatusUpdate } from '../utils'
-import { DMStatus, InstallParams } from 'common/types'
+import {
+  downloadFile,
+  isEpicServiceOffline,
+  sendGameStatusUpdate
+} from '../utils'
+import { DMStatus, InstallParams, Runner } from 'common/types'
 import i18next from 'i18next'
 import { notify, showDialogBoxModalAuto } from '../dialog/dialog'
 import { isOnline } from '../online_monitor'
+import { fixesPath } from 'backend/constants'
+import path from 'path'
+import { existsSync, mkdirSync } from 'graceful-fs'
+import { platform } from 'os'
 
 async function installQueueElement(params: InstallParams): Promise<{
   status: DMStatus
@@ -64,6 +72,10 @@ async function installQueueElement(params: InstallParams): Promise<{
   }
 
   try {
+    if (platform() !== 'win32') {
+      downloadFixesFor(appName, runner)
+    }
+
     const { status, error } = await gameManagerMap[runner].install(appName, {
       path: path.replaceAll("'", ''),
       installDlcs,
@@ -157,4 +169,19 @@ async function updateQueueElement(params: InstallParams): Promise<{
   }
 }
 
+const runnerToStore = {
+  legendary: 'epic',
+  gog: 'gog',
+  nile: 'amazon'
+}
+
+async function downloadFixesFor(appName: string, runner: Runner) {
+  const url = `https://raw.githubusercontent.com/Heroic-Games-Launcher/known-fixes/main/${appName}-${runnerToStore[runner]}.json`
+  const dest = path.join(fixesPath, `${appName}-${runnerToStore[runner]}.json`)
+  if (!existsSync(fixesPath)) {
+    mkdirSync(fixesPath, { recursive: true })
+  }
+  downloadFile({ url, dest })
+}
+
 export { installQueueElement, updateQueueElement }

src/backend/launcher.ts

@@ -26,6 +26,7 @@ import { join, normalize } from 'path'
 
 import {
   defaultWinePrefix,
+  fixesPath,
   flatPakHome,
   isLinux,
   isMac,
@@ -40,7 +41,8 @@ import {
   quoteIfNecessary,
   errorHandler,
   removeQuoteIfNecessary,
-  memoryLog
+  memoryLog,
+  sendGameStatusUpdate
 } from './utils'
 import {
   logDebug,
@@ -52,7 +54,7 @@ import {
 } from './logger/logger'
 import { GlobalConfig } from './config'
 import { GameConfig } from './game_config'
-import { DXVK } from './tools'
+import { DXVK, Winetricks } from './tools'
 import setup from './storeManagers/gog/setup'
 import nileSetup from './storeManagers/nile/setup'
 import { spawn, spawnSync } from 'child_process'
@@ -343,6 +345,12 @@ async function prepareWineLaunch(
     if (runner === 'legendary') {
       await legendarySetup(appName)
     }
+    if (
+      GlobalConfig.get().getSettings().experimentalFeatures
+        .automaticWinetricksFixes
+    ) {
+      await installFixes(appName, runner)
+    }
   }
 
   // If DXVK/VKD3D installation is enabled, install it
@@ -381,6 +389,38 @@ async function prepareWineLaunch(
   return { success: true, envVars: envVars }
 }
 
+const runnerToStore = {
+  legendary: 'epic',
+  gog: 'gog',
+  nile: 'amazon'
+}
+
+async function installFixes(appName: string, runner: Runner) {
+  const fixPath = join(fixesPath, `${appName}-${runnerToStore[runner]}.json`)
+
+  if (!existsSync(fixPath)) return
+
+  try {
+    const fixesContent = JSON.parse(readFileSync(fixPath).toString())
+
+    sendGameStatusUpdate({
+      appName,
+      runner: runner,
+      status: 'winetricks'
+    })
+
+    for (const winetricksPackage of fixesContent.winetricks) {
+      await Winetricks.install(runner, appName, winetricksPackage)
+    }
+  } catch (error) {
+    // if we fail to download the json file, it can be malformed causing
+    // JSON.parse to throw an exception
+    logWarning(
+      `Known winetricks fixes could not be applied, ignoring.\n${error}`
+    )
+  }
+}
+
 /**
  * Maps general settings to environment variables
  * @param gameSettings The GameSettings to get the environment variables for

src/backend/main.ts

@@ -1079,6 +1079,12 @@ ipcMain.handle(
       }
     }
 
+    sendGameStatusUpdate({
+      appName,
+      runner,
+      status: 'launching'
+    })
+
     const command = gameManagerMap[runner].launch(appName, launchArguments)
 
     const launchResult = await command.catch((exception) => {

src/backend/storeManagers/gog/games.ts

@@ -523,6 +523,12 @@ export async function launch(
 
   sendGameStatusUpdate({ appName, runner: 'gog', status: 'playing' })
 
+  sendGameStatusUpdate({
+    appName,
+    runner: 'gog',
+    status: 'playing'
+  })
+
   const { error, abort } = await runGogdlCommand(commandParts, {
     abortId: appName,
     env: commandEnv,

src/backend/storeManagers/legendary/games.ts

@@ -859,6 +859,12 @@ export async function launch(
 
   sendGameStatusUpdate({ appName, runner: 'legendary', status: 'playing' })
 
+  sendGameStatusUpdate({
+    appName,
+    runner: 'legendary',
+    status: 'playing'
+  })
+
   const { error } = await runLegendaryCommand(command, {
     abortId: appName,
     env: commandEnv,

src/backend/storeManagers/nile/games.ts

@@ -404,6 +404,12 @@ export async function launch(
 
   sendGameStatusUpdate({ appName, runner: 'nile', status: 'playing' })
 
+  sendGameStatusUpdate({
+    appName,
+    runner: 'nile',
+    status: 'playing'
+  })
+
   const { error } = await runNileCommand(commandParts, {
     abortId: appName,
     env: commandEnv,

src/common/types.ts

@@ -46,6 +46,7 @@ export type Release = {
 export type ExperimentalFeatures = {
   enableNewDesign: boolean
   enableHelp: boolean
+  automaticWinetricksFixes: boolean
 }
 
 export interface AppSettings extends GameSettings {
@@ -193,6 +194,7 @@ export type Status =
   | 'installed'
   | 'prerequisites'
   | 'extracting'
+  | 'winetricks'
 
 export interface GameStatus {
   appName: string

src/frontend/hooks/constants.ts

@@ -35,6 +35,7 @@ export function getStatusLabel({
     }`,
     notInstalled: t('gamepage:status.notinstalled'),
     launching: t('gamepage:status.launching', 'Launching'),
+    winetricks: t('gamepage:status.winetricks', 'Applying Winetricks fixes'),
     prerequisites: t(
       'gamepage:status.prerequisites',
       'Installing Prerequisites'

src/frontend/screens/Game/GameContext.tsx

@@ -11,6 +11,7 @@ const initialContext: GameContextType = {
   gameInstallInfo: null,
   is: {
     installing: false,
+    installingWinetricksPackages: false,
     installingPrerequisites: false,
     launching: false,
     linux: false,

src/frontend/screens/Game/GamePage/components/MainButton.tsx

@@ -42,6 +42,9 @@ const MainButton = ({ gameInfo, handlePlay, handleInstall }: Props) => {
     if (is.installingPrerequisites) {
       return t('label.prerequisites', 'Installing Prerequisites')
     }
+    if (is.installingWinetricksPackages) {
+      return t('label.winetricks', 'Installing Winetricks Packages')
+    }
     if (is.launching) {
       return t('label.launching', 'Launching')
     }
@@ -136,6 +139,7 @@ const MainButton = ({ gameInfo, handlePlay, handleInstall }: Props) => {
             is.uninstalling ||
             is.syncing ||
             is.launching ||
+            is.installingWinetricksPackages ||
             is.installingPrerequisites
           }
           autoFocus={true}

src/frontend/screens/Game/GamePage/index.tsx

@@ -138,6 +138,7 @@ export default React.memo(function GamePage(): JSX.Element | null {
   const isUninstalling = status === 'uninstalling'
   const isSyncing = status === 'syncing-saves'
   const isLaunching = status === 'launching'
+  const isInstallingWinetricksPackages = status === 'winetricks'
   const isInstallingPrerequisites = status === 'prerequisites'
   const notAvailable = !gameAvailable && gameInfo.is_installed
   const notInstallable =
@@ -292,6 +293,7 @@ export default React.memo(function GamePage(): JSX.Element | null {
       gameExtraInfo: extraInfo,
       is: {
         installing: isInstalling,
+        installingWinetricksPackages: isInstallingWinetricksPackages,
         installingPrerequisites: isInstallingPrerequisites,
         launching: isLaunching,
         linux: isLinux,

src/frontend/screens/Library/components/GameCard/constants.ts

@@ -30,6 +30,7 @@ export function getCardStatus(
   const notSupportedGame = status === 'notSupportedGame'
   const syncingSaves = status === 'syncing-saves'
   const isLaunching = status === 'launching'
+  const isInstallingWinetricksPackages = status === 'winetricks'
   const isInstallingPrerequisites = status === 'prerequisites'
 
   const haveStatus =
@@ -44,6 +45,7 @@ export function getCardStatus(
     isPlaying ||
     syncingSaves ||
     isLaunching ||
+    isInstallingWinetricksPackages ||
     isInstallingPrerequisites ||
     (isInstalled && layout !== 'grid')
   return {
@@ -55,6 +57,7 @@ export function getCardStatus(
     notAvailable,
     isUpdating,
     isLaunching,
+    isInstallingWinetricksPackages,
     isInstallingPrerequisites,
     haveStatus
   }

src/frontend/screens/Library/components/GameCard/index.tsx

@@ -227,7 +227,9 @@ const GameCard = ({
     if (isInstalled) {
       const disabled =
         isLaunching ||
-        ['syncing-saves', 'launching', 'prerequisites'].includes(status!)
+        ['syncing-saves', 'launching', 'prerequisites', 'winetricks'].includes(
+          status!
+        )
       return (
         <SvgButton
           className={!notAvailable ? 'playIcon' : 'notAvailableIcon'}

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

@@ -4,13 +4,23 @@ import useSetting from 'frontend/hooks/useSetting'
 import { ToggleSwitch } from 'frontend/components/UI'
 import ContextProvider from 'frontend/state/ContextProvider'
 
-const FEATURES = ['enableNewDesign', 'enableHelp']
-
 const ExperimentalFeatures = () => {
+  const { platform } = useContext(ContextProvider)
+
+  const FEATURES = ['enableNewDesign', 'enableHelp']
+
+  if (platform !== 'win32') {
+    FEATURES.push('automaticWinetricksFixes')
+  }
+
   const { t } = useTranslation()
   const [experimentalFeatures, setExperimentalFeatures] = useSetting(
     'experimentalFeatures',
-    { enableNewDesign: false, enableHelp: false }
+    {
+      enableNewDesign: false,
+      enableHelp: false,
+      automaticWinetricksFixes: false
+    }
   )
   const { handleExperimentalFeatures } = useContext(ContextProvider)
 
@@ -27,6 +37,7 @@ const ExperimentalFeatures = () => {
     Translations:
     t('setting.experimental_features.enableNewDesign', 'New design')
     t('setting.experimental_features.enableHelp', 'Help component')
+    t('setting.experimental_features.automaticWinetricksFixes', 'Apply known Winetricks fixes automatically')
   */
 
   return (

src/frontend/state/ContextProvider.tsx

@@ -91,7 +91,11 @@ const initialContext: ContextType = {
     addHelpItem: () => null,
     removeHelpItem: () => null
   },
-  experimentalFeatures: { enableNewDesign: false, enableHelp: false },
+  experimentalFeatures: {
+    enableNewDesign: false,
+    enableHelp: false,
+    automaticWinetricksFixes: false
+  },
   handleExperimentalFeatures: () => null
 }
 

src/frontend/state/GlobalState.tsx

@@ -213,7 +213,8 @@ class GlobalState extends PureComponent<Props> {
     helpItems: {},
     experimentalFeatures: globalSettings?.experimentalFeatures || {
       enableNewDesign: false,
-      enableHelp: false
+      enableHelp: false,
+      automaticWinetricksFixes: false
     }
   }
 
@@ -697,6 +698,7 @@ class GlobalState extends PureComponent<Props> {
         'playing',
         'extracting',
         'launching',
+        'winetricks',
         'prerequisites',
         'queued'
       ].includes(status)