feat: add Enable Steam Integration setting and update config handling

Author: flavioislima

src/backend/config.ts

@@ -323,7 +323,8 @@ class GlobalConfigV0 extends GlobalConfig {
       ldUser: {
         kind: 'user',
         key: uuid()
-      }
+      },
+      enableSteamIntegration: false
     } as AppSettings
   }
 

src/backend/main.ts

@@ -891,16 +891,18 @@ ipcMain.on('clearCache', (event, showDialog, fromVersionChange = false) => {
   clearCache(undefined, fromVersionChange)
   sendFrontendMessage('refreshLibrary')
 
-  showDialogBoxModalAuto({
-    event,
-    title: i18next.t('box.cache-cleared.title', 'Cache Cleared'),
-    message: i18next.t(
-      'box.cache-cleared.message',
-      'HyperPlay Cache Was Cleared!'
-    ),
-    type: 'MESSAGE',
-    buttons: [{ text: i18next.t('box.ok', 'Ok') }]
-  })
+  if (showDialog) {
+    showDialogBoxModalAuto({
+      event,
+      title: i18next.t('box.cache-cleared.title', 'Cache Cleared'),
+      message: i18next.t(
+        'box.cache-cleared.message',
+        'HyperPlay Cache Was Cleared!'
+      ),
+      type: 'MESSAGE',
+      buttons: [{ text: i18next.t('box.ok', 'Ok') }]
+    })
+  }
 })
 
 ipcMain.on('resetApp', async () => {

src/backend/storeManagers/steam/library.ts

@@ -20,13 +20,20 @@ import { loadUsers } from './user'
 import { GameInfo, InstallPlatform } from 'common/types'
 import { getGamesdbData } from '../gog/library'
 import { apiInfoCache } from '../gog/electronStores'
+import { GlobalConfig } from 'backend/config'
 
 const library = new Map<string, GameInfo>()
 const installed = new Map<string, SteamInstallInfo>()
 
 export async function getOwnedGames(
   userId: string
 ): Promise<OwnedGame[] | undefined> {
+  if (!GlobalConfig.get().getSettings().enableSteamIntegration) {
+    logDebug('Steam integration is disabled in settings', {
+      prefix: LogPrefix.Steam
+    })
+    return []
+  }
   if (isMac) {
     logWarning('getOwnedGames is not supported on macOS', {
       prefix: LogPrefix.Steam
@@ -54,6 +61,12 @@ const ignoredAppIds = [
 ]
 
 export async function getInstalledGames() {
+  if (!GlobalConfig.get().getSettings().enableSteamIntegration) {
+    logDebug('Steam integration is disabled in settings', {
+      prefix: LogPrefix.Steam
+    })
+    return
+  }
   const steamLibraries = await getSteamLibraries()
   const steamAppsDirs = steamLibraries.map((lib) => path.join(lib, 'steamapps'))
 
@@ -94,6 +107,12 @@ export async function getInstalledGames() {
 }
 
 export async function refresh(): Promise<null> {
+  if (!GlobalConfig.get().getSettings().enableSteamIntegration) {
+    logDebug('Steam integration is disabled in settings', {
+      prefix: LogPrefix.Steam
+    })
+    return null
+  }
   const steamUsers = await loadUsers()
 
   const enabledSteamUsers = steamUsers.reduce((acc, val) => {

src/common/types.ts

@@ -114,6 +114,7 @@ export interface AppSettings extends GameSettings {
   userInfo: UserInfo
   steamId: string
   ldUser: LDUser
+  enableSteamIntegration: boolean
 }
 
 export type LibraryTopSectionOptions =

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

@@ -0,0 +1,35 @@
+import React from 'react'
+import { useTranslation } from 'react-i18next'
+import ToggleSwitch from 'frontend/components/UI/ToggleSwitch'
+import useSetting from 'frontend/hooks/useSetting'
+import libraryState from 'frontend/state/libraryState'
+
+export default function EnableSteamIntegration() {
+  const { t } = useTranslation()
+  const [enabled, setEnabled] = useSetting('enableSteamIntegration', false)
+
+  const handleChange = () => {
+    const newValue = !enabled
+    setEnabled(newValue)
+    if (newValue) {
+      window.api.refreshLibrary('steam')
+    } else {
+      if (libraryState.category === 'steam') {
+        libraryState.category = 'all'
+      }
+      window.api.clearCache(false)
+    }
+  }
+
+  return (
+    <ToggleSwitch
+      htmlId="enable_steam_integration"
+      value={enabled}
+      handleChange={handleChange}
+      title={t(
+        'setting.enable-steam-integration',
+        'Enable Steam Integration (experimental)'
+      )}
+    />
+  )
+}

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

@@ -41,3 +41,4 @@ export { default as WinePrefixesBasePath } from './WinePrefixesBasePath'
 export { default as WineVersionSelector } from './WineVersionSelector'
 export { default as WrappersTable } from './WrappersTable'
 export { default as HyperPlayAnalytics } from './HyperPlayAnalytics'
+export { default as EnableSteamIntegration } from './EnableSteamIntegration'

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

@@ -14,7 +14,8 @@ import {
   Shortcuts,
   TraySettings,
   UseDarkTrayIcon,
-  WinePrefixesBasePath
+  WinePrefixesBasePath,
+  EnableSteamIntegration
 } from '../../components'
 import AutoLaunchHyperPlay from '../../components/AutoLaunchHyperPlay'
 import styles from './index.module.scss'
@@ -32,6 +33,7 @@ export default function GeneralSettings() {
         <LanguageSelector />
         <DefaultInstallPath />
         <WinePrefixesBasePath />
+        <EnableSteamIntegration />
         <DefaultSteamPath />
         <EgsSettings />
         <AutoLaunchHyperPlay />
@@ -40,7 +42,7 @@ export default function GeneralSettings() {
         <MinimizeOnGameLaunch />
         <UseDarkTrayIcon />
         <Shortcuts />
-        {/* 
+        {/*
       disabled until we fix the controller navigation in hyperplay
       <DisableController /> */}
         <LibraryTopSection />