build: package remus as a Flatpak for SteamOS

SteamOS has a read-only root filesystem, so a Flatpak is the way to
install it. The build is offline from vendored crates. make
flatpak-bundle writes one file to copy to a Steam machine, and
make sdk-check runs the checks inside the SDK for hosts without the
GStreamer development files.
This commit is contained in:
Ansho Rei
2026-11-04 02:19:07 +01:00
parent af307549a8
commit a74fd1bd5c
6 changed files with 139 additions and 1 deletions
+20
View File
@@ -21,6 +21,26 @@ On first start remus asks for the server address, username and password. It stor
Covers are cached in `~/.cache/remus/covers`.
## Install on SteamOS
Build the bundle on any Linux machine with Flatpak:
```
make flatpak-bundle # writes target/flatpak/remus.flatpak
```
`make flatpak` needs `org.flatpak.Builder` from Flathub. It fetches the freedesktop 26.08 SDK and its Rust extension on first use.
On the Steam machine, in Desktop Mode:
1. Copy `remus.flatpak` over and install it from a terminal: `flatpak install --user remus.flatpak`. Flatpak pulls the freedesktop 26.08 runtime from Flathub.
2. In Steam, choose Games → Add a Non-Steam Game to My Library and pick Remus.
3. Back in Game Mode, open its controller settings and pick a Gamepad layout, so Steam passes the buttons through as a controller and not as keyboard and mouse.
The Flatpak keeps its login and cover cache in `~/.var/app/me.anshorei.Fettleshed.Remus/`, not in `~/.config` and `~/.cache`. Flatpak sets `XDG_CONFIG_HOME` itself there, so overriding it with `flatpak run --env` has no effect.
To update, build a new bundle and install it the same way.
## Controls
| Gamepad | Keyboard | Action |