WIP: docs: the readme's work/ffx-sdk path, and the RTX 5090 pipeline list's note says what its build changed #1166

Draft
TrashPanda wants to merge 2 commits from TrashPanda/Longshot:docs/readme-release-notes into main
Contributor

Type: docs · Risk: low · Tested on: Linux, RTX 4070 Ti (game-free checks) · Needs: none

Why

The readme showed the default FFX SDK folder with a form feed in its name, and a shipped pipeline list's note did not say what its build was.

Restored from Hookshot 2553, Hookshot 2703, by Dukenheimer, RoblesLeo, and split out of #284 so it can be reviewed and merged on its own.

What changed

Two text fixes, nothing else.

Commits, each with its original author and message:

c2c77ea0 fix: readme's work/ffx-sdk, and the build log names an FSR 4 tick without AMD's license (RoblesLeo)

Follow-up to https://github.com/NotRexed/Hookshot/pull/1866's review.

  • readme: the default HOOKSHOT_FFX_SDK folder read
    work<0x0C>fx-sdk (a \f had turned into a form feed). It reads
    work/ffx-sdk now.
  • Windows Builder: an AMD FSR 4 tick saved before the builder asked
    for AMD's license still builds with FSR 4 and fetches nothing, as
    before. The build log now says so in one line: "AMD's license not
    accepted yet: tick AMD FSR 4 again to have its runtime fetched".
    tests/test_ffx_sdk.py's source check covers the line.

Ran locally on Windows: test_ffx_sdk, test_make_game_ngx,
test_builder_dlss_update and dotnet build of the Builder, all
passing.

🤖 Generated with Claude Code

Co-authored-by: Claude Opus 5.5 [email protected]
Co-authored-by: NotRexed [email protected]

Ported to Longshot: only the readme fix. Longshot's builder is command line only (#181), so the Builder window's
log line and its source check are left out.

Restored-from: https://github.com/NotRexed/Hookshot/pull/2553

47115d72 build(release): the RTX 5090 fork list's note says what its build changed (a follow-up to Hookshot PR 2143) (Dukenheimer)

Follow-up to https://github.com/NotRexed/Hookshot/pull/2143, which merged before I could answer Joey-Magnus's and
hckrman101's question about brett-d-rtx-5090-fork-fg-2x. This changes
only that list's note, to say what its build was.

The "fork" was local builds of main at 0828863 (9 Nov), plus changes
that don't touch what goes into a record: DLSS-NR and an FXAA option in
the window-scaling pass, a sampler cache and its descriptor-reuse check,
a texture budget, menu rows and a voice feature. There are no changes to
shader translation, program variants, target formats or draw state.

python -I nx2/pipeline_states.py check passes. The list itself is
unchanged.

Refs https://github.com/NotRexed/Hookshot/issues/2034, https://github.com/NotRexed/Hookshot/pull/2143

Co-authored-by: Copilot App [email protected]
Co-authored-by: NotRexed [email protected]
Restored-from: https://github.com/NotRexed/Hookshot/pull/2703

Measurements

Verdict: nothing to measure: a correctness fix off the frame path, covered by game-free checks.

Flags and settings

None.

Testing

Tested: On Linux (kernel 7.0), RTX 4070 Ti, main @ 71b1edd8, this PR @ 47115d72: the checks that read the changed files (tests/run_all.py --changed origin/main) pass. The full suite (tests/run_all.py) has not been run on this branch yet; a comment will follow when it has.

Not tested: Nothing to run. Opened as work in progress until it runs in the game.

Must be tested:

  • None

Risks

What could break: nothing.

Turning it off: revert the commit.

Compatibility: Nothing changes.

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).
  • 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.
  • 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.
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named).

When it applies

  • Docs updated.
  • AI assistance recorded with Assisted-by: / Co-Authored-By: trailers.
**Type:** docs · **Risk:** low · **Tested on:** Linux, RTX 4070 Ti (game-free checks) · **Needs:** none ## Why The readme showed the default FFX SDK folder with a form feed in its name, and a shipped pipeline list's note did not say what its build was. Restored from [Hookshot 2553](https://github.com/NotRexed/Hookshot/pull/2553), [Hookshot 2703](https://github.com/NotRexed/Hookshot/pull/2703), by Dukenheimer, RoblesLeo, and split out of [#284](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/284) so it can be reviewed and merged on its own. ## What changed Two text fixes, nothing else. Commits, each with its original author and message: <details><summary><code>c2c77ea0</code> fix: readme's work/ffx-sdk, and the build log names an FSR 4 tick without AMD's license (RoblesLeo)</summary> Follow-up to https://github.com/NotRexed/Hookshot/pull/1866's review. - **readme:** the default `HOOKSHOT_FFX_SDK` folder read `work<0x0C>fx-sdk` (a `\f` had turned into a form feed). It reads `work/ffx-sdk` now. - **Windows Builder:** an AMD FSR 4 tick saved before the builder asked for AMD's license still builds with FSR 4 and fetches nothing, as before. The build log now says so in one line: "AMD's license not accepted yet: tick AMD FSR 4 again to have its runtime fetched". `tests/test_ffx_sdk.py`'s source check covers the line. Ran locally on Windows: `test_ffx_sdk`, `test_make_game_ngx`, `test_builder_dlss_update` and `dotnet build` of the Builder, all passing. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-authored-by: Claude Opus 5.5 <[email protected]> Co-authored-by: NotRexed <[email protected]> Ported to Longshot: only the readme fix. Longshot's builder is command line only (#181), so the Builder window's log line and its source check are left out. Restored-from: https://github.com/NotRexed/Hookshot/pull/2553 </details> <details><summary><code>47115d72</code> build(release): the RTX 5090 fork list's note says what its build changed (a follow-up to Hookshot PR 2143) (Dukenheimer)</summary> Follow-up to https://github.com/NotRexed/Hookshot/pull/2143, which merged before I could answer Joey-Magnus's and hckrman101's question about `brett-d-rtx-5090-fork-fg-2x`. This changes only that list's note, to say what its build was. The "fork" was local builds of main at 0828863 (9 Nov), plus changes that don't touch what goes into a record: DLSS-NR and an FXAA option in the window-scaling pass, a sampler cache and its descriptor-reuse check, a texture budget, menu rows and a voice feature. There are no changes to shader translation, program variants, target formats or draw state. `python -I nx2/pipeline_states.py check` passes. The list itself is unchanged. Refs https://github.com/NotRexed/Hookshot/issues/2034, https://github.com/NotRexed/Hookshot/pull/2143 Co-authored-by: Copilot App <223556219+[email protected]> Co-authored-by: NotRexed <[email protected]> Restored-from: https://github.com/NotRexed/Hookshot/pull/2703 </details> ## Measurements **Verdict:** nothing to measure: a correctness fix off the frame path, covered by game-free checks. ### Flags and settings None. ## Testing **Tested:** On Linux (kernel 7.0), RTX 4070 Ti, `main` @ 71b1edd8, this PR @ 47115d72: `the checks that read the changed files (`tests/run_all.py --changed origin/main`)` pass. The full suite (`tests/run_all.py`) has not been run on this branch yet; a comment will follow when it has. **Not tested:** Nothing to run. Opened as work in progress until it runs in the game. **Must be tested:** - None ## Risks **What could break:** nothing. **Turning it off:** revert the commit. **Compatibility:** Nothing changes. ## 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). - [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] 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. - [ ] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). ### When it applies - [x] Docs updated. - [x] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers.
Follow-up to https://github.com/NotRexed/Hookshot/pull/1866's review.

- **readme:** the default `HOOKSHOT_FFX_SDK` folder read
`work<0x0C>fx-sdk` (a `\f` had turned into a form feed). It reads
`work/ffx-sdk` now.
- **Windows Builder:** an AMD FSR 4 tick saved before the builder asked
for AMD's license still builds with FSR 4 and fetches nothing, as
before. The build log now says so in one line: "AMD's license not
accepted yet: tick AMD FSR 4 again to have its runtime fetched".
`tests/test_ffx_sdk.py`'s source check covers the line.

Ran locally on Windows: `test_ffx_sdk`, `test_make_game_ngx`,
`test_builder_dlss_update` and `dotnet build` of the Builder, all
passing.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 5.5 <[email protected]>
Co-authored-by: NotRexed <[email protected]>

Ported to Longshot: only the readme fix. Longshot's builder is command line only (#181), so the Builder window's
log line and its source check are left out.

Restored-from: https://github.com/NotRexed/Hookshot/pull/2553
build(release): the RTX 5090 fork list's note says what its build changed (a follow-up to Hookshot PR 2143)
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 7s
47115d7226
Follow-up to https://github.com/NotRexed/Hookshot/pull/2143, which merged before I could answer Joey-Magnus's and
hckrman101's question about `brett-d-rtx-5090-fork-fg-2x`. This changes
only that list's note, to say what its build was.

The "fork" was local builds of main at 0828863 (9 Nov), plus changes
that don't touch what goes into a record: DLSS-NR and an FXAA option in
the window-scaling pass, a sampler cache and its descriptor-reuse check,
a texture budget, menu rows and a voice feature. There are no changes to
shader translation, program variants, target formats or draw state.

`python -I nx2/pipeline_states.py check` passes. The list itself is
unchanged.

Refs https://github.com/NotRexed/Hookshot/issues/2034, https://github.com/NotRexed/Hookshot/pull/2143

Co-authored-by: Copilot App <[email protected]>
Co-authored-by: NotRexed <[email protected]>
Restored-from: https://github.com/NotRexed/Hookshot/pull/2703
Author
Contributor

Tested in game: Linux (Ubuntu 26.04.1, kernel 7.0.0-43), RTX 4070 Ti 12 GB, NVIDIA 595.99.02, Ryzen 7 9800X3D: this branch built together with the other 18 split from #218 and #284-#288, merged onto main @ 71b1edd8 (make_game.py --update, build v3.0.0-rc.5-82-g5952bb3d), then played by a scripted tour through the control bridge (scripts/memtour.py: a save loaded, Zora's Domain, the Market, Hyrule Field and Death Mountain Trail, 40 s each with walking and camera swings). All 4 stops reached, a clean quit, and no device loss or Vulkan error in the log. Docs and a list's note only; the build and the game ran with them.

Tested in game: Linux (Ubuntu 26.04.1, kernel 7.0.0-43), RTX 4070 Ti 12 GB, NVIDIA 595.99.02, Ryzen 7 9800X3D: this branch built together with the other 18 split from #218 and #284-#288, merged onto main @ 71b1edd8 (make_game.py --update, build v3.0.0-rc.5-82-g5952bb3d), then played by a scripted tour through the control bridge (scripts/memtour.py: a save loaded, Zora's Domain, the Market, Hyrule Field and Death Mountain Trail, 40 s each with walking and camera swings). All 4 stops reached, a clean quit, and no device loss or Vulkan error in the log. Docs and a list's note only; the build and the game ran with them.
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: Author's Tested in game comments describe an in-game run on Linux with an RTX 4070 Ti, covering the pipeline list note.
  • Nothing gets worse that I know of: ticked: Docs and a list note only, with Risks stating nothing could break and nothing changes.
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: Author's Tested in game comments describe an in-game run on Linux with an RTX 4070 Ti, covering the pipeline list note. - *Nothing gets worse that I know of*: ticked: Docs and a list note only, with Risks stating nothing could break and nothing changes.
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 7s
This pull request is marked as a work in progress.
Some workflows are waiting to be reviewed.
This branch is out-of-date with the base branch
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 'docs/readme-release-notes:TrashPanda-docs/readme-release-notes'
git switch 'TrashPanda-docs/readme-release-notes'
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!1166
No description provided.