Release 3.2.12 (Develop)

.github/workflows/build.yml

@@ -16,34 +16,46 @@ jobs:
           - kind: windows
             os: windows-latest
             platform: win
+          - kind: flatpak
+            os: ubuntu-latest
+            platform: flatpak
           # Macos-11 is deprecated, macos-12 would require package updates, see PR #1409
           # - kind: mac
           #   os: macos-11
           #   platform: osx
     steps:
       - uses: actions/checkout@v4
 
-      - name: Enable Corepack
-        run: |
-          npm install -g corepack@latest --force
-          corepack enable
-
-      - name: Set up Node
-        uses: actions/setup-node@v4
+      - uses: jdx/mise-action@v3
         with:
-          # The talk on the street says this might be a good version for building.
-          node-version: 20.19.0
-          cache: yarn
+          install: true
+          cache: true
+          log_level: debug
 
       - name: Install Yarn dependencies
-        run: yarn install --frozen-lockfile
+        run: yarn install --immutable
 
-      - if: matrix.platform == 'linux'
+      - if: matrix.platform == 'linux' || matrix.platform == 'flatpak'
         name: Install bsdtar # Required by electron-builder when targeting pacman.
         run: |
           sudo apt-get update -y
           sudo apt-get install -y libarchive-tools
 
+      - if: matrix.platform == 'flatpak'
+        name: Cache Flatpak runtimes
+        uses: actions/cache@v4
+        with:
+          path: ~/.local/share/flatpak
+          key: flatpak-${{ runner.os }}-25.08
+
+      - if: matrix.platform == 'flatpak'
+        name: Install Flatpak and flatpak-builder
+        run: |
+          sudo apt-get install -y flatpak flatpak-builder
+          flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
+          flatpak install --user -y flathub org.freedesktop.Platform//25.08 org.freedesktop.Sdk//25.08
+          flatpak install --user -y flathub org.electronjs.Electron2.BaseApp//25.08
+
       - name: Build project
         id: build
         uses: StarUbiquitous/command-output@v1.0.1 # Store stdout/stderr to outputs.

.github/workflows/release.yml

@@ -17,30 +17,43 @@ jobs:
           - kind: windows
             os: windows-latest
             platform: win
+          - kind: flatpak
+            os: ubuntu-latest
+            platform: flatpak
     steps:
       - uses: actions/checkout@v4
 
-      - name: Enable Corepack
-        run: |
-          npm install -g corepack@latest --force
-          corepack enable
-
-      - name: Set up Node
-        uses: actions/setup-node@v4
+      - uses: jdx/mise-action@v3
         with:
-          # The talk on the street says this might be a good version for building.
-          node-version: 20.19.0
-          cache: yarn
+          install: true
+          cache: true
+          log_level: debug
 
       - name: Install Yarn dependencies
-        run: yarn install --frozen-lockfile
+        run: yarn install --immutable
 
-      - if: matrix.platform == 'linux'
+      - if: matrix.platform == 'linux' || matrix.platform == 'flatpak'
         name: Install bsdtar # Required by electron-builder when targeting pacman.
         run: |
           sudo apt-get update -y
           sudo apt-get install -y libarchive-tools
 
+      - if: matrix.platform == 'flatpak'
+        name: Cache Flatpak runtimes
+        uses: actions/cache@v4
+        with:
+          path: ~/.local/share/flatpak
+          key: flatpak-${{ runner.os }}-25.08
+
+      - if: matrix.platform == 'flatpak'
+        name: Install Flatpak and flatpak-builder
+        run: |
+          sudo apt-get install -y flatpak flatpak-builder
+          flatpak remote-add --user --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
+          flatpak remote-add --user --if-not-exists flathub https://dl.flathub.org/repo/flathub.flatpakrepo
+          flatpak install --user -y flathub org.freedesktop.Platform//25.08 org.freedesktop.Sdk//25.08
+          flatpak install --user -y flathub org.electronjs.Electron2.BaseApp//25.08
+
       - name: Release project
         id: build
         uses: StarUbiquitous/command-output@v1.0.1

.github/workflows/test.yml

@@ -23,20 +23,14 @@ jobs:
         steps:
             - uses: actions/checkout@v4
 
-            - name: Enable Corepack
-              run: |
-                npm install -g corepack@latest --force
-                corepack enable
-
-            - name: Set up Node
-              uses: actions/setup-node@v4
+            - uses: jdx/mise-action@v3
               with:
-                  # The talk on the street says this might be a good version for building.
-                  node-version: 20.19.0
-                  cache: yarn
+                install: true
+                cache: true
+                log_level: debug
 
             - name: Install Yarn dependencies
-              run: yarn install --frozen-lockfile
+              run: yarn install --immutable
 
             - name: Prepare Quasar files
               run: npx @quasar/cli prepare

CHANGELOG.md

@@ -1,3 +1,51 @@
+### 3.2.12
+#### Games added
+- KeyWe
+- Smushi Come Home
+- Crime Simulator
+- Scrap Mechanic
+- Baby Steps
+- Chill with You : Lo-Fi Story
+- Crawlspace 2
+- Goblin Buster: Incremental Tower Defense
+- MineMogul
+- Nuclear Option
+- Pushing it! Together - Sisyphus Co-op
+- RAM: Random Access Mayhem
+- Unfair Flips
+- RV There Yet
+- Crab Game
+- Cloverpit
+  - Xbox Game Pass PC support
+
+#### Performance
+- Mods.yml file size has been reduced by 99.35%
+  - This results in huge improvements to the performance of profiles
+  - You'll need to perform a changing action on the profile for it to take effect. This can be:
+    - Mod re-ordering
+    - Install/Uninstall/Enable/Disable
+- Local mod list is loaded asynchronously and is visible far quicker than before
+  - Significantly reduces time spent hanging waiting for the mod list to load
+
+#### Design changes
+- Mod card buttons have been made consistent and no longer take up the entire space
+  - Easier to visually scan
+  - Less mouse movement required
+- The online preview panel now has a different background colour
+- Scrollbars are now app-styled rather than native
+- Other tweaks to improve the user experience
+
+#### Flatpak builds
+
+Flatpack builds are now available for Linux users in the r2modman GitHub repository:
+https://github.com/ebkr/r2modmanPlus/releases/latest
+
+These builds are ideal for Steam Deck and can run in Game Mode.
+
+> There are currently issues with Steam Deck's `Gamescope` compositor where dropdowns appear under the window.
+You can use arrows to work around this. I'll look into a solution further down the line.
+This issue is not present when running in Desktop Mode.
+
 ### 3.2.11
 #### Games added
 - Aeruta

FLATPAK.md

@@ -0,0 +1,49 @@
+# Flatpak build
+
+This is designed to run on the Steam Deck natively.
+
+## Running under Wayland
+
+Electron support for Wayland is iffy.
+
+I'm using the [COSMIC](https://system76.com/cosmic) desktop environment and this particularly has issues with Electron + Wayland due to issues apparently handling zypak-helper.
+
+This should however get you up and running:
+
+```shell
+flatpak run com.github.ebkr.r2modman --ozone-platform=x11 --disable-gpu
+```
+
+Fortunately, Steam Deck only uses Wayland in Desktop Mode, weirdly however this isn't an issue when running the AppImage version.
+
+## Development
+
+### Building
+
+There's currently no nice way to hot-reload to test Flatpak behaviour. It has approximately a 2.5m build time (insane) and you need to reinstall the built binary.
+
+You can use the following command to automate it for you though:
+
+```
+yarn build-flatpak && flatpak install ./dist/electron/Packaged/r2modman-<version>-x86_64.flatpak
+```
+
+## Thoughts and findings
+
+> When referring to `flatpak-spawn`, this means launching with `flatpak-spawn --host`
+
+This is hopefully useful to people developing for flatpak and outlines my struggles and thought process.
+
+### Outcome
+
+Getting Flatpak to invoke Steam has been rough. Steam, when launched from a Flatpak context, doesn't appear to forward additional arguments to the game process and instead just seems to run what's manually set in the arguments via the `Properties` section of a game.
+
+So what's the fix?
+
+The best solution I've come up with so far is to have a wrapper script that reads additional arguments via a separate file. Since we're doing things this way, it means we can also use the `steam://` protocol as we don't need to pass any additional arguments to the game process anymore, and we let the xdg handle opening the executable. It also means it likely works with Steam installed via Flatpak as we don't try to start multiple instances.
+
+### Quirks
+
+Unrelated though because it's not used anymore, but Node really doesn't like calling `flatpak-spawn`. Using `child_process` to call a separate script which then calls flatpak-spawn is fine and launches as expected, but calling it directly from the `child_process` library always fails to find it. Potentially weird sandboxing from Node?
+
+Calling via flatpak-spawn seemed to launch Steam under a minimally sandboxed environment, and so additional permissions were needed to be passed so that audio could be accessed from within the client. Weirdly, if you already had Steam open however, the one running under the host would be used instead. It may be related to my Flatpak version or some odd Node quirk, or maybe even something I've done without realising.

mise.toml

@@ -1,3 +1,3 @@
 [tools]
 node = '22'
-yarn = "latest"
+yarn = "4.11.0"

package.json

@@ -1,6 +1,6 @@
 {
   "name": "r2modman",
-  "version": "3.2.11",
+  "version": "3.2.12",
   "description": "A simple and easy to use mod manager for many games using Thunderstore.",
   "productName": "r2modman",
   "author": "ebkr",
@@ -13,10 +13,12 @@
     "sync": "tsx ./scripts/sync.ts",
     "build-win": "quasar build --mode electron -T win32",
     "build-linux": "quasar build --mode electron -T linux",
+    "build-flatpak": "BUILD_FLATPAK=true quasar build --mode electron -T linux",
     "build-osx": "quasar build --mode electron -T mac",
     "publish": "quasar build --mode electron --publish always",
     "publish-win": "quasar build --mode electron -T win32 --publish always",
     "publish-linux": "quasar build --mode electron -T linux --publish always",
+    "publish-flatpak": "BUILD_FLATPAK=true quasar build --mode electron -T linux --publish always",
     "test": "vitest run ./test/vitest"
   },
   "dependencies": {
@@ -33,7 +35,7 @@
     "bulma-slider": "2.0.4",
     "bulma-steps": "^2.2.1",
     "bulma-switch": "^2.0.0",
-    "core-js": "^3.6.5",
+    "core-js": "^3.47.0",
     "dexie": "^3.2.7",
     "dot-prop": "^5.2.0",
     "electron-updater": "4.2.5",
@@ -44,14 +46,16 @@
     "github-markdown-css": "^5.7.0",
     "glob-parent": "^6.0.2",
     "highlight.js": "^10.4.1",
+    "js-yaml": "^4.1.1",
     "lodash.debounce": "^4.0.8",
     "modern-normalize": "^3.0.1",
     "moment": "^2.29.1",
     "node-ipc": "^12.0.0",
-    "quasar": "^2.18.1",
+    "quasar": "^2.18.6",
     "quill": "^1.3.7",
     "sanitize-filename": "^1.6.3",
     "serialize-javascript": "^3.1.0",
+    "shell-quote": "^1.8.3",
     "tar": "^6.1.11",
     "trim-newlines": "^4.0.2",
     "unzipper": "^0.10.5",
@@ -65,11 +69,13 @@
   "devDependencies": {
     "@babel/core": "^7.4.0",
     "@babel/preset-typescript": "^7.14.5",
-    "@quasar/app-vite": "^2.2.1",
+    "@electron/asar": "^4.0.1",
+    "@quasar/app-vite": "^2.4.0",
     "@types/adm-zip": "^0.4.34",
     "@types/async-lock": "^1.1.2",
     "@types/chai": "^4.2.11",
     "@types/fs-extra": "^8.0.1",
+    "@types/js-yaml": "^4",
     "@types/jsdom": "^21.1.7",
     "@types/lodash.debounce": "^4.0.7",
     "@types/node": "^20.19.1",
@@ -82,9 +88,10 @@
     "autoprefixer": "^10.4.21",
     "devtron": "^1.4.0",
     "electron": "^38.1.2",
-    "electron-builder": "^24.10.5",
+    "electron-builder": "26.0.12",
     "electron-debug": "^3.0.1",
     "electron-devtools-installer": "^3.0.0",
+    "electron-installer-flatpak": "^0.8.0",
     "electron-packager": "14.1.1",
     "identity-obj-proxy": "^3.0.0",
     "mock-require": "^3.0.3",

public/steam_executable_launch.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+if [ $# -eq 0 ]; then
+    echo "Error: flatpak-spawn arguments must be provided" >&2
+    exit 1
+fi
+
+echo "Executing: /usr/bin/flatpak-spawn $@" >&1
+
+exec flatpak-spawn "$@"