feat(prompts): the System page's guide follows every controller and binding (#1211) #1700

Open
gab9281 wants to merge 5 commits from gab9281/Longshot:dynamic/system-guide-lines into main
Member

Summary

The pause menu's System page shows the game's controller guide: a picture of the pad, its labels and the lines between them. On main it only fits the Switch with its default buttons: pick another face in Button prompts, or rebind a button, and the lines still point where the Switch's defaults are (on PS5, the d-pad's line ends on the left stick).

On main: Button prompts PlayStation 5 (or any face but the Switch's), open the pause menu's System page: the labels and lines are the Switch's, whatever is bound.

Here: the page is laid out again for the face and the bindings, at start and whenever either changes: each group of labels in one shaded box with one line to its controls; lines orthogonal, as short as they can be, never crossing, jumping another only as a last resort; labels on their controls' side; an input with nothing bound gets no label and no line; the default Switch bindings give the game's own page. Every controller (Switch, Xbox, PS4, PS5, Steam Deck, the keyboard's labels-only page), every language, any resolution. And each row of the Insert menu's Controls page gets a Reset (or R, the pad's paste button) that puts that row alone back to its default.

Read first: host/prompt_guides.c (pg_solve: groups, sides, routes, the maze); in host/prompts.c, guide_make, guide_layout_runs (the page written into the game's layout) and guide_texts; reset_control in gpu/vk/vk_menu.cpp; docs/system-guide-lines.md (the layout data, progress by name, free rows, known limits).

Closes #1211. Follows #1623 (closed), its baked first slice.

Before / after (crazy-0 bindings, PS5 and Xbox):

Before: main / After: this PR, crazy-0 on PS5 and Xbox

Every set on every controller, resolutions, languages, the keyboard

Default bindings, all five controllers (the Switch's is the game's own page)

default bindings, all five controllers

Upside-down bindings

upside-down bindings

Sticks on the face buttons

sticks on the face buttons

Shoulders on the face buttons

shoulders on the face buttons

Crazy-0 (random wild bindings, paddles and guide always bound)

crazy-0

Crazy-2

crazy-2

Random-6

random-6

Unbound Y, + and d-pad Left: no label, no line

unbound Y, + and d-pad Left

Crazy-0 on Xbox and PS5 at 1280x720, 1920x1080, 1920x1200, 2560x1080, 3840x2160

resolutions

Crazy-0 on PS5 in the game's 15 languages

languages

The keyboard's page; the game's own page at 16:10

keyboard and 16:10

Known limits (also in the doc):

  • A locked action keeps its row: the game hides the label (Toggle Accessory before it is unlocked) but its box stays sized for it, so a 4-row box can show 3 labels. Shrinking it needs the save's unlock state when the page is laid out, and where the game keeps it is not found.
  • B's or X's label moved to the other side shows the wrong action text: the game's code writes their action texts ("Put Away" / "Unequip", "Jump") into fixed panes.
  • The controller picture was missing twice in 32 runs (lines and labels drawn; both fine when shot again). Cause unknown.
  • Short vertical stubs at 16:10 (1920x1200): the game's own page has them too (last picture).
  • A change of face made while the System page is open shows once the pause menu is opened again: until then the page keeps the picture and icons it was opened with, as on main.

Testing

Tested: Linux (CachyOS), NVIDIA RTX 3060 Laptop GPU, slot 04 of my save:

  • This head (89952853, on main @ 9027e737; the row Reset now at API version 37), in the game at 1920x1080 (the System page shot on slot 04): crazy-0 and unbound Y, + and d-pad Left on Xbox at start, each laid out with 0 conflicts and 0 jumps in 37–51 ms; the default bindings changed live to Xbox, then to PS5, the pause menu opened again after each: the page, its picture and its icons follow each face (32–34 ms):

here @ 89952853: crazy-0 and unbound on Xbox; default after a live change to Xbox, then PS5

  • The head before (709d3a7f, on main @ 3f2c9b3c), after the review's fixes, in the game at 1920x1080 (the System page shot on slot 04): the default bindings on PS5, crazy-0 on Xbox, unbound Y, + and d-pad Left on Switch: each page laid out with 0 conflicts and 0 jumps (laid out in 50 ms to 66 ms), its labels' texts following the page; main @ 3f2c9b3c with crazy-0 on PS5 keeps the Switch's lines:

main crazy-0 PS5; here: default PS5, crazy-0 Xbox, unbound Switch

  • Earlier heads (ae5434c5, the same solver): a matrix of 32 game runs, 8 bindings sets × 5 controllers, the keyboard face, 5 resolutions on Xbox and PS5, 15 languages on PS5: every page laid out with 0 conflicts; one needed a jump (Steam Deck, sticks-on-face). The pictures above are from it.
  • tests/test_prompt_guides.py (every face through default, swapped, sticks/shoulders-on-face, crazy and random bindings), test_pad_layout.py (a row's Reset, with two cases that fail on the Reset before the review's fix, which left the row with no gamepad input), test_prompts_live.py, test_hos_ab.py, test_mods_menu.py, test_menu_i18n.py pass. mise run test --changed: 165 checks, 13 fail, each of them failing on main @ 3f2c9b3c too (test_bug_report_defaults, test_crash_dialog, test_crt_options, test_damage_debug_menu, test_dev_ab, test_dev_packs, test_host_guest_writes, test_hud_layout_row, test_lift_cache, test_mods_size_table, test_slow_frames, test_upscaler_rows, test_walk_key).
  • Built for Linux here (the dev pack); Windows (llvm-mingw) by CI on this head.

Still to test:

  • Windows, any GPU: Button prompts PlayStation 5, rebind a few buttons on the Controls page, open the System page, expecting the lines to end on the new controls with no crossing (@Beanstalk windows: the System page's guide after rebinding, on PS5).
  • Steam Deck: Button prompts Steam Deck, the System page with the default bindings and after a Reset of a rebound row, expecting the Deck's page and the row back to its default (by hand: a tester with a Deck).

Measurements

Nothing to measure in play: the page is laid out on a thread of its own when the face or the bindings change, and at the start's loading (logged: laid out in N ms: 32 to 66 ms here); the live writes never wait for it.

Risks

The Insert menu's renderer API goes to version 37 (binding_default, for the row Reset, after main's ab_value at 36): an older host leaves the Reset out. The host writes into the game's live layout data: every run is checked against what was served, and the page stays the game's when a check fails. The Controls page gets a new column. The default Switch bindings keep the game's own page. A revert is enough; nothing changes after updating (saves and longshot_options.ini as they were; the button prompts' cache is made again).

Checklist

Ready for review

  • One topic, on current main; the title is a Conventional Commit.
  • Tested on my own PC, in the game for a change the game runs, as Testing says.
  • mise run test passes (any failure that also fails on main is named).
  • Measured against main, or Measurements says why there is nothing to measure.
  • No game files, build output or hand-edited generated files; third_party/ untouched; nothing GPL-incompatible.

When it applies

  • A check under tests/ that reads changed source is updated, not weakened.
  • MKWVK_API_VERSION bumped (MkwVkHost or MkwVkRenderer in gpu/vk/vk_api.h changed).
  • Host code builds on Windows (llvm-mingw) and Linux, with UTF-8 paths.
  • Screenshots of the same spot on main and here, for a change that shows on screen.
  • Docs updated.
  • AI assistance recorded with Assisted-by: / Co-Authored-By: trailers.

Ready to merge

  • Everything in Still to test has run, its results in Tested.
  • Tier 1 hardware it can affect is tested (docs/dev/standards.md, "Hardware tiers").
  • Approved in review, every comment answered.
  • CI passes on the head; on current main, measured again or a comment says why the numbers still hold.

🤖 Generated with Claude Code

https://claude.ai/code/session_015KgSKntdRabGivCmhJ63NW

## Summary The pause menu's **System** page shows the game's controller guide: a picture of the pad, its labels and the lines between them. On main it only fits the Switch with its default buttons: pick another face in **Button prompts**, or rebind a button, and the lines still point where the Switch's defaults are (on PS5, the d-pad's line ends on the left stick). **On main:** Button prompts PlayStation 5 (or any face but the Switch's), open the pause menu's System page: the labels and lines are the Switch's, whatever is bound. **Here:** the page is laid out again for the face and the bindings, at start and whenever either changes: each group of labels in one shaded box with one line to its controls; lines orthogonal, as short as they can be, never crossing, jumping another only as a last resort; labels on their controls' side; an input with nothing bound gets no label and no line; the default Switch bindings give the game's own page. Every controller (Switch, Xbox, PS4, PS5, Steam Deck, the keyboard's labels-only page), every language, any resolution. And each row of the Insert menu's Controls page gets a **Reset** (or `R`, the pad's paste button) that puts that row alone back to its default. Read first: `host/prompt_guides.c` (`pg_solve`: groups, sides, routes, the maze); in `host/prompts.c`, `guide_make`, `guide_layout_runs` (the page written into the game's layout) and `guide_texts`; `reset_control` in `gpu/vk/vk_menu.cpp`; `docs/system-guide-lines.md` (the layout data, progress by name, free rows, known limits). Closes #1211. Follows #1623 (closed), its baked first slice. **Before / after** (crazy-0 bindings, PS5 and Xbox): ![Before: main / After: this PR, crazy-0 on PS5 and Xbox](https://git.magicbean.dev/attachments/209e021a-537a-483e-8672-273bc2badc4f) <details><summary>Every set on every controller, resolutions, languages, the keyboard</summary> **Default bindings, all five controllers (the Switch's is the game's own page)** ![default bindings, all five controllers](https://git.magicbean.dev/attachments/6ca7892f-f8db-4c42-a448-b5dd0431e35d) **Upside-down bindings** ![upside-down bindings](https://git.magicbean.dev/attachments/1d27a0ac-ebaa-487f-9b42-1f3624238c98) **Sticks on the face buttons** ![sticks on the face buttons](https://git.magicbean.dev/attachments/0baa1d70-8d0c-4f6f-bcef-395072999aec) **Shoulders on the face buttons** ![shoulders on the face buttons](https://git.magicbean.dev/attachments/23182eb8-9493-4a0a-8f26-2e4ec326a18c) **Crazy-0 (random wild bindings, paddles and guide always bound)** ![crazy-0](https://git.magicbean.dev/attachments/2cc5b222-1971-471e-a083-e9919adf89b8) **Crazy-2** ![crazy-2](https://git.magicbean.dev/attachments/2ca93007-0857-4d09-87ac-e8acb9082faf) **Random-6** ![random-6](https://git.magicbean.dev/attachments/6f3c9392-8dc2-4c26-85e0-074eda483863) **Unbound Y, + and d-pad Left: no label, no line** ![unbound Y, + and d-pad Left](https://git.magicbean.dev/attachments/7bce6e54-f916-433b-acf6-64e1f7a45b16) **Crazy-0 on Xbox and PS5 at 1280x720, 1920x1080, 1920x1200, 2560x1080, 3840x2160** ![resolutions](https://git.magicbean.dev/attachments/41e2ab23-adfd-42cd-ac01-0e2145027246) **Crazy-0 on PS5 in the game's 15 languages** ![languages](https://git.magicbean.dev/attachments/209c4bb8-f441-4196-a9f2-618abdae23dd) **The keyboard's page; the game's own page at 16:10** ![keyboard and 16:10](https://git.magicbean.dev/attachments/5875890f-9717-4034-b733-fc4cf785830c) </details> Known limits (also in the doc): - A locked action keeps its row: the game hides the label (Toggle Accessory before it is unlocked) but its box stays sized for it, so a 4-row box can show 3 labels. Shrinking it needs the save's unlock state when the page is laid out, and where the game keeps it is not found. - B's or X's label moved to the other side shows the wrong action text: the game's code writes their action texts ("Put Away" / "Unequip", "Jump") into fixed panes. - The controller picture was missing twice in 32 runs (lines and labels drawn; both fine when shot again). Cause unknown. - Short vertical stubs at 16:10 (1920x1200): the game's own page has them too (last picture). - A change of face made while the System page is open shows once the pause menu is opened again: until then the page keeps the picture and icons it was opened with, as on main. ## Testing **Tested:** Linux (CachyOS), NVIDIA RTX 3060 Laptop GPU, slot 04 of my save: - This head (89952853, on main @ 9027e737; the row Reset now at API version 37), in the game at 1920x1080 (the System page shot on slot 04): crazy-0 and unbound Y, + and d-pad Left on Xbox at start, each laid out with 0 conflicts and 0 jumps in 37–51 ms; the default bindings changed live to Xbox, then to PS5, the pause menu opened again after each: the page, its picture and its icons follow each face (32–34 ms): ![here @ 89952853: crazy-0 and unbound on Xbox; default after a live change to Xbox, then PS5](https://git.magicbean.dev/attachments/5623b64c-4ca9-4344-b174-a71c8bf16e34) - The head before (709d3a7f, on main @ 3f2c9b3c), after the review's fixes, in the game at 1920x1080 (the System page shot on slot 04): the default bindings on PS5, crazy-0 on Xbox, unbound Y, + and d-pad Left on Switch: each page laid out with 0 conflicts and 0 jumps (`laid out in 50 ms` to `66 ms`), its labels' texts following the page; main @ 3f2c9b3c with crazy-0 on PS5 keeps the Switch's lines: ![main crazy-0 PS5; here: default PS5, crazy-0 Xbox, unbound Switch](https://git.magicbean.dev/attachments/8ea05c4c-1048-4578-9cc9-12ab17b721a0) - Earlier heads (ae5434c5, the same solver): a matrix of 32 game runs, 8 bindings sets × 5 controllers, the keyboard face, 5 resolutions on Xbox and PS5, 15 languages on PS5: every page laid out with 0 conflicts; one needed a jump (Steam Deck, sticks-on-face). The pictures above are from it. - `tests/test_prompt_guides.py` (every face through default, swapped, sticks/shoulders-on-face, crazy and random bindings), `test_pad_layout.py` (a row's Reset, with two cases that fail on the Reset before the review's fix, which left the row with no gamepad input), `test_prompts_live.py`, `test_hos_ab.py`, `test_mods_menu.py`, `test_menu_i18n.py` pass. `mise run test --changed`: 165 checks, 13 fail, each of them failing on main @ 3f2c9b3c too (`test_bug_report_defaults`, `test_crash_dialog`, `test_crt_options`, `test_damage_debug_menu`, `test_dev_ab`, `test_dev_packs`, `test_host_guest_writes`, `test_hud_layout_row`, `test_lift_cache`, `test_mods_size_table`, `test_slow_frames`, `test_upscaler_rows`, `test_walk_key`). - Built for Linux here (the dev pack); Windows (llvm-mingw) by CI on this head. **Still to test:** - Windows, any GPU: Button prompts PlayStation 5, rebind a few buttons on the Controls page, open the System page, expecting the lines to end on the new controls with no crossing (@Beanstalk windows: the System page's guide after rebinding, on PS5). - Steam Deck: Button prompts Steam Deck, the System page with the default bindings and after a Reset of a rebound row, expecting the Deck's page and the row back to its default (by hand: a tester with a Deck). ## Measurements Nothing to measure in play: the page is laid out on a thread of its own when the face or the bindings change, and at the start's loading (logged: `laid out in N ms`: 32 to 66 ms here); the live writes never wait for it. ## Risks The Insert menu's renderer API goes to version 37 (`binding_default`, for the row Reset, after main's `ab_value` at 36): an older host leaves the Reset out. The host writes into the game's live layout data: every run is checked against what was served, and the page stays the game's when a check fails. The Controls page gets a new column. The default Switch bindings keep the game's own page. A revert is enough; nothing changes after updating (saves and longshot_options.ini as they were; the button prompts' cache is made again). ## Checklist ### Ready for review - [x] One topic, on current `main`; the title is a Conventional Commit. - [x] Tested on my own PC, in the game for a change the game runs, as Testing says. - [x] `mise run test` passes (any failure that also fails on `main` is named). - [x] Measured against `main`, or Measurements says why there is nothing to measure. - [x] No game files, build output or hand-edited generated files; `third_party/` untouched; nothing GPL-incompatible. ### When it applies - [x] A check under `tests/` that reads changed source is updated, not weakened. - [x] `MKWVK_API_VERSION` bumped (`MkwVkHost` or `MkwVkRenderer` in `gpu/vk/vk_api.h` changed). - [x] Host code builds on Windows (llvm-mingw) and Linux, with UTF-8 paths. - [x] Screenshots of the same spot on `main` and here, for a change that shows on screen. - [x] Docs updated. - [x] AI assistance recorded with `Assisted-by:` / `Co-Authored-By:` trailers. ### Ready to merge - [ ] Everything in Still to test has run, its results in Tested. - [ ] Tier 1 hardware it can affect is tested (docs/dev/standards.md, "Hardware tiers"). - [ ] Approved in review, every comment answered. - [ ] CI passes on the head; on current `main`, measured again or a comment says why the numbers still hold. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_015KgSKntdRabGivCmhJ63NW
Issue 1211: all five ControllerGuide_Pro textures must follow the face's picture, and every pad input must have a routable part on every face. The keyboard face's key/stick mappings are checked across several binding layouts.

Assisted-by: OpenCode (Hy4 flash Free)
fix(prompts): route all five System guide textures from the face's parts
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 9s
PR description / Description follows the template (pull_request_target) Successful in 11s
Website / Website on Cloudflare (pull_request_target) Has been skipped
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 12s
CI / Workflow lint (actionlint) (pull_request) Successful in 13s
Third-party parts / As their notes say (pull_request) Successful in 14s
b26874ab74
The game has five ControllerGuide_Pro textures; main built two per face. The bumpers, triggers and d-pad frame stayed the game's Pro Controller art, so on PlayStation the d-pad frame sat on the left stick, L1/L2 shared a dot and R2 pointed into empty space, and a live face change mixed the old lines with the new picture. Build all five from each face's parts, keeping the Switch face's images byte-identical. Add the design for the remaining work (per-binding lines for those slots, label placement, keyboard/mouse page).

Assisted-by: OpenCode (Hy4 flash Free)
The System page has ten slots; each needs a line for every pad input, and the browser must pick the bound input's run and write it after the base textures. The keyboard face needs a layout variant that hides the controller and puts the bindings in two columns.

Assisted-by: OpenCode (Hy4 flash Free)
feat(prompts): every System guide follows its binding, plus a keyboard bindings panel
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 9s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 12s
CI / Workflow lint (actionlint) (pull_request) Successful in 14s
Third-party parts / As their notes say (pull_request) Successful in 15s
PR description / Description follows the template (pull_request_target) Successful in 4s
cbb6548f72
GUIDE_PAGES describes all ten System slots. The build writes one line per slot and pad input to guide.bin; host/prompts.c selects the bound one and writes it into Common.bntx after the base runs (fixing the write order that hid the lines). PAGE_LAYOUTS describes generic page variants; the keyboard face's System page moves the controller art off the page and its binding labels into two columns, selected per face at runtime, including after a live change.

Assisted-by: OpenCode (Hy4 flash Free)
test(prompts): harsh rebinding, button maps and line-target heatmaps
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 17s
CI / Conventional Commit title (pull_request) Successful in 16s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 24s
CI / Workflow lint (actionlint) (pull_request) Successful in 27s
Third-party parts / As their notes say (pull_request) Successful in 31s
0de72e14bb
Every control bound to each pad input must still get a line ending on that input, with overlap measured away from the shared target. prompt_assets.py --heatmap writes the invisible button map and per-binding line targets as PNGs for review. The keyboard bindings panel now leaves label groups at their game positions and only shifts the wide key icon panes, so the key box no longer sits on the text. Also plan the F1 menu's per-row reset-to-default button.

Assisted-by: OpenCode (Hy4 flash Free)
docs(prompts): heatmaps for split and converged bindings on every face
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 11s
CI / Workflow lint (actionlint) (pull_request) Successful in 29s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 31s
Third-party parts / As their notes say (pull_request) Successful in 46s
PR description / Description follows the template (pull_request_target) Successful in 19s
7ce4d44d43
The reviewer images now use the same shared avoidance as the build, cover all five controllers and three binding sets (default, aggressive split, all inputs to one stick), and include the game's own Switch guides for comparison.

Assisted-by: OpenCode (Hy4 flash Free)
docs(prompts): label L1/L2/L3 clearly on the button maps
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 15s
PR description / Description follows the template (pull_request_target) Successful in 26s
CI / Workflow lint (actionlint) (pull_request) Successful in 34s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 39s
Third-party parts / As their notes say (pull_request) Successful in 41s
7081b83472
Bumpers and triggers are edge points in parts(), so they now get diamonds, a leader and a large L1/L2/R1/R2 label; sticks get an L3/R3 click label and a legend explains the equivalents.

Assisted-by: OpenCode (Hy4 flash Free)
fix(prompts): emit grouped guide lines under every member's Switch button
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 11s
PR description / Description follows the template (pull_request_target) Successful in 13s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 14s
CI / Workflow lint (actionlint) (pull_request) Successful in 17s
Third-party parts / As their notes say (pull_request) Successful in 22s
f4cc58b02d
The game selects a group's single line by the Switch button of the label it is showing. Emitting it under only one assumed member made the line disagree with the label icon when another member was rebound. Now the d-pad and face-button lines are written for every member, so the runtime picks the matching line for any of them.

Assisted-by: OpenCode (Hy4 flash Free)
docs(prompts): design dynamic group boxes that replace lines
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 9s
PR description / Description follows the template (pull_request_target) Successful in 11s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 16s
CI / Workflow lint (actionlint) (pull_request) Successful in 16s
Third-party parts / As their notes say (pull_request) Successful in 18s
1411b53379
Subset frames keyed by which members are actually bound, for d-pad, face buttons and L1/L2/R1/R2; one box replaces several leaders.

Assisted-by: OpenCode (Hy4 flash Free)
feat(prompts): dynamic group boxes replace individual lines
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 14s
CI / Workflow lint (actionlint) (pull_request) Successful in 23s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 24s
Third-party parts / As their notes say (pull_request) Successful in 27s
PR description / Description follows the template (pull_request_target) Successful in 7s
da0db02953
Build a box for every subset of two or more d-pad, face-button or L1/L2/R1/R2 members, and store it in prompts/<face>/groups.bin keyed by the member mask. The browser computes the mask from the current bindings and writes that box, blanking the individual lines it replaces (and the second label row for the shoulders). A single grouped member keeps its own line. Run selector is covered by a new C-cut test.

Assisted-by: OpenCode (Hy4 flash Free)
fix(prompts): group shoulder labels in one box with two lines
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 8s
PR description / Description follows the template (pull_request_target) Successful in 10s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 12s
CI / Workflow lint (actionlint) (pull_request) Successful in 13s
Third-party parts / As their notes say (pull_request) Successful in 15s
b251cac26a
The shoulder pair now draws a single bracket around the two label rows in the guide texture, with one line from it to each of the bumper and trigger, instead of two separate label boxes. The earlier controller-side shoulder box is removed.

Assisted-by: OpenCode (Hy4 flash Free)
Replace baked guide images with a host geometry API and an ImGui overlay in the menu, so boxes and lines follow the face, bindings and layout at run time. Records the group rules from the review.

Assisted-by: OpenCode (Hy4 flash Free)
lines.bin holds parts in guide pixels and one polyline per slot/pad input, not pixels. host/prompts.c turns those into layout-space boxes and lines from the current bindings: one box and one line for a group of two or more, a direct line for a single or outside member. A C-cut test checks the selector.

Assisted-by: OpenCode (Hy4 flash Free)
feat(vk): draw System guide lines at run time
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 8s
PR description / Description follows the template (pull_request_target) Successful in 9s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 11s
CI / Workflow lint (actionlint) (pull_request) Successful in 12s
Third-party parts / As their notes say (pull_request) Successful in 13s
Website / Website on Cloudflare (pull_request_target) Has been skipped
95607cfe95
Adds a host geometry API (MKWVK_API_VERSION 34), HPLN data emitted instead of baked guide/groups images for drawn faces, and an opt-in ImGui overlay (HOS_GUIDE_OVERLAY=1) that draws one box and one line per group from the current bindings. Switch keeps its game textures. First in-game proof works; alignment and the shoulder label brackets still need tuning.

Assisted-by: OpenCode (Hy4 flash Free)
Author
Member

Tested in game: Linux, Radeon 680M (RADV), 1280x720, headless: HOS_GUIDE_OVERLAY=1 draws the System page's guide lines and group boxes from current bindings over the game's page; PS5 and Xbox faces reached, no crash.

Tested in game: Linux, Radeon 680M (RADV), 1280x720, headless: HOS_GUIDE_OVERLAY=1 draws the System page's guide lines and group boxes from current bindings over the game's page; PS5 and Xbox faces reached, no crash.
Member

Possibly related, for context:

  • issue #1211 Game: the System page's controller lines don't follow the controller or its mapping (PS5: the d-pad's line ends on the left stick) — Open issue addressed: System-page guides follow controller and bindings
  • PR #1589 feat(prompts): hand-drawn DualSense and Xbox pictures for the System page, and the game's own tint — Merged predecessor: System-page guide and controller assets
Possibly related, for context: - issue #1211 Game: the System page's controller lines don't follow the controller or its mapping (PS5: the d-pad's line ends on the left stick) — Open issue addressed: System-page guides follow controller and bindings - PR #1589 feat(prompts): hand-drawn DualSense and Xbox pictures for the System page, and the game's own tint — Merged predecessor: System-page guide and controller assets
Author
Member

First in-game proof

PS5 face, System page, 1280x720 headless with HOS_GUIDE_OVERLAY=1 RX_VK_SHOT_MENU=1:

Run-time drawn guide lines

The white lines and green boxes are drawn by the renderer overlay from lines.bin and the current bindings; the game's baked guide lines are no longer written for this face (prompts: ps5 textures, 1907 runs instead of 6572 with the baked templates). The host logged guide overlay: n=8 for this state.

Known rough edges in this first commit: the layout-to-screen fit is derived from two 720p sample points (so check 4K/ultrawide), the shoulder group produces a degenerate box (the long green line near the top), and the group boxes are still controller-side rather than brackets around the label rows. Those are the next changes on this branch.

## First in-game proof PS5 face, System page, 1280x720 headless with `HOS_GUIDE_OVERLAY=1 RX_VK_SHOT_MENU=1`: ![Run-time drawn guide lines](https://git.magicbean.dev/attachments/e223ef04-8695-4ddb-8dd8-81dd190a7172) The white lines and green boxes are drawn by the renderer overlay from `lines.bin` and the current bindings; the game's baked guide lines are no longer written for this face (`prompts: ps5 textures, 1907 runs` instead of 6572 with the baked templates). The host logged `guide overlay: n=8` for this state. Known rough edges in this first commit: the layout-to-screen fit is derived from two 720p sample points (so check 4K/ultrawide), the shoulder group produces a degenerate box (the long green line near the top), and the group boxes are still controller-side rather than brackets around the label rows. Those are the next changes on this branch.
gab9281 force-pushed dynamic/system-guide-lines from 95607cfe95
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 8s
PR description / Description follows the template (pull_request_target) Successful in 9s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 11s
CI / Workflow lint (actionlint) (pull_request) Successful in 12s
Third-party parts / As their notes say (pull_request) Successful in 13s
Website / Website on Cloudflare (pull_request_target) Has been skipped
to ae5434c588
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 7s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 13s
CI / Workflow lint (actionlint) (pull_request) Successful in 14s
Third-party parts / As their notes say (pull_request) Successful in 17s
PR description / Description follows the template (pull_request_target) Successful in 4s
2026-11-20 05:11:25 +00:00
Compare
gab9281 changed title from WIP: feat(vk): draw System guide lines at run time to WIP: feat(prompts): the System page's guide follows every controller and binding (#1211) 2026-11-20 05:12:19 +00:00
Author
Member

Rewritten and rebased onto main @ 0de25c3e (force push; the old run-time overlay head 95607cfe is kept on my side).

This branch now lays out the System page itself instead of drawing an overlay, so the description is new. In short:

  • one box and one line per group;
  • every controller, binding, language and resolution;
  • unbound inputs get no label and no line;
  • a Reset on each Controls row.

The work is squashed into four commits: the Reset, the solver, the page in the game, and the docs.

Rebase notes:

  • The Reset's binding_default moved to API version 36, because main took 35 for the Mods tab.
  • Its face-button tables moved to gpu/vk/menu/bindings.cpp, after #1774.

Main doesn't build on Linux at 0de25c3e. gpu/vk/menu/pipeline_list.cpp is missing its POSIX headers since #1774. #1807 fixes that, and I applied its headers locally to build and test this. They are not in this PR.

Tests:

  • tests/run_all.py: every failure also fails on main.
  • In game after the rebase: 0 conflicts.
  • A 32-run screenshot matrix, in the description.

Still a draft: see the known limits.

**Rewritten and rebased onto main @ 0de25c3e** (force push; the old run-time overlay head 95607cfe is kept on my side). This branch now lays out the System page itself instead of drawing an overlay, so the description is new. In short: - one box and one line per group; - every controller, binding, language and resolution; - unbound inputs get no label and no line; - a Reset on each Controls row. The work is squashed into four commits: the Reset, the solver, the page in the game, and the docs. Rebase notes: - The Reset's `binding_default` moved to **API version 36**, because main took 35 for the Mods tab. - Its face-button tables moved to `gpu/vk/menu/bindings.cpp`, after #1774. **Main doesn't build on Linux at 0de25c3e.** `gpu/vk/menu/pipeline_list.cpp` is missing its POSIX headers since #1774. #1807 fixes that, and I applied its headers locally to build and test this. They are not in this PR. Tests: - `tests/run_all.py`: every failure also fails on main. - In game after the rebase: 0 conflicts. - A 32-run screenshot matrix, in the description. Still a draft: see the known limits.
gab9281 force-pushed dynamic/system-guide-lines from ae5434c588
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 7s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 13s
CI / Workflow lint (actionlint) (pull_request) Successful in 14s
Third-party parts / As their notes say (pull_request) Successful in 17s
PR description / Description follows the template (pull_request_target) Successful in 4s
to 709d3a7fb9
Some checks failed
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 10s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 26s
CI / Workflow lint (actionlint) (pull_request) Successful in 30s
Third-party parts / As their notes say (pull_request) Successful in 32s
PR description / Description follows the template (pull_request_target) Successful in 5s
Website / Website on Cloudflare (pull_request_target) Has been skipped
CI / Website build and checks (pull_request) Has been cancelled
2026-11-20 14:14:26 +00:00
Compare
Author
Member

Rebased on main @ 3f2c9b3c (no conflicts), a review pass, and the description on the new template. Still WIP until CI passes.

Review fixes (709d3a7f):

  • A row's Reset never leaves it without a gamepad input. Two new test cases fail on the Reset as it was.
  • The live writes never wait for the page being made: they run in the game's controller read.
  • A page kept is replaced in place, so an index in use stays valid.
  • Common.bntx's cache key includes the lines as drawn.
  • The page's texts follow the page its panes show.
  • Each action label is the one closest to the table's first, never another file's of the same name.
  • A side's spacing comes from the icons its panes show.
  • A maze line with too many corners is no line at all, not one cut short on a slant.
  • A piece with no room left counts as a conflict.

In the game at this head, the default bindings on PS5, crazy-0 on Xbox and unbound on Switch each laid out with 0 conflicts and 0 jumps, in 50–66 ms:

main crazy-0 PS5; here: default PS5, crazy-0 Xbox, unbound Switch

**Rebased on main @ 3f2c9b3c (no conflicts), a review pass, and the description on the new template.** Still WIP until CI passes. Review fixes (709d3a7f): - A row's Reset never leaves it without a gamepad input. Two new test cases fail on the Reset as it was. - The live writes never wait for the page being made: they run in the game's controller read. - A page kept is replaced in place, so an index in use stays valid. - Common.bntx's cache key includes the lines as drawn. - The page's texts follow the page its panes show. - Each action label is the one closest to the table's first, never another file's of the same name. - A side's spacing comes from the icons its panes show. - A maze line with too many corners is no line at all, not one cut short on a slant. - A piece with no room left counts as a conflict. In the game at this head, the default bindings on PS5, crazy-0 on Xbox and unbound on Switch each laid out with 0 conflicts and 0 jumps, in 50–66 ms: ![main crazy-0 PS5; here: default PS5, crazy-0 Xbox, unbound Switch](https://git.magicbean.dev/attachments/8ea05c4c-1048-4578-9cc9-12ab17b721a0)
gab9281 changed title from WIP: feat(prompts): the System page's guide follows every controller and binding (#1211) to feat(prompts): the System page's guide follows every controller and binding (#1211) 2026-11-20 14:40:03 +00:00
gab9281 force-pushed dynamic/system-guide-lines from 709d3a7fb9
Some checks failed
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 10s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 26s
CI / Workflow lint (actionlint) (pull_request) Successful in 30s
Third-party parts / As their notes say (pull_request) Successful in 32s
PR description / Description follows the template (pull_request_target) Successful in 5s
Website / Website on Cloudflare (pull_request_target) Has been skipped
CI / Website build and checks (pull_request) Has been cancelled
to 89952853b7
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 20s
PR description / Description follows the template (pull_request_target) Successful in 19s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 29s
CI / Workflow lint (actionlint) (pull_request) Successful in 31s
Third-party parts / As their notes say (pull_request) Successful in 31s
beanstalk/approval can't be tested as asked: see the farm's comment
CI / Website build and checks (pull_request) Failing after 3m10s
2026-11-20 16:20:01 +00:00
Compare
Author
Member

Rebased on main @ 9027e737. Main's #1846 took the renderer API's version 36 for its ab_value, so the Controls page's row Reset (binding_default) moves to version 37, after it: vk_api.h, rx_backend.c, can_reset_control and the two tests that read the table (test_hos_ab.py, test_pad_layout.py). Nothing else conflicted.

The PR's own tests pass on this head (test_hos_ab, test_pad_layout, test_prompt_guides, test_prompts_live, test_mods_menu, test_menu_i18n). In the game, from a dev base of main @ 9027e737: crazy-0 and unbound on Xbox laid out with 0 conflicts and 0 jumps. With the default bindings, a live change to Xbox and then to PS5 shows each face's page once the pause menu is opened again. While the page stays open it keeps the picture it was opened with; main @ 9027e737 and @ 3f2c9b3c do the same, so it's listed in the known limits.

here @ 89952853: crazy-0 and unbound on Xbox; default after a live change to Xbox, then PS5

**Rebased on main @ 9027e737.** Main's #1846 took the renderer API's version 36 for its `ab_value`, so the Controls page's row Reset (`binding_default`) moves to version 37, after it: `vk_api.h`, `rx_backend.c`, `can_reset_control` and the two tests that read the table (`test_hos_ab.py`, `test_pad_layout.py`). Nothing else conflicted. The PR's own tests pass on this head (`test_hos_ab`, `test_pad_layout`, `test_prompt_guides`, `test_prompts_live`, `test_mods_menu`, `test_menu_i18n`). In the game, from a dev base of main @ 9027e737: crazy-0 and unbound on Xbox laid out with 0 conflicts and 0 jumps. With the default bindings, a live change to Xbox and then to PS5 shows each face's page once the pause menu is opened again. While the page stays open it keeps the picture it was opened with; main @ 9027e737 and @ 3f2c9b3c do the same, so it's listed in the known limits. ![here @ 89952853: crazy-0 and unbound on Xbox; default after a live change to Xbox, then PS5](https://git.magicbean.dev/attachments/5623b64c-4ca9-4344-b174-a71c8bf16e34)
Author
Member

@Beanstalk windows (any GPU): set Button prompts to PlayStation 5 and rebind a few buttons on the Controls page (for example A to Square and B to R1). Then open the pause menu's System page and take a screenshot. Expected: the controller picture's guide lines end on the new controls, each line on its own button with no lines crossing, and each row's label names the right button. Then set Button prompts back to Auto, reset the rebound rows, and take the same screenshot: the lines are back on the default buttons.

@Beanstalk windows (any GPU): set Button prompts to PlayStation 5 and rebind a few buttons on the Controls page (for example A to Square and B to R1). Then open the pause menu's System page and take a screenshot. Expected: the controller picture's guide lines end on the new controls, each line on its own button with no lines crossing, and each row's label names the right button. Then set Button prompts back to Auto, reset the rebound rows, and take the same screenshot: the lines are back on the default buttons.
Member

Beanstalk test farm · ⛔ can't be tested as asked

Commit 8995285 · approved by gab9281 (untrusted) · dashboard

Not run: the farm can't test this as asked, so nothing is built or run:

The requested test requires rebinding raw controller inputs and resetting individual Controls rows, which the farm's plan steps cannot set directly or reliably automate on both builds. The alternative can smoke-test gameplay with PS5 prompts, but cannot judge the rebound or reset System-page guides.

⚠️ Note: A screenshot comparison against main cannot by itself establish that the intentionally changed guide lines and labels are correct.

What it could test instead: The alternative plan runs on Windows with PlayStation 5 button prompts and captures a gameplay image in Kokiri Forest, comparing it with main. It takes about 10 minutes and fails on a crash or a substantial screenshot difference. It does not exercise the requested System-page rebinding and reset checks.

A member of BigBeans can comment @Beanstalk <new words> to ask for something else, or @Beanstalk test it anyway to run the plan regardless.

<!-- beanstalk:sticky --> ### Beanstalk test farm · ⛔ can't be tested as asked Commit `8995285` · approved by gab9281 (untrusted) · [dashboard](https://beanstalk.magicbean.dev/prs/1700) **Not run: the farm can't test this as asked**, so nothing is built or run: > The requested test requires rebinding raw controller inputs and resetting individual Controls rows, which the farm's plan steps cannot set directly or reliably automate on both builds. The alternative can smoke-test gameplay with PS5 prompts, but cannot judge the rebound or reset System-page guides. ⚠️ **Note:** A screenshot comparison against main cannot by itself establish that the intentionally changed guide lines and labels are correct. What it could test instead: The alternative plan runs on Windows with PlayStation 5 button prompts and captures a gameplay image in Kokiri Forest, comparing it with main. It takes about 10 minutes and fails on a crash or a substantial screenshot difference. It does not exercise the requested System-page rebinding and reset checks. A member of `BigBeans` can comment `@Beanstalk <new words>` to ask for something else, or `@Beanstalk test it anyway` to run the plan regardless.
Some checks failed
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been skipped
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been skipped
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been skipped
Third-party parts / The same as upstream (pull_request) Has been skipped
Website / Website on Cloudflare (pull_request) Has been skipped
CI / Conventional Commit title (pull_request) Successful in 20s
PR description / Description follows the template (pull_request_target) Successful in 19s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 29s
CI / Workflow lint (actionlint) (pull_request) Successful in 31s
Third-party parts / As their notes say (pull_request) Successful in 31s
beanstalk/approval can't be tested as asked: see the farm's comment
CI / Website build and checks (pull_request) Failing after 3m10s
This pull request has changes conflicting with the target branch.
  • gpu/vk/vk_api.h
  • gpu/vk/vk_menu.cpp
  • host/prompts.c
  • host/rx_backend.c
  • tests/test_hos_ab.py
View command line instructions

Manual merge helper

Use this merge commit message when completing the merge manually.

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 'dynamic/system-guide-lines:gab9281-dynamic/system-guide-lines'
git switch 'gab9281-dynamic/system-guide-lines'
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!1700
No description provided.