[GOG]: Support overlay

electron-builder.yml

@@ -80,6 +80,8 @@ linux:
     - build/bin/${arch}/linux/*
     - build/bin/x64/win32/GalaxyCommunication.exe
     - build/bin/x64/win32/EpicGamesLauncher.exe
+    - build/bin/galaxy.exe
+    - build/bin/libgalaxyunixlib.dll.so
 
 rpm:
   fpm: ['--rpm-rpmbuild-define', '_build_id_links none']

meta/downloadHelperBinaries.ts

@@ -18,7 +18,7 @@ const RELEASE_TAGS = {
   legendary: '0.20.39',
   gogdl: 'v1.2.0',
   nile: 'v1.1.2',
-  comet: 'v0.2.0',
+  comet: 'v0.3.2',
   'epic-integration': 'v0.4'
 } as const satisfies Record<DownloadedBinary, string>
 

src/backend/constants/paths.ts

@@ -48,6 +48,14 @@ export const galaxyCommunicationExePath = fixAsarPath(
   join(publicDir, 'bin', 'x64', 'win32', 'GalaxyCommunication.exe')
 )
 
+export const galaxyOverlayShimExePath = fixAsarPath(
+  join(publicDir, 'bin', 'galaxy.exe')
+)
+
+export const galaxyOverlayShimUnixlibExePath = fixAsarPath(
+  join(publicDir, 'bin', 'libgalaxyunixlib.dll.so')
+)
+
 export const webviewPreloadPath = fixAsarPath(
   join('file://', publicDir, 'webviewPreload.js')
 )

src/backend/launcher.ts

@@ -81,6 +81,8 @@ import {
   fixesPath,
   flatpakHome,
   galaxyCommunicationExePath,
+  galaxyOverlayShimExePath,
+  galaxyOverlayShimUnixlibExePath,
   runtimePath,
   userHome
 } from './constants/paths'
@@ -790,6 +792,7 @@ async function prepareWineLaunch(
   failureReason?: string
   envVars?: Record<string, string>
 }> {
+  const extendedEnv: Record<string, string> = {}
   const gameSettings =
     GameConfig.get(appName).config ||
     (await GameConfig.get(appName).getSettings())
@@ -909,34 +912,51 @@ async function prepareWineLaunch(
 
   try {
     if (runner === 'gog' && experimentalFeatures?.cometSupport !== false) {
-      const galaxyCommWinePath =
-        'C:\\ProgramData\\GOG.com\\Galaxy\\redists\\GalaxyCommunication.exe'
+      const galaxyCommPath = 'C:\\ProgramData\\GOG.com\\Galaxy'
       const communicationDest = await getWinePath({
-        path: galaxyCommWinePath,
+        path: galaxyCommPath,
         gameSettings,
         variant: 'unix'
       })
 
-      if (!existsSync(communicationDest)) {
-        mkdirSync(dirname(communicationDest), { recursive: true })
-        await copyFile(galaxyCommunicationExePath, communicationDest)
+      const communicationExe = join(
+        communicationDest,
+        'redists/GalaxyCommunication.exe'
+      )
+      const galaxyOverlay = join(communicationDest, 'overlay-heroic')
+
+      if (!existsSync(communicationExe)) {
+        mkdirSync(dirname(communicationExe), { recursive: true })
+        await copyFile(galaxyCommunicationExePath, communicationExe)
         await runWineCommand({
           commandParts: [
             'sc',
             'create',
             'GalaxyCommunication',
-            `binpath=${galaxyCommWinePath}`
+            `binpath=${galaxyCommPath}`
           ],
           gameSettings,
           protonVerb: 'runinprefix'
         })
       }
+      if (!existsSync(galaxyOverlay)) {
+        mkdirSync(galaxyOverlay, { recursive: true })
+        await copyFile(
+          galaxyOverlayShimExePath,
+          join(galaxyOverlay, 'galaxy.exe')
+        )
+        await copyFile(
+          galaxyOverlayShimUnixlibExePath,
+          join(galaxyOverlay, 'libgalaxyunixlib.dll.so')
+        )
+      }
+      extendedEnv['HEROIC_GOGDL_WRAPPER_EXE'] = join(
+        galaxyCommPath,
+        'overlay-heroic/galaxy.exe'
+      )
     }
   } catch (err) {
-    logError([
-      'Failed to install GalaxyCommunication dummy into the prefix:',
-      err
-    ])
+    logError(['Failed to install galaxy components into the prefix', err])
   }
 
   // If DXVK/VKD3D installation is enabled, install it
@@ -972,7 +992,7 @@ async function prepareWineLaunch(
     gameManagerMap[runner].getGameInfo(appName)
   const envVars = setupWineEnvVars(gameSettings, installFolderName)
 
-  return { success: true, envVars: envVars }
+  return { success: true, envVars: { ...envVars, ...extendedEnv } }
 }
 
 export function readKnownFixes(appName: string, runner: Runner) {

src/backend/storeManagers/gog/games.ts

@@ -568,6 +568,10 @@ export async function launch(
       return false
     }
 
+    if (!isOnline() && wineEnvVars) {
+      delete wineEnvVars['HEROIC_GOGDL_WRAPPER_EXE']
+    }
+
     commandEnv = {
       ...commandEnv,
       ...wineEnvVars
@@ -695,12 +699,16 @@ export async function launch(
       false
   ) {
     const path = getCometBin()
-    child = spawn(join(path.dir, path.bin), [
-      '--from-heroic',
-      '--username',
-      userData.username,
-      '--quit'
-    ])
+    child = spawn(
+      join(path.dir, path.bin),
+      ['--from-heroic', '--username', userData.username, '--quit'],
+      {
+        env: {
+          ...process.env,
+          ...setupWrapperEnvVars({ appName, appRunner: 'gog' })
+        }
+      }
+    )
     child.stdout.setEncoding('utf-8')
     child.stderr.setEncoding('utf-8')
     child.stdout.on('data', (data: string) => {

src/backend/storeManagers/gog/setup.ts

@@ -203,7 +203,7 @@ async function setup(
             `/DIR=${gameDirectoryPath}`,
             `/Language=${language}`,
             `/LANG=${language}`,
-            `/ProductId=${language}`,
+            `/ProductId=${supportCommand.gameID}`,
             `/galaxyclient`,
             `/buildId=${manifestData.product.timestamp}`,
             `/versionName=${gameInfo.install.version}`,

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

@@ -0,0 +1,31 @@
+import { CachedOutlined } from '@mui/icons-material'
+import { useState } from 'react'
+import { useTranslation } from 'react-i18next'
+
+const CometComponents = () => {
+  const { t } = useTranslation()
+
+  const [isUpdating, setUpdating] = useState(false)
+
+  return (
+    <>
+      <h3>{t('setting.comet.components', 'Comet Components')}</h3>
+
+      <div className="footerFlex">
+        <button className="button is-primary" onClick={() => {}}>
+          <CachedOutlined />
+          <span>
+            {isUpdating
+              ? t(
+                  'setting.eosOverlay.checkingForUpdates',
+                  'Checking for updates...'
+                )
+              : t('setting.eosOverlay.checkForUpdates', 'Check for updates')}
+          </span>
+        </button>
+      </div>
+    </>
+  )
+}
+
+export default CometComponents

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

@@ -62,3 +62,4 @@ export { default as ResetHeroic } from './ResetHeroic'
 export { default as BeforeLaunchScriptPath } from './BeforeLaunchScriptPath'
 export { default as AfterLaunchScriptPath } from './AfterLaunchScriptPath'
 export { default as AllowInstallationBrokenAnticheat } from './AllowInstallationBrokenAnticheat'
+export { default as CometComponents } from './CometComponents'

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

@@ -21,6 +21,7 @@ import {
   AltLegendaryBin,
   AltNileBin,
   ClearCache,
+  CometComponents,
   CustomCSS,
   DisableLogs,
   DownloadNoHTTPS,
@@ -299,6 +300,11 @@ export default function AdvancedSetting() {
         <hr />
       </div>
 
+      <div className="advancedSetting">
+        <CometComponents />
+        <hr />
+      </div>
+
       <div className="advancedSetting">
         <ExperimentalFeatures />
         <hr />