docs(steamos): document fsr4-vk build with distrobox #824

Open
nett00n wants to merge 2 commits from nett00n/Longshot:main into main
First-time contributor

Type: docs · Risk: low · Tested on: SteamOS · Needs: Linux OS, distrobox/toolbox

Why

Building amd_fidelityfx_upscaler_vk.so on SteamOS requires a suitable Linux development environment. SteamOS is an immutable operating system, so installing build dependencies directly on the host is inconvenient.

These instructions document how to use Fedora Distrobox to build the FSR4 Vulkan library without modifying the SteamOS base system.

What changed

doc added

Measurements

non applicable

Hardware: SteamDeck
Scene: non applicable
Method: non applicable
How to reproduce: non applicable

Before: main @ After: this PR @

Flags and settings

non applicable

Testing

non applicable

Risks

What could break: none

Turning it off: none

Compatibility: none

Issues

non applicable

Fixes #

Checklist

non applicable

Everyone

  • One topic.
  • The title is a Conventional Commit (type(scope): description) of the status line's type.
  • Why gives the reason plainly and links the issues that fit (the tracker searched).
  • Tested on my own PC where it runs (in the game, for a change the game runs), as Testing's Tested says; what
    can't be run by hand is in Testing's Not testable by hand, with why.
  • Measurements has a verdict, or one line saying why there is nothing to measure.
  • Nothing gets worse that I know of: any cost (speed, latency, memory, a setup that worked before) is measured and
    in Risks. Not ticked yet: Measurements is still template placeholders with no verdict or reason for nothing to measure.
  • [] Testing names what was tested, what wasn't, and what must still be tested, where and how.
  • [xx] Rebased on current main.
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named).
  • No game files, dumps, build output or generated files.
  • third_party/ untouched (a new folder with a PROVENANCE.md instead).
  • The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled.

When it applies

  • AI assistance recorded with Assisted-by: / Co-Authored-By: trailers.
  • Numbers from the same PC, scene and settings, at least 2 interleaved runs each, the median reported.
  • Switches documented (docs/development.md; the README for a menu row) and shipped at their recommended value.
  • Screenshots of the same spot, captioned like the Measurements columns, for a change that shows on screen.
  • A file in docs/tested/ for each new measured run (format in docs/tested-configurations.md).
  • MKWVK_API_VERSION bumped (gpu/vk/vk_api.h's MkwVkHost or MkwVkRenderer changed).
  • The SPIR-V headers regenerated with glslang (a shader changed).
  • A game-free test added for the fix, failing on main and passing here.
  • A check under tests/ that reads changed source updated in this PR, not weakened.
  • Host code builds on both Windows (llvm-mingw) and Linux, with UTF-8 paths.
  • Docs updated.
**Type:** docs · **Risk:** low · **Tested on:** SteamOS · **Needs:** Linux OS, distrobox/toolbox ## Why Building amd_fidelityfx_upscaler_vk.so on SteamOS requires a suitable Linux development environment. SteamOS is an immutable operating system, so installing build dependencies directly on the host is inconvenient. These instructions document how to use Fedora Distrobox to build the FSR4 Vulkan library without modifying the SteamOS base system. ## What changed doc added ## Measurements non applicable Hardware: SteamDeck Scene: non applicable Method: non applicable How to reproduce: non applicable | | Before: main @ <commit> | After: this PR @ <commit> | |---|---|---| | <what was measured> | | | ### Flags and settings non applicable ## Testing non applicable ## Risks **What could break:** none **Turning it off:** none **Compatibility:** none ## Issues non applicable Fixes # ## Checklist non applicable ### Everyone - [x] One topic. - [x] The title is a Conventional Commit (`type(scope): description`) of the status line's type. - [x] Why gives the reason plainly and links the issues that fit (the tracker searched). - [x] Tested on my own PC where it runs (in the game, for a change the game runs), as Testing's Tested says; what can't be run by hand is in Testing's Not testable by hand, with why. - [x] Measurements has a verdict, or one line saying why there is nothing to measure. - [ ] Nothing gets worse that I know of: any cost (speed, latency, memory, a setup that worked before) is measured and in Risks. Not ticked yet: Measurements is still template placeholders with no verdict or reason for nothing to measure. - [] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [xx] Rebased on current `main`. - [ ] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). - [x] No game files, dumps, build output or generated files. - [x] `third_party/` untouched (a new folder with a `PROVENANCE.md` instead). - [x] The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled. ### When it applies - [ ] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. - [ ] Numbers from the same PC, scene and settings, at least 2 interleaved runs each, the median reported. - [ ] Switches documented (docs/development.md; the README for a menu row) and shipped at their recommended value. - [ ] Screenshots of the same spot, captioned like the Measurements columns, for a change that shows on screen. - [ ] A file in `docs/tested/` for each new measured run (format in `docs/tested-configurations.md`). - [ ] `MKWVK_API_VERSION` bumped (`gpu/vk/vk_api.h`'s `MkwVkHost` or `MkwVkRenderer` changed). - [ ] The SPIR-V headers regenerated with glslang (a shader changed). - [ ] A game-free test added for the fix, failing on `main` and passing here. - [ ] A check under `tests/` that reads changed source updated in this PR, not weakened. - [ ] Host code builds on both Windows (llvm-mingw) and Linux, with UTF-8 paths. - [x] Docs updated.
Update docs/how-to-build-FSR-so-on-steamdeck.md
Some checks failed
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Failing after 7s
37149387bf
Member

Basic code-only review of 37149387bf; informational feedback, with final approval left to another reviewer.

Two corrections in docs/how-to-build-FSR-so-on-steamdeck.md:

  • P2 — protect an existing checkout (lines 35–36 and 67). If ~/fsr4-vk already contains someone's work, git clone fails but the following cd succeeds. The guide then uses that existing checkout and its optional rm -rf ~/fsr4-vk deletes it, including uncommitted work. Distrobox shares the host home by default. Use a newly created dedicated directory, stop on clone failure, and limit cleanup to the directory created by this procedure.
  • P2 — leave the container before removing it (line 64). Step 1 enters a container shell, and no later step exits it. The removal command is therefore issued inside the container rather than from the SteamOS host, where the container manager lives. Add an explicit exit and label cleanup as host-side; see Distrobox enter.

The setup/build command names and output path match the upstream fsr4-vk guide. As a useful finishing step, link Longshot's existing FSR instructions: a build with --fsr and placing the library beside the game are still needed; copying it to home alone does not enable it. The PR says SteamOS was tested, but its Testing section is still a placeholder; record which steps succeeded and the versions used.

No tests, builds, or documented commands were run.

Basic code-only review of 37149387bf211e1467fe9e0a4be2e34297665562; informational feedback, with final approval left to another reviewer. Two corrections in `docs/how-to-build-FSR-so-on-steamdeck.md`: - **P2 — protect an existing checkout (lines 35–36 and 67).** If `~/fsr4-vk` already contains someone's work, `git clone` fails but the following `cd` succeeds. The guide then uses that existing checkout and its optional `rm -rf ~/fsr4-vk` deletes it, including uncommitted work. Distrobox [shares the host home by default](https://distrobox.it/usage/distrobox-create/). Use a newly created dedicated directory, stop on clone failure, and limit cleanup to the directory created by this procedure. - **P2 — leave the container before removing it (line 64).** Step 1 enters a container shell, and no later step exits it. The removal command is therefore issued inside the container rather than from the SteamOS host, where the container manager lives. Add an explicit `exit` and label cleanup as host-side; see [Distrobox enter](https://distrobox.it/usage/distrobox-enter/). The setup/build command names and output path match the [upstream fsr4-vk guide](https://github.com/Astyyyyy/fsr4-vk). As a useful finishing step, link Longshot's existing FSR instructions: a build with `--fsr` and placing the library beside the game are still needed; copying it to home alone does not enable it. The PR says SteamOS was tested, but its Testing section is still a placeholder; record which steps succeeded and the versions used. No tests, builds, or documented commands were run.
Owner

Brought up to the ready-for-review standard (#1454): the checklist's Everyone list has two new boxes, added here from what this PR's description and comments show (please check they match what you know).

  • Tested on my own PC: ticked: Docs-only change, and Testing says non applicable, so nothing needs running.
  • Nothing gets worse that I know of: not ticked: Measurements is still template placeholders with no verdict or reason for nothing to measure. Measure that cost and state it in Risks, then tick it.
Brought up to the [ready-for-review standard](https://git.magicbean.dev/MagicBeanDev/Longshot/src/branch/main/CONTRIBUTING.md#ready-for-review-out-of-wip) (#1454): the checklist's Everyone list has two new boxes, added here from what this PR's description and comments show (please check they match what you know). - *Tested on my own PC*: ticked: Docs-only change, and Testing says non applicable, so nothing needs running. - *Nothing gets worse that I know of*: not ticked: Measurements is still template placeholders with no verdict or reason for nothing to measure. Measure that cost and state it in Risks, then tick it.
Some checks failed
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Failing after 7s
This pull request doesn't have enough approvals yet. 0 of 1 approvals granted.
Some workflows are waiting to be reviewed.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 'main:nett00n-main'
git switch 'nett00n-main'
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
MagicBeanDev/Longshot!824
No description provided.