Add support for installing and enabling DXVK-NVAPI

public/locales/en/translation.json

@@ -258,6 +258,7 @@
         "disable_logs": "Toggle this checkbox ON to disable most of the writes to log files (critical information is always logged). Make sure to turn OFF this setting before reporting any issue.",
         "dxvk": "DXVK is a Vulkan-based translational layer for DirectX 9, 10 and 11 games. Enabling may improve compatibility. Might cause issues especially for older DirectX games.",
         "dxvkfpslimit": "Sets a frame rate cap for DXVK games",
+        "dxvknvapi": "DXVK-NVAPI is an implementation of NVAPI built on top of DXVK and the linux native NVAPI, it allows for the usage of DLSS on Nvidia GPUs.",
         "esync": "Esync aims to reduce wineserver overhead in CPU-intensive games. Enabling may improve performance.",
         "fsync": "Fsync aims to reduce wineserver overhead in CPU-intensive games. Enabling may improve performance on supported Linux kernels.",
         "game_language": {
@@ -483,6 +484,7 @@
         "alt-legendary-bin": "Choose an Alternative Legendary Binary",
         "alt-nile-bin": "Choose an Alternative Nile Binary",
         "autodxvk": "Auto Install/Update DXVK on Prefix",
+        "autodxvknvapi": "Auto Install/Update DXVK-NVAPI on Prefix",
         "autosync": "Autosync Saves",
         "autoUpdateGames": "Automatically update games",
         "autovkd3d": "Auto Install/Update VKD3D on Prefix",

src/backend/api/wine.ts

@@ -9,6 +9,8 @@ import {
 
 export const toggleDXVK = async (args: ToolArgs) =>
   ipcRenderer.invoke('toggleDXVK', args)
+export const toggleDXVKNVAPI = async (args: ToolArgs) =>
+  ipcRenderer.invoke('toggleDXVKNVAPI', args)
 export const toggleVKD3D = (args: ToolArgs) =>
   ipcRenderer.send('toggleVKD3D', args)
 export const isFlatpak = async (): Promise<boolean> =>

src/backend/config.ts

@@ -296,6 +296,7 @@ class GlobalConfigV0 extends GlobalConfig {
       addStartMenuShortcuts: false,
       autoInstallDxvk: true,
       autoInstallVkd3d: true,
+      autoInstallDxvkNvapi: false,
       addSteamShortcuts: false,
       preferSystemLibs: false,
       checkForUpdatesOnStartup: !isFlatpak,

src/backend/launcher.ts

@@ -256,6 +256,9 @@ async function prepareWineLaunch(
     if (gameSettings.autoInstallDxvk) {
       await DXVK.installRemove(gameSettings, 'dxvk', 'backup')
     }
+    if (gameSettings.autoInstallDxvkNvapi) {
+      await DXVK.installRemove(gameSettings, 'dxvk-nvapi', 'backup')
+    }
     if (gameSettings.autoInstallVkd3d) {
       await DXVK.installRemove(gameSettings, 'vkd3d', 'backup')
     }
@@ -394,6 +397,14 @@ function setupWineEnvVars(
   if (!gameSettings.enableFsync && wineVersion.type === 'proton') {
     ret.PROTON_NO_FSYNC = '1'
   }
+  if (gameSettings.autoInstallDxvkNvapi && wineVersion.type === 'proton') {
+    ret.PROTON_ENABLE_NVAPI = '1'
+    ret.DXVK_NVAPI_ALLOW_OTHER_DRIVERS = '1'
+  }
+  if (gameSettings.autoInstallDxvkNvapi && wineVersion.type === 'wine') {
+    ret.DXVK_ENABLE_NVAPI = '1'
+    ret.DXVK_NVAPI_ALLOW_OTHER_DRIVERS = '1'
+  }
   if (gameSettings.eacRuntime) {
     ret.PROTON_EAC_RUNTIME = join(runtimePath, 'eac_runtime')
   }

src/backend/main.ts

@@ -845,6 +845,14 @@ ipcMain.handle('toggleDXVK', async (event, { appName, action }) =>
     )
 )
 
+ipcMain.handle('toggleDXVKNVAPI', async (event, { appName, action }) =>
+  GameConfig.get(appName)
+    .getSettings()
+    .then(async (gameSettings) =>
+      DXVK.installRemove(gameSettings, 'dxvk-nvapi', action)
+    )
+)
+
 ipcMain.on('toggleVKD3D', (event, { appName, action }) => {
   GameConfig.get(appName)
     .getSettings()

src/backend/tools.ts

@@ -10,7 +10,6 @@ import {
   rm
 } from 'graceful-fs'
 import { exec, spawn } from 'child_process'
-
 import { execAsync, getWineFromProton } from './utils'
 import {
   execOptions,
@@ -29,6 +28,7 @@ import { runWineCommand, validWine } from './launcher'
 import { chmod } from 'fs/promises'
 import {
   any_gpu_supports_version,
+  get_nvngx_path,
   get_vulkan_instance_version
 } from './utils/graphics/vulkan'
 import { lt as semverLt } from 'semver'
@@ -59,6 +59,12 @@ export const DXVK = {
         extractCommand: 'tar -xf',
         os: 'linux'
       },
+      {
+        name: 'dxvk-nvapi',
+        url: 'https://api.github.com/repos/jp7677/dxvk-nvapi/releases/latest',
+        extractCommand: 'tar --one-top-level -xf',
+        os: 'linux'
+      },
       {
         name: 'dxvk-macOS',
         url: 'https://api.github.com/repos/Gcenx/DXVK-macOS/releases/latest',
@@ -137,7 +143,7 @@ export const DXVK = {
 
   installRemove: async (
     gameSettings: GameSettings,
-    tool: 'dxvk' | 'vkd3d' | 'dxvk-macOS',
+    tool: 'dxvk' | 'dxvk-nvapi' | 'vkd3d' | 'dxvk-macOS',
     action: 'backup' | 'restore'
   ): Promise<boolean> => {
     if (gameSettings.wineVersion.bin.includes('toolkit')) {
@@ -173,11 +179,12 @@ export const DXVK = {
       .toString()
       .split('\n')[0]
 
-    const dlls = readdirSync(`${toolsPath}/${tool}/${globalVersion}/x64`)
     const toolPathx32 = `${toolsPath}/${tool}/${globalVersion}/${
       tool === 'vkd3d' ? 'x86' : 'x32'
     }`
+    const dlls32 = readdirSync(toolPathx32)
     const toolPathx64 = `${toolsPath}/${tool}/${globalVersion}/x64`
+    const dlls64 = readdirSync(toolPathx64)
     const currentVersionCheck = `${winePrefix}/current_${tool}`
     let currentVersion = ''
 
@@ -203,7 +210,24 @@ export const DXVK = {
       logInfo('Removing DLL overrides', LogPrefix.DXVKInstaller)
 
       // unregister the dlls on the wine prefix
-      dlls.forEach(async (dll) => {
+      dlls64.forEach(async (dll) => {
+        dll = dll.replace('.dll', '')
+        const unregisterDll = [
+          'reg',
+          'delete',
+          'HKEY_CURRENT_USER\\Software\\Wine\\DllOverrides',
+          '/v',
+          dll,
+          '/f'
+        ]
+        await runWineCommand({
+          gameSettings,
+          commandParts: unregisterDll,
+          wait: true,
+          protonVerb: 'waitforexitandrun'
+        })
+      })
+      dlls32.forEach(async (dll) => {
         dll = dll.replace('.dll', '')
         const unregisterDll = [
           'reg',
@@ -231,7 +255,7 @@ export const DXVK = {
     }
 
     // copy the new dlls to the prefix
-    dlls.forEach((dll) => {
+    dlls32.forEach((dll) => {
       if (!isMac) {
         copyFile(
           `${toolPathx32}/${dll}`,
@@ -246,7 +270,8 @@ export const DXVK = {
           }
         )
       }
-
+    })
+    dlls64.forEach((dll) => {
       copyFile(
         `${toolPathx64}/${dll}`,
         `${winePrefix}/drive_c/windows/system32/${dll}`,
@@ -262,7 +287,7 @@ export const DXVK = {
     })
 
     // register dlls on the wine prefix
-    dlls.forEach(async (dll) => {
+    dlls64.forEach(async (dll) => {
       // remove the .dll extension otherwise will fail
       dll = dll.replace('.dll', '')
       const registerDll = [
@@ -282,6 +307,74 @@ export const DXVK = {
         protonVerb: 'waitforexitandrun'
       })
     })
+    dlls32.forEach(async (dll) => {
+      // remove the .dll extension otherwise will fail
+      dll = dll.replace('.dll', '')
+      const registerDll = [
+        'reg',
+        'add',
+        'HKEY_CURRENT_USER\\Software\\Wine\\DllOverrides',
+        '/v',
+        dll,
+        '/d',
+        'native,builtin',
+        '/f'
+      ]
+      await runWineCommand({
+        gameSettings,
+        commandParts: registerDll,
+        wait: true,
+        protonVerb: 'waitforexitandrun'
+      })
+    })
+
+    //locate and copy nvngx.dll to support DLSS on Nvidia GPUs
+    if (tool === 'dxvk-nvapi' && action === 'backup') {
+      try {
+        let nvngx_path = get_nvngx_path()
+        if (nvngx_path.length !== 0) {
+          nvngx_path += '/nvidia/wine'
+          const copyDlls = ['nvngx.dll', '_nvngx.dll']
+          copyDlls.forEach((dll) => {
+            copyFile(
+              `${nvngx_path}/${dll}`,
+              `${winePrefix}/drive_c/windows/system32/${dll}`,
+              (err) => {
+                if (err) {
+                  logError(
+                    [`Error when copying ${dll}`, err],
+                    LogPrefix.DXVKInstaller
+                  )
+                }
+              }
+            )
+          })
+          const regModNvngx = [
+            'reg',
+            'add',
+            'HKEY_LOCAL_MACHINE\\SOFTWARE\\NVIDIA Corporation\\Global\\NGXCore',
+            '/v',
+            'FullPath',
+            '/d',
+            'C:\\windows\\system32',
+            '/f'
+          ]
+          await runWineCommand({
+            gameSettings,
+            commandParts: regModNvngx,
+            wait: true,
+            protonVerb: 'waitforexitandrun'
+          })
+        } else {
+          logWarning(
+            'Could not find nvngx.dll for DLSS!',
+            LogPrefix.DXVKInstaller
+          )
+        }
+      } catch (err) {
+        logError([`Error when finding nvngx.dll`, err], LogPrefix.DXVKInstaller)
+      }
+    }
 
     writeFile(currentVersionCheck, globalVersion, (err) => {
       if (err) {

src/backend/utils/graphics/vulkan/index.ts

@@ -49,6 +49,14 @@ function get_supported_vulkan_versions(): [
   }
 }
 
+function get_nvngx_path(): string {
+  const result = spawnSync(vulkanHelperBin, ['nvapi-path'], {
+    encoding: 'utf-8'
+  })
+
+  return result.stdout.trim()
+}
+
 /**
  * Helper function to detect if any GPU in the system supports a specified Vulkan version
  * @returns The name of first the adapter supporting the target version, or `false` if none do
@@ -64,4 +72,4 @@ function any_gpu_supports_version(
   return false
 }
 
-export { get_vulkan_instance_version, any_gpu_supports_version }
+export { get_vulkan_instance_version, any_gpu_supports_version, get_nvngx_path }

src/common/typedefs/ipcBridge.d.ts

@@ -252,6 +252,7 @@ interface AsyncIPCFunctions {
     runner: Runner
   }) => Promise<boolean>
   toggleDXVK: (args: ToolArgs) => Promise<boolean>
+  toggleDXVKNVAPI: (args: ToolArgs) => Promise<boolean>
   pathExists: (path: string) => Promise<boolean>
   getGOGLaunchOptions: (appName: string) => Promise<LaunchOption[]>
   getGameOverride: () => Promise<GameOverride | null>

src/common/types.ts

@@ -132,6 +132,7 @@ export interface GameInfo {
 export interface GameSettings {
   autoInstallDxvk: boolean
   autoInstallVkd3d: boolean
+  autoInstallDxvkNvapi: boolean
   autoSyncSaves: boolean
   battlEyeRuntime: boolean
   DXVKFpsCap: string //Entered as string but used as number

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

@@ -0,0 +1,69 @@
+import React, { useContext } from 'react'
+import { ToggleSwitch } from 'frontend/components/UI'
+import useSetting from 'frontend/hooks/useSetting'
+import { useTranslation } from 'react-i18next'
+import { defaultWineVersion } from '..'
+import SettingsContext from '../SettingsContext'
+import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'
+import { faCircleInfo } from '@fortawesome/free-solid-svg-icons'
+
+const AutoDXVKNVAPI = () => {
+  const { t } = useTranslation()
+  const [autoInstallDXVKNVAPI, setAutoInstallDXVKNVAPI] = useSetting(
+    'autoInstallDxvkNvapi',
+    false
+  )
+  const { appName } = useContext(SettingsContext)
+  const [wineVersion] = useSetting('wineVersion', defaultWineVersion)
+  const [installingDxvkNvapi, setInstallingDxvkNvapi] = React.useState(false)
+
+  const handleAutoInstallDxvkNvapi = async () => {
+    let res = true
+    const isProton = wineVersion.type === 'proton'
+    setInstallingDxvkNvapi(true)
+
+    if (!isProton) {
+      const action = autoInstallDXVKNVAPI ? 'restore' : 'backup'
+      res = await window.api.toggleDXVKNVAPI({
+        appName,
+        action
+      })
+    }
+
+    setInstallingDxvkNvapi(false)
+    if (res) {
+      setAutoInstallDXVKNVAPI(!autoInstallDXVKNVAPI)
+    }
+  }
+
+  return (
+    <div className="toggleRow">
+      <ToggleSwitch
+        htmlId="autodxvknvapi"
+        value={autoInstallDXVKNVAPI}
+        handleChange={handleAutoInstallDxvkNvapi}
+        title={
+          installingDxvkNvapi
+            ? t('please-wait', 'Please wait...')
+            : t(
+                'setting.autodxvknvapi',
+                'Auto Install/Update DXVK-NVAPI on Prefix'
+              )
+        }
+        fading={installingDxvkNvapi}
+        disabled={installingDxvkNvapi}
+      />
+
+      <FontAwesomeIcon
+        className="helpIcon"
+        icon={faCircleInfo}
+        title={t(
+          'help.dxvknvapi',
+          'DXVK-NVAPI is an implementation of NVAPI built on top of DXVK and the linux native NVAPI, it allows for the usage of DLSS on Nvidia GPUs.'
+        )}
+      />
+    </div>
+  )
+}
+
+export default AutoDXVKNVAPI

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

@@ -3,6 +3,7 @@ export { default as AltGOGdlBin } from './AltGOGdlBin'
 export { default as AltLegendaryBin } from './AltLegendaryBin'
 export { default as AltNileBin } from './AltNileBin'
 export { default as AutoDXVK } from './AutoDXVK'
+export { default as AutoDXVKNVAPI } from './AutoDXVKNVAPI'
 export { default as AutoUpdateGames } from './AutoUpdateGames'
 export { default as AutoVKD3D } from './AutoVKD3D'
 export { default as BattlEyeRuntime } from './BattlEyeRuntime'

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

@@ -6,6 +6,7 @@ import { useTranslation } from 'react-i18next'
 import {
   AlternativeExe,
   AutoDXVK,
+  AutoDXVKNVAPI,
   AutoVKD3D,
   BattlEyeRuntime,
   CrossoverBottle,
@@ -97,6 +98,8 @@ export default function GamesSettings({ useDetails = true }: Props) {
                 <AutoDXVK />
                 {isLinux && (
                   <>
+                    <AutoDXVKNVAPI />
+
                     <AutoVKD3D />
 
                     <EacRuntime />