fix(linux): the AppImage carries AMD's FidelityFX SDK licence beside the FSR 3.1 shaders built from it #1500

Merged
llun merged 2 commits from zeldaootr/Longshot:appimage-fidelityfx-sdk-licence into main 2026-11-18 01:39:56 +00:00
Contributor

Type: fix · Risk: low · Tested on: Linux (the AppImage's licence block, run by its test) · Needs: none

TL;DR

Every build compiles AMD's FidelityFX SDK shaders (FSR 3.1 and its frame generation) into the renderer, but the Linux AppImage didn't carry that SDK's MIT licence notice; it carried only the FSR 4 headers' licence. This PR copies the SDK's licence and its provenance note into the AppImage's licenses folder, beside the others. A test that fails on main checks it. The Windows builder zip already carries it.

Breakdown

  • Who it helps: anyone who redistributes or audits the Linux AppImage. Players see nothing.
  • What was wrong: the AppImage's licence block listed third_party/fidelityfx (FSR 4's API headers) but not third_party/fidelityfx-sdk, whose shaders every build compiles in.
  • What changes: the AppImage gains licenses/fidelityfx-sdk/LICENSE.txt and PROVENANCE.md.
  • What does not change: the game, the renderer, the Windows builder zip (it already carries every tracked third_party file).
  • How it was checked: tests/test_appimage_licenses.py runs the AppImage script's licence block and compares the copied files. It fails on main and passes here.
  • What is still open: nothing.
  • Risk: low: two more files in the image.

Why

AMD's FidelityFX SDK (third_party/fidelityfx-sdk, v1.1.4, MIT) is compiled into every build:

  • scripts/fsr3_shaders.py turns its FSR 3.1 upscaler, frame-interpolation and optical-flow passes into the SPIR-V headers in gpu/vk/shaders;
  • the AppImage carries those headers (cp -a gpu/vk);
  • every player's longshot_vk.so is built with them.

MIT asks that its notice go with every copy or substantial portion. The AppImage's licence block (scripts/linux/appimage.sh, "the licences of the third-party parts compiled into longshot_vk.so") copies imgui's, zstd's, the Libertinus fonts' and third_party/fidelityfx's, which is FSR 4's API headers. The SDK's was missing.

The Windows Longshot Builder zip (scripts/builder_package.py) copies every tracked file under third_party into tools\, the SDK's LICENSE.txt included, so it needs no change.

How to reproduce

Seen on: main @ 310e7c9df, Linux (the AppImage's licence block and its check; no game needed)
Steps: read the licence block of scripts/linux/appimage.sh (the lines between "the licences of the third-party parts" and "end of the licences"), or run this PR's test commit: python -I -B tests/test_appimage_licenses.py
Expected: a licenses/fidelityfx-sdk/ folder with the SDK's LICENSE.txt and PROVENANCE.md, beside imgui, zstd, libertinus and fidelityfx, since scripts/fsr3_shaders.py compiles the SDK's FSR 3.1 passes into gpu/vk/shaders' headers that every build has
Actual: no such folder; the check fails with No such file or directory: .../licenses/fidelityfx-sdk/LICENSE.txt

What changed

The AppImage now ships AMD's FidelityFX SDK licence beside the other third-party licences.

  • scripts/linux/appimage.sh: the licence block makes licenses/fidelityfx-sdk/ and copies third_party/fidelityfx-sdk/LICENSE.txt and PROVENANCE.md into it.
  • tests/test_appimage_licenses.py:
    • WANT names the two files;
    • test_vk_third_party_covered also requires them whenever scripts/fsr3_shaders.py compiles from third_party/fidelityfx-sdk and the image carries gpu/vk.

Measurements

Nothing to measure: packaging only; the check above is the measurement.

Flags and settings

None.

Testing

Tested: python -I -B tests/test_appimage_licenses.py on Linux: on main it errors with No such file or directory: .../licenses/fidelityfx-sdk/LICENSE.txt; here OK (4 tests). python -I -B tests/run_all.py --changed main: 14 passed, 0 failed. shellcheck -S warning scripts/linux/appimage.sh: clean.

Not tested: a full AppImage build; the licence block is the part that changed, and its test runs it.

Must be tested: none.

Risks

What could break: nothing at run time; the AppImage build would stop if the SDK's files were moved, which the test would catch first.

Turning it off: revert the commit.

Compatibility: nothing changes for a player.

Checklist

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). Searched open and closed pull requests and open issues for the AppImage and its licences: no issue or open fix for this; the licence block came with #174.
  • 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.
  • Testing names what was tested, what wasn't, and what must still be tested, where and how.
  • Rebased on current main.
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named). (The changed set: 14 checks, all passing.)
  • 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.
  • 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.
**Type:** fix · **Risk:** low · **Tested on:** Linux (the AppImage's licence block, run by its test) · **Needs:** none ## TL;DR Every build compiles AMD's FidelityFX SDK shaders (FSR 3.1 and its frame generation) into the renderer, but the Linux AppImage didn't carry that SDK's MIT licence notice; it carried only the FSR 4 headers' licence. This PR copies the SDK's licence and its provenance note into the AppImage's `licenses` folder, beside the others. A test that fails on `main` checks it. The Windows builder zip already carries it. ## Breakdown - **Who it helps:** anyone who redistributes or audits the Linux AppImage. Players see nothing. - **What was wrong:** the AppImage's licence block listed `third_party/fidelityfx` (FSR 4's API headers) but not `third_party/fidelityfx-sdk`, whose shaders every build compiles in. - **What changes:** the AppImage gains `licenses/fidelityfx-sdk/LICENSE.txt` and `PROVENANCE.md`. - **What does not change:** the game, the renderer, the Windows builder zip (it already carries every tracked `third_party` file). - **How it was checked:** `tests/test_appimage_licenses.py` runs the AppImage script's licence block and compares the copied files. It fails on `main` and passes here. - **What is still open:** nothing. - **Risk:** low: two more files in the image. ## Why AMD's FidelityFX SDK (`third_party/fidelityfx-sdk`, v1.1.4, MIT) is compiled into every build: - `scripts/fsr3_shaders.py` turns its FSR 3.1 upscaler, frame-interpolation and optical-flow passes into the SPIR-V headers in `gpu/vk/shaders`; - the AppImage carries those headers (`cp -a gpu/vk`); - every player's `longshot_vk.so` is built with them. MIT asks that its notice go with every copy or substantial portion. The AppImage's licence block (`scripts/linux/appimage.sh`, "the licences of the third-party parts compiled into longshot_vk.so") copies imgui's, zstd's, the Libertinus fonts' and `third_party/fidelityfx`'s, which is FSR 4's API headers. The SDK's was missing. The Windows Longshot Builder zip (`scripts/builder_package.py`) copies every tracked file under `third_party` into `tools\`, the SDK's `LICENSE.txt` included, so it needs no change. ## How to reproduce **Seen on:** main @ 310e7c9df, Linux (the AppImage's licence block and its check; no game needed) **Steps:** read the licence block of `scripts/linux/appimage.sh` (the lines between "the licences of the third-party parts" and "end of the licences"), or run this PR's test commit: `python -I -B tests/test_appimage_licenses.py` **Expected:** a `licenses/fidelityfx-sdk/` folder with the SDK's `LICENSE.txt` and `PROVENANCE.md`, beside `imgui`, `zstd`, `libertinus` and `fidelityfx`, since `scripts/fsr3_shaders.py` compiles the SDK's FSR 3.1 passes into `gpu/vk/shaders`' headers that every build has **Actual:** no such folder; the check fails with `No such file or directory: .../licenses/fidelityfx-sdk/LICENSE.txt` ## What changed The AppImage now ships AMD's FidelityFX SDK licence beside the other third-party licences. - `scripts/linux/appimage.sh`: the licence block makes `licenses/fidelityfx-sdk/` and copies `third_party/fidelityfx-sdk/LICENSE.txt` and `PROVENANCE.md` into it. - `tests/test_appimage_licenses.py`: - `WANT` names the two files; - `test_vk_third_party_covered` also requires them whenever `scripts/fsr3_shaders.py` compiles from `third_party/fidelityfx-sdk` and the image carries `gpu/vk`. ## Measurements Nothing to measure: packaging only; the check above is the measurement. ### Flags and settings None. ## Testing **Tested:** `python -I -B tests/test_appimage_licenses.py` on Linux: on `main` it errors with `No such file or directory: .../licenses/fidelityfx-sdk/LICENSE.txt`; here `OK` (4 tests). `python -I -B tests/run_all.py --changed main`: 14 passed, 0 failed. `shellcheck -S warning scripts/linux/appimage.sh`: clean. **Not tested:** a full AppImage build; the licence block is the part that changed, and its test runs it. **Must be tested:** none. ## Risks **What could break:** nothing at run time; the AppImage build would stop if the SDK's files were moved, which the test would catch first. **Turning it off:** revert the commit. **Compatibility:** nothing changes for a player. ## Checklist ### 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). Searched open and closed pull requests and open issues for the AppImage and its licences: no issue or open fix for this; the licence block came with https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/174. - [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. - [x] Nothing gets worse that I know of: any cost (speed, latency, memory, a setup that worked before) is measured and in Risks. - [x] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [x] Rebased on current `main`. - [x] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). *(The changed set: 14 checks, all passing.)* - [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 - [x] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. - [x] A game-free test added for the fix, failing on `main` and passing here. - [x] A check under `tests/` that reads changed source updated in this PR, not weakened.
`gpu/vk/shaders`' FSR 3.1 and frame-generation headers are compiled from `third_party/fidelityfx-sdk` (MIT) by
`scripts/fsr3_shaders.py`, the AppImage carries them (`cp -a gpu/vk`) and every player's `longshot_vk.so` is built with
them, but its licence block ships only `third_party/fidelityfx`'s (the FSR 4 API headers). `tests/test_appimage_licenses.py`
now wants `licenses/fidelityfx-sdk/LICENSE.txt` and its `PROVENANCE.md`, and holds the image's licences to the SDK's use.
Fails on main.

Assisted-by: Claude
fix(linux): the AppImage carries AMD's FidelityFX SDK licence beside the FSR 3.1 shaders built from it
Some checks are pending
CI / Conventional Commit title (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 / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (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) Successful in 4s
627b1c2942
Every build compiles AMD's FidelityFX SDK shaders (FSR 3.1 and its frame generation, `third_party/fidelityfx-sdk`, MIT) into
`longshot_vk.so` from the SPIR-V headers in `gpu/vk/shaders`, which the AppImage carries. MIT asks for its notice with
every copy, and the image's licence block shipped only `third_party/fidelityfx`'s (the FSR 4 API headers). It now copies the
SDK's `LICENSE.txt` and `PROVENANCE.md` into `licenses/fidelityfx-sdk/`. The Windows builder zip already carries every
tracked `third_party` file (`scripts/builder_package.py`), this licence included.

Assisted-by: Claude
Author
Contributor

Description completed: How to reproduce added, and the box for the check that reads the changed script.

Description completed: How to reproduce added, and the box for the check that reads the changed script.
zeldaootr changed title from WIP: fix(linux): the AppImage carries AMD's FidelityFX SDK licence beside the FSR 3.1 shaders built from it to fix(linux): the AppImage carries AMD's FidelityFX SDK licence beside the FSR 3.1 shaders built from it 2026-11-18 01:33:57 +00:00
llun approved these changes 2026-11-18 01:39:47 +00:00
llun merged commit a35130c015 into main 2026-11-18 01:39:56 +00:00
Some checks are pending
CI / Conventional Commit title (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 / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (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) Successful in 4s
Some workflows are waiting to be reviewed.
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 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!1500
No description provided.