[Linux] Flatpak preparations (#515)

* WIP: added flatpak config

* feat: added new flatpak config

* chore: updated scripts

* chore: process update

* feat: updated scripts, packages and build file

* update yml

* chore: update config folders

* chore: updated yaml and scripts

* fix: custom wine search

* fix: config path

* feat: updated build file and scripts

* chore: remove unused files

* fix: config path

* feat: updated build file

* fix: native games should work now

* fix: variables and local yml

* feat: add gamemode to build file and fix flatpak home

* fix: flatpak id

* fix: steam compat folder and app name

* fix: uncessary variable

* chore: prettierignore

* Delete .nvmrc

* chore: update lint workflow

* fix: lint

Author: flavioislima

.github/workflows/lint.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v2
         with:
-          node-version: '14'
+          node-version: '16'
       - name: Install modules.
         run: yarn
       - name: Lint code.

.gitignore

@@ -29,4 +29,4 @@ public/**/*.js
 downloads*.json
 
 flatpak/build
-flatpak/.flatpak-builder
+.flatpak-builder

.prettierignore

@@ -4,5 +4,4 @@ build
 coverage
 public/index.html
 public/locales/
-flatpak/**/*
-flatpak/.flatpak-builder/
+flatpak

electron/constants.ts

@@ -8,7 +8,9 @@ import {
   logInfo,
   LogPrefix
 } from './logger/logger'
-import { env, execPath } from 'process'
+import { env } from 'process'
+import { app } from 'electron'
+import { existsSync } from 'graceful-fs'
 
 const configStore = new Store({
   cwd: 'store'
@@ -51,23 +53,20 @@ function getGOGdlBin() {
 const isMac = platform() === 'darwin'
 const isWindows = platform() === 'win32'
 const isLinux = platform() == 'linux'
-const isFlatpak = execPath === '/app/main/heroic'
+const isFlatpak = Boolean(env.FLATPAK_ID)
 const currentGameConfigVersion: GameConfigVersion = 'v0'
 const currentGlobalConfigVersion: GlobalConfigVersion = 'v0'
 const flatPakHome = env.XDG_DATA_HOME?.replace('/data', '') || homedir()
 const home = isFlatpak ? flatPakHome : homedir()
-const legendaryConfigPath = isFlatpak
-  ? `${home}/config/legendary`
-  : `${home}/.config/legendary`
-const heroicFolder = isFlatpak
-  ? `${home}/config/heroic/`
-  : `${home}/.config/heroic/`
+const configFolder = app.getPath('appData')
+const legendaryConfigPath = `${configFolder}/legendary`
+const heroicFolder = `${configFolder}/heroic`
 const { currentLogFile: currentLogFile, lastLogFile: lastLogFile } =
   createNewLogFileAndClearOldOnces()
-const heroicConfigPath = `${heroicFolder}config.json`
-const heroicGamesConfigPath = `${heroicFolder}GamesConfig/`
-const heroicToolsPath = `${heroicFolder}tools`
-const heroicIconFolder = `${heroicFolder}icons`
+const heroicConfigPath = `${heroicFolder}/config.json`
+const heroicGamesConfigPath = `${heroicFolder}/GamesConfig/`
+const heroicToolsPath = `${heroicFolder}/tools`
+const heroicIconFolder = `${heroicFolder}/icons`
 const userInfo = `${legendaryConfigPath}/user.json`
 const heroicInstallPath = isWindows
   ? `${home}\\Games\\Heroic`
@@ -79,6 +78,7 @@ const iconDark = fixAsarPath(join(__dirname, '/icon-dark.png'))
 const iconLight = fixAsarPath(join(__dirname, '/icon-light.png'))
 const installed = `${legendaryConfigPath}/installed.json`
 const libraryPath = `${legendaryConfigPath}/metadata/`
+const steamCompatFolder: string = getSteamCompatFolder()
 const fallBackImage = 'fallback'
 const epicLoginUrl =
   'https://www.epicgames.com/id/login?redirectUrl=https%3A%2F%2Fwww.epicgames.com%2Fid%2Fapi%2Fredirect'
@@ -128,6 +128,13 @@ function fixAsarPath(origin: string): string {
   return origin
 }
 
+function getSteamCompatFolder() {
+  if (existsSync(`${home}/.var/app/com.valvesoftware.Steam/.steam/steam`)) {
+    return `${home}/.var/app/com.valvesoftware.Steam/.steam/steam`
+  }
+  return `${home}/.steam/steam`
+}
+
 const MAX_BUFFER = 25 * 1024 * 1024 // 25MB should be safe enough for big installations even on really slow internet
 
 const execOptions = {
@@ -157,6 +164,7 @@ export {
   iconDark,
   iconLight,
   installed,
+  isFlatpak,
   isMac,
   isWindows,
   isLinux,
@@ -172,5 +180,6 @@ export {
   fallBackImage,
   userInfo,
   weblateUrl,
-  wikiLink
+  wikiLink,
+  steamCompatFolder
 }

electron/gog/setup.ts

@@ -13,7 +13,7 @@ import { GameInfo } from '../types'
 import { execAsync } from '../utils'
 import { GameConfig } from '../game_config'
 import { logError, logInfo, LogPrefix, logWarning } from '../logger/logger'
-import { home, isWindows } from '../constants'
+import { home, isWindows, steamCompatFolder } from '../constants'
 import ini from 'ini'
 /**
  * Handles setup instructions like create folders, move files, run exe, create registry entry etc...
@@ -42,7 +42,7 @@ async function setup(appName: string): Promise<void> {
     isCrossover && crossoverBottle ? `CX_BOTTLE=${crossoverBottle}` : ''
   const isProton = gameSettings.wineVersion.type === 'proton'
   const prefix = isProton
-    ? `STEAM_COMPAT_CLIENT_INSTALL_PATH=${home}/.steam/steam STEAM_COMPAT_DATA_PATH='${gameSettings.winePrefix
+    ? `STEAM_COMPAT_CLIENT_INSTALL_PATH=${steamCompatFolder} STEAM_COMPAT_DATA_PATH='${gameSettings.winePrefix
         .replaceAll("'", '')
         .replace('~', home)}'`
     : `WINEPREFIX="${gameSettings.winePrefix

electron/launcher.ts

@@ -11,7 +11,8 @@ import {
   home,
   execOptions,
   legendaryBin,
-  gogdlBin
+  gogdlBin,
+  steamCompatFolder
 } from './constants'
 import { execAsync, isEpicServiceOffline, isOnline } from './utils'
 import { logError, logInfo, LogPrefix, logWarning } from './logger/logger'
@@ -254,7 +255,7 @@ async function launch(
       ? 'DRI_PRIME=1 __NV_PRIME_RENDER_OFFLOAD=1 __GLX_VENDOR_LIBRARY_NAME=nvidia'
       : '',
     proton: isProton
-      ? `STEAM_COMPAT_CLIENT_INSTALL_PATH=${home}/.steam/steam STEAM_COMPAT_DATA_PATH='${winePrefix
+      ? `STEAM_COMPAT_CLIENT_INSTALL_PATH=${steamCompatFolder} STEAM_COMPAT_DATA_PATH='${winePrefix
           .replaceAll("'", '')
           .replace('~', home)}'`
       : ''

flatpak/com.heroicgameslauncher.yml

@@ -0,0 +1,145 @@
+id: com.heroicgameslauncher.hgl
+sdk: org.freedesktop.Sdk
+runtime: org.freedesktop.Platform
+runtime-version: '21.08'
+base: org.electronjs.Electron2.BaseApp
+base-version: '21.08'
+command: heroic-run
+separate-locales: false
+
+sdk-extensions:
+  - org.freedesktop.Sdk.Compat.i386
+  - org.freedesktop.Sdk.Extension.toolchain-i386
+
+finish-args:
+  - --share=ipc
+  - --share=network
+  - --socket=x11
+  - --socket=wayland
+  - --socket=pulseaudio
+  - --allow=multiarch
+  - --allow=devel
+  - --device=all
+  - --talk-name=org.freedesktop.Notifications
+  - --persist=.wine
+  - --filesystem=home
+  - --filesystem=xdg-data/Steam:ro
+  - --filesystem=~/.var/app/com.valvesoftware.Steam:ro
+  - --require-version=1.1.2
+  - --env=XDG_CONFIG_DIRS=/etc/xdg:/usr/lib/x86_64-linux-gnu/GL:/usr/lib/i386-linux-gnu/GL
+  - --env=GST_PLUGIN_SYSTEM_PATH=/app/lib/gstreamer-1.0:/app/lib32/gstreamer-1.0:/usr/lib/extensions/gstreamer-1.0:/usr/lib/x86_64-linux-gnu/gstreamer-1.0:/usr/lib/i386-linux-gnu/gstreamer-1.0
+
+add-extensions:
+  org.freedesktop.Platform.Compat.i386:
+    directory: lib/i386-linux-gnu
+    version: '21.08'
+
+  org.freedesktop.Platform.Compat.i386.Debug:
+    directory: lib/debug/lib/i386-linux-gnu
+    version: '21.08'
+    no-autodownload: true
+
+  org.freedesktop.Platform.GL32:
+    directory: lib/i386-linux-gnu/GL
+    version: '1.4'
+    versions: 21.08;1.4
+    subdirectories: true
+    no-autodownload: true
+    autodelete: false
+    add-ld-path: lib
+    merge-dirs: vulkan/icd.d;glvnd/egl_vendor.d;OpenCL/vendors;lib/dri;lib/d3d;vulkan/explicit_layer.d;vulkan/implicit_layer.d
+    download-if: active-gl-driver
+    enable-if: active-gl-driver
+
+modules:
+
+  # --- Tools ---
+  - name: unappimage
+    buildsystem: simple
+    build-commands:
+      - make -C squashfs-tools -j ${FLATPAK_BUILDER_N_JOBS} install INSTALL_DIR=/app/bin
+    sources:
+      - type: git
+        url: https://github.com/refi64/unappimage
+        commit: d7f86f2a0d7ec3a69211125207d5f127386b849a
+
+  - name: vulkan-tools
+    buildsystem: cmake-ninja
+    config-opts:
+      - -DGLSLANG_INSTALL_DIR=/app
+      - -DVULKAN_HEADERS_INSTALL_DIR=/app
+      - -DCMAKE_BUILD_TYPE=Release
+    sources:
+      - type: archive
+        url: https://github.com/KhronosGroup/Vulkan-Tools/archive/refs/tags/v1.2.186.tar.gz
+        sha256: 8ba0e21e8de0b70d31985d251d11150efee71266875262798784e9d1ec9b717b
+
+  - name: gamemode
+    buildsystem: meson
+    config-opts: &gamemode_opts
+      - -Dwith-systemd=false
+      - -Dwith-daemon=false
+      - -Dwith-examples=false
+      - -Dwith-util=false
+      - -Dwith-sd-bus-provider=no-daemon
+    sources: &gamemode_sources
+      - type: archive
+        url: https://github.com/FeralInteractive/gamemode/releases/download/1.6.1/gamemode-1.6.1.tar.xz
+        sha256: 10c2a3f142eae472f5a09e42616e38c666c05b25ca3e61e562a543bb3fda66c5
+
+  - name: gamemode-32bit
+    build-options:
+      arch:
+        x86_64: &compat_i386_opts
+    buildsystem: meson
+    config-opts: *gamemode_opts
+    sources: *gamemode_sources
+
+  - name: gamemoderun
+    buildsystem: simple
+    build-commands:
+      - install -Dm755 data/gamemoderun -t /app/bin
+    sources: *gamemode_sources
+
+  # --- Heroic ---
+  - name: heroic
+    buildsystem: simple
+    build-commands:
+      - unappimage Heroic-2.2.1.AppImage
+      - rm Heroic-2.2.1.AppImage
+      - mv squashfs-root /app/bin/heroic
+      - install -D heroic-run -t /app/bin
+    sources:
+      - type: script
+        dest-filename: heroic-run
+        commands:
+          - zypak-wrapper /app/bin/heroic/heroic "$@"
+
+      - type: file
+        filename: Heroic-2.2.1.AppImage
+        url: https://github.com/Heroic-Games-Launcher/HeroicGamesLauncher/releases/download/v2.2.1/Heroic-2.2.1.AppImage
+        sha256: cf3c5fdde3357d459356dcf3001730966a6d36e09541a7efa2d9db3a20b3bb47
+
+  - name: platform-bootstrap
+    buildsystem: simple
+    build-commands:
+      - |
+        set -e
+        mkdir -p /app/bin
+        mkdir -p /app/lib/i386-linux-gnu
+        mkdir -p /app/lib/debug/lib/i386-linux-gnu
+        mkdir -p /app/lib/i386-linux-gnu/GL
+        mkdir -p /app/lib/i386-linux-gnu/dri/intel-vaapi-driver
+        cp /usr/bin/addr2line /app/bin/
+        cp /usr/lib/x86_64-linux-gnu/libbfd-*.so /app/lib/
+        install -Dm644 -t /app/etc ld.so.conf
+        mkdir -p /app/lib{,32}/ffmpeg
+        mkdir -p /app/utils /app/share/vulkan
+        ln -srv /app/{utils/,}share/vulkan/explicit_layer.d
+        ln -srv /app/{utils/,}share/vulkan/implicit_layer.d
+        mkdir -p /app/links/lib
+        ln -srv /app/lib /app/links/lib/x86_64-linux-gnu
+        ln -srv /app/lib32 /app/links/lib/i386-linux-gnu
+    sources:
+      - type: file
+        path: ld.so.conf

flatpak/ld.so.conf

@@ -0,0 +1,5 @@
+# We just make any GL32 extension have higher priority
+include /run/flatpak/ld.so.conf.d/app-*-org.freedesktop.Platform.GL32.*.conf
+/app/lib32
+/app/lib/i386-linux-gnu
+/lib64