feat(input): a minimap toggle button, with the choice kept #711

Open
kendowashere wants to merge 3 commits from kendowashere/Longshot:feat/minimap-toggle into main
First-time contributor

Type: feat · Risk: low · Tested on: Windows 11, RTX 5070 Ti, DualSense · Needs: Linux, any GPU

Why

The game ties the minimap to the In-Game Interface option. Normal shows it, along with the rest of the busier HUD. Pro and Master hide it along with everything else. Nothing gives you Pro's clean screen with a minimap, or Normal without one, and switching means going into the options each time. This adds a button for it. It is a port of the minimap toggle in NX2navi, a static recompilation of the same game build: https://github.com/tangerineturtle1/NX2navi/pull/870. No issue on the tracker fits (searched for minimap).

What changed

The Controls tab gets a Minimap button row. With it on D-pad down, holding the button for a quarter of a second during gameplay shows or hides the minimap whatever the In-Game Interface option says, and the choice is kept. A tap still does what the game gives D-pad down (changing boots). The minimap is a screen of the game's own, so hiding clears its drawn byte and showing sets it (and opens it when the game left it closed), without touching the pause menu's map.

  • New row on the Controls tab, live: Minimap button, Off (the default) or D-pad down.
    • A hold of D-pad down (0.25 s) shows or hides the minimap during gameplay, whatever the interface option does with it, starting from what is on screen.
    • A shorter tap goes to the game: D-pad down is the game's boots button, so taking the press outright (as NX2navi does) cost the boots their button. The press is kept from the game while it might still be a hold; on release it is handed to the game, shown held for 100 ms over several of its reads (press_step, HOLD_NS, TAP_NS). A menu or event that starts during the hold hands the press to the game. A boots change therefore lands when the button is let go rather than when it is pressed.
    • The choice is kept in the options file as minimap= (0 the game's own until the first press, then 1 shown or 2 hidden). It has no row of its own, because the button is how it is changed.
    • Off gives the minimap back to the game, whatever minimap= holds.
  • host/oot_minimap.c: the minimap is the screen MapMenu_00 in its small form (+0x2350, the IsMiniMap that SeqOneShotOpenMapMenu writes). The pause menu's map is the same screen in its large form and is never touched. The screen is found through the game's own lookup (f_80b45cd0, screen manager **0x84c9e098).
    • Hidden clears the screen's drawn byte +0x1a8, the one SeqOneShotSetScreenVisible writes. The screen still opens and closes as the game asks, so nothing that waits on its state changes.
    • Shown sets that byte. When the game leaves the screen closed during gameplay (Pro never opens it), it opens the screen in its small form the way SeqOneShotOpenMapMenu does (vtable +0x28). It only does so after 20 consecutive reads of gameplay with the screen closed, so it is never opened behind a menu or a cutscene the game is going into.
    • Events: during an event, which the game's own SeqQueryIsEventRunning reports (event manager **0x84c9e090 +0x68), the minimap is never opened, and one this file opened is closed with vtable +0x30. The Pro interface would otherwise leave it up through conversations, where Link's update keeps running. A press during an event goes to the game.
    • The game's own (or the button Off) touches nothing, apart from restoring what this file changed.
  • Gameplay detection (nx2/oot_patches.py patch_minimap_link): one call at the top of Link's movement update (f_804caa80) records that the update ran. A hold counts only while that update runs. In menus, cutscenes and loads the button keeps its role. During gameplay a press is kept from the game until it is either a hold (the minimap's) or released as a tap (the game's).
  • Also changed: host/nn_hid.c (npad_states calls hos_minimap_buttons on the first controller's read), gpu/vk/menu/minimap.cpp (the row, a module since #1633), gpu/vk/vk_menu.cpp (the kept choice), vk_menu.h, vk_replay.cpp, vk_api.h (the row, the kept choice and the host's view of them: option ids 90 and 91, which no open pull request uses), gpu/vk/menu_i18n.h (the row's texts in all 13 languages), docs/user/graphics-and-controls.md, and tests/test_input_background.py (its stub of the controller read).

Measurements

Verdict: nothing to measure: an input feature that is off by default; with the button Off the controller read returns after one option lookup and a read of the event manager's state.

Flags and settings

One new menu row (the ini key minimap_button) and one kept choice that has no row (the ini line minimap); no switch and no build flag. The player guide's settings table lists the row.

Flag What it is Before this PR After this PR Effect Helps / doesn't help / untested Recommendation
Minimap button (minimap_button, id 91) Off or D-pad down none Off A 0.25 s hold of D-pad down shows or hides the minimap in gameplay; a tap is the game's (boots) Helps: Pro players who want a minimap, Normal players who want none. Untested: Linux, Steam Deck Off by default: with it on, a tap of D-pad down reaches the game on release instead of on press
minimap (id 90, no row) What the button last chose: 0 the game's own, 1 shown, 2 hidden none 0 Used only while the button is on D-pad down - Set by the button

Testing

Tested:

  • Game-free: tests/test_minimap.py (new) applies the patch to a fixture of Link's movement update (once, and again unchanged; I also applied it by hand to the real lifted f_804caa80 of a build), and checks that the button and the kept choice reach the host, that the options file writes and reads minimap= (with the key owned by save()), that the button off leaves the minimap to the game, and that the Minimap button is the only row. With a C compiler (--cc, which run_all.py passes) it also cuts press_step out of host/oot_minimap.c with its HOLD_NS/TAP_NS as they are there, and runs it at a 4 ms read rate: a tap never switches the minimap and reaches the game after release, a hold switches it exactly once and never reaches the game, outside gameplay the button is the game's untouched, and a menu opening during a hold hands it to the game. It fails with the tap handoff removed and with a 900 ms hold (both tried). tests/test_minimap.py --cc gcc passes on this branch's head, a43db600. python -I -B tests/run_all.py on this branch (1575bf72) on main @ a8a30c22: 580 passed, 25 failed, 41 skipped. A clean main @ a8a30c22 on this PC, run at the same time: 579 passed, 25 failed, 41 skipped. The same 24 fail on both: test_appimage_player_build, test_auto_handheld, test_cpp_preflight, test_crash_dialog, test_crt_options, test_env_on, test_fsr_uniform_ownership, test_lift_cleanup_error, test_linux_preflight, test_make_game_cache, test_make_game_prepare, test_missing_nup, test_options_budget_once, test_pads_after_menu, test_parallel_init_order, test_portable_builder_home, test_portable_builder_startup, test_readback_late, test_replay_write_order, test_run_all_changed, test_tested_configurations, test_vk_occlusion_queries, test_vk_pgo, test_walk_key. The 25th differed between the runs (test_fallback_buffer_cleanup on the branch, test_invalidate_vcore on main); each passes when run alone on both trees.
  • In the game: Windows 11 Pro, GeForce RTX 5070 Ti (NVIDIA 621.24), a DualSense through SDL, a pack of this branch (together with a separate gyro branch) built on main @ 6c9edffe, before the rebase onto e090cc48, which touches none of this branch's files. The Minimap button was set to D-pad down and pressed in gameplay: it shows and hides the minimap as intended (it works well), and the choice is kept: longshot_options.ini went from the game's own to hidden and then to shown.
  • In the game, the hold (same PC, a DLSS pack of this commit's change on main @ 6c9edffe together with my other branches): a tap of D-pad down changes boots, and a hold of a quarter of a second shows or hides the minimap. An earlier 0.4 s hold also worked but was slow for quick boot changes.
  • Linux, compiler only: host/oot_minimap.c and host/nn_hid.c compile for a Linux target (clang -fsyntax-only against the Linux sysroot's own headers and host/posix's compatibility layer, on a build tree with both of my branches merged). The same check passes on untouched host files and fails without host/posix, so it can tell. That is not a Linux build, link or run: the renderer's C++ files and the shader and game build were not compiled for Linux.

Not tested: these cases were not checked one by one in the run above: the result under each interface option (Normal and Pro), that the pause menu's map still draws after hiding it on Pro, the conversation and cutscene cases, the forced open on Pro, and Linux and a Steam Deck. Their logic is in the game-free test only against a stand-in. The Test Farm can't check them: its settings registry (Beanstalk's menu_options.py, generated from main's gpu/vk/vk_menu.cpp) has no Minimap button row until this PR merges, so a farm run can't bind the button, and a show or hide writes no log line it could match. A farm result on this PR is build and start evidence only, not evidence of the button's behavior.

Must be tested:

  • Windows, any GPU, by hand: In-Game Interface on Normal: Minimap button D-pad down, hold it for a quarter of a second in the field, expecting the minimap to vanish and the rest of the HUD to stay; hold again, expecting it back; tap it, expecting the boots to change and the minimap to stay as it is. Then the same on Pro, expecting a hold of D-pad down to bring a minimap up. Open the pause menu after hiding it on Pro, expecting the big map to draw normally; run into a conversation and a cutscene, expecting the minimap to be hidden as the game does and back as chosen afterwards.
  • Linux, any GPU, Test Farm (build only): build this branch and start the game with the Minimap button at its default, Off, expecting it to build, start and reach gameplay. This is the evidence for the Linux build box and nothing more: the farm can't set the row (see Not tested).
  • Linux, any GPU, a tester by hand (behavior): Controls tab, Minimap button on D-pad down. With In-Game Interface on Normal, in the field: a short tap of D-pad down, expecting the boots to change and the minimap to stay as it is; a hold of about half a second, expecting the minimap to hide; another hold, expecting it back. Then the same tap and holds on Pro, where the first hold should bring a minimap up. Pass: all four (tap and hold, Normal and Pro) as described.

Screenshots

After: this PR (a pack of this branch built on main @ 6c9edffe, before the rebase onto e090cc48): the Controls tab's new Minimap button row on D-pad down, with its help text.

After: this PR, the Controls tab's Minimap button row on D-pad down

After: this PR, the same build: the minimap on screen in the Ice Cavern with the Minimap button on D-pad down.

After: this PR, the minimap on screen in the Ice Cavern with the Minimap button on D-pad down

Risks

What could break: the controller read now calls hos_minimap_buttons on every read of the first controller, and Link's movement update calls the host once a frame. With the button Off both do almost nothing. With it on, the read calls the game's own screen lookup (f_80b45cd0) from the game's thread, as the game itself does when it opens the screen. A wrong gameplay test would only make a press go to the game as it does today, or open the minimap late.

Turning it off: Minimap button Off (the default), or revert the commit.

Compatibility: the options file gains two lines, minimap_button and minimap (an older file reads the defaults). The player's next build translates the game again because the lifted function changes, as for any change to nx2/oot_patches.py. The shader and pipeline caches and MKWVK_API_VERSION are untouched (the option ids are new HOS_OPT_* numbers and no struct changed, as when the earlier options such as HOS_OPT_HOLD_TOGGLE were added).

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. Not ticked yet: Risks states extra per-frame and controller-read calls when the button is on, with no timing given.
  • 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).
  • 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.
  • Switches documented (docs/development.md; the player guide 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 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. (Open: built on Windows; for Linux only the host files were compile-checked, see Testing; Linux build asked of the Test Farm, as build evidence only; the button's behavior on Linux is for a tester by hand, see Must be tested.)
  • Docs updated.
**Type:** feat · **Risk:** low · **Tested on:** Windows 11, RTX 5070 Ti, DualSense · **Needs:** Linux, any GPU ## Why The game ties the minimap to the In-Game Interface option. Normal shows it, along with the rest of the busier HUD. Pro and Master hide it along with everything else. Nothing gives you Pro's clean screen with a minimap, or Normal without one, and switching means going into the options each time. This adds a button for it. It is a port of the minimap toggle in NX2navi, a static recompilation of the same game build: https://github.com/tangerineturtle1/NX2navi/pull/870. No issue on the tracker fits (searched for minimap). ## What changed The Controls tab gets a **Minimap button** row. With it on D-pad down, holding the button for a quarter of a second during gameplay shows or hides the minimap whatever the In-Game Interface option says, and the choice is kept. A tap still does what the game gives D-pad down (changing boots). The minimap is a screen of the game's own, so hiding clears its drawn byte and showing sets it (and opens it when the game left it closed), without touching the pause menu's map. - **New row on the Controls tab, live:** **Minimap button**, Off (the default) or D-pad down. - A hold of D-pad down (0.25 s) shows or hides the minimap during gameplay, whatever the interface option does with it, starting from what is on screen. - A shorter tap goes to the game: D-pad down is the game's boots button, so taking the press outright (as NX2navi does) cost the boots their button. The press is kept from the game while it might still be a hold; on release it is handed to the game, shown held for 100 ms over several of its reads (`press_step`, `HOLD_NS`, `TAP_NS`). A menu or event that starts during the hold hands the press to the game. A boots change therefore lands when the button is let go rather than when it is pressed. - The choice is kept in the options file as `minimap=` (0 the game's own until the first press, then 1 shown or 2 hidden). It has no row of its own, because the button is how it is changed. - Off gives the minimap back to the game, whatever `minimap=` holds. - **`host/oot_minimap.c`:** the minimap is the screen `MapMenu_00` in its small form (`+0x2350`, the IsMiniMap that `SeqOneShotOpenMapMenu` writes). The pause menu's map is the same screen in its large form and is never touched. The screen is found through the game's own lookup (`f_80b45cd0`, screen manager `**0x84c9e098`). - Hidden clears the screen's drawn byte `+0x1a8`, the one `SeqOneShotSetScreenVisible` writes. The screen still opens and closes as the game asks, so nothing that waits on its state changes. - Shown sets that byte. When the game leaves the screen closed during gameplay (Pro never opens it), it opens the screen in its small form the way `SeqOneShotOpenMapMenu` does (vtable `+0x28`). It only does so after 20 consecutive reads of gameplay with the screen closed, so it is never opened behind a menu or a cutscene the game is going into. - **Events:** during an event, which the game's own `SeqQueryIsEventRunning` reports (event manager `**0x84c9e090` `+0x68`), the minimap is never opened, and one this file opened is closed with vtable `+0x30`. The Pro interface would otherwise leave it up through conversations, where Link's update keeps running. A press during an event goes to the game. - The game's own (or the button Off) touches nothing, apart from restoring what this file changed. - **Gameplay detection** (`nx2/oot_patches.py` `patch_minimap_link`): one call at the top of Link's movement update (`f_804caa80`) records that the update ran. A hold counts only while that update runs. In menus, cutscenes and loads the button keeps its role. During gameplay a press is kept from the game until it is either a hold (the minimap's) or released as a tap (the game's). - **Also changed:** `host/nn_hid.c` (`npad_states` calls `hos_minimap_buttons` on the first controller's read), `gpu/vk/menu/minimap.cpp` (the row, a module since #1633), `gpu/vk/vk_menu.cpp` (the kept choice), `vk_menu.h`, `vk_replay.cpp`, `vk_api.h` (the row, the kept choice and the host's view of them: option ids 90 and 91, which no open pull request uses), `gpu/vk/menu_i18n.h` (the row's texts in all 13 languages), `docs/user/graphics-and-controls.md`, and `tests/test_input_background.py` (its stub of the controller read). ## Measurements **Verdict:** nothing to measure: an input feature that is off by default; with the button Off the controller read returns after one option lookup and a read of the event manager's state. ### Flags and settings One new menu row (the ini key `minimap_button`) and one kept choice that has no row (the ini line `minimap`); no switch and no build flag. The player guide's settings table lists the row. | Flag | What it is | Before this PR | After this PR | Effect | Helps / doesn't help / untested | Recommendation | |---|---|---|---|---|---|---| | Minimap button (`minimap_button`, id 91) | Off or D-pad down | none | Off | A 0.25 s hold of D-pad down shows or hides the minimap in gameplay; a tap is the game's (boots) | Helps: Pro players who want a minimap, Normal players who want none. Untested: Linux, Steam Deck | Off by default: with it on, a tap of D-pad down reaches the game on release instead of on press | | `minimap` (id 90, no row) | What the button last chose: 0 the game's own, 1 shown, 2 hidden | none | 0 | Used only while the button is on D-pad down | - | Set by the button | ## Testing **Tested:** - Game-free: `tests/test_minimap.py` (new) applies the patch to a fixture of Link's movement update (once, and again unchanged; I also applied it by hand to the real lifted `f_804caa80` of a build), and checks that the button and the kept choice reach the host, that the options file writes and reads `minimap=` (with the key owned by `save()`), that the button off leaves the minimap to the game, and that the Minimap button is the only row. With a C compiler (`--cc`, which `run_all.py` passes) it also cuts `press_step` out of `host/oot_minimap.c` with its `HOLD_NS`/`TAP_NS` as they are there, and runs it at a 4 ms read rate: a tap never switches the minimap and reaches the game after release, a hold switches it exactly once and never reaches the game, outside gameplay the button is the game's untouched, and a menu opening during a hold hands it to the game. It fails with the tap handoff removed and with a 900 ms hold (both tried). `tests/test_minimap.py --cc gcc` passes on this branch's head, a43db600. `python -I -B tests/run_all.py` on this branch (1575bf72) on `main` @ a8a30c22: 580 passed, 25 failed, 41 skipped. A clean `main` @ a8a30c22 on this PC, run at the same time: 579 passed, 25 failed, 41 skipped. The same 24 fail on both: `test_appimage_player_build`, `test_auto_handheld`, `test_cpp_preflight`, `test_crash_dialog`, `test_crt_options`, `test_env_on`, `test_fsr_uniform_ownership`, `test_lift_cleanup_error`, `test_linux_preflight`, `test_make_game_cache`, `test_make_game_prepare`, `test_missing_nup`, `test_options_budget_once`, `test_pads_after_menu`, `test_parallel_init_order`, `test_portable_builder_home`, `test_portable_builder_startup`, `test_readback_late`, `test_replay_write_order`, `test_run_all_changed`, `test_tested_configurations`, `test_vk_occlusion_queries`, `test_vk_pgo`, `test_walk_key`. The 25th differed between the runs (`test_fallback_buffer_cleanup` on the branch, `test_invalidate_vcore` on `main`); each passes when run alone on both trees. - In the game: Windows 11 Pro, GeForce RTX 5070 Ti (NVIDIA 621.24), a DualSense through SDL, a pack of this branch (together with a separate gyro branch) built on `main` @ 6c9edffe, before the rebase onto e090cc48, which touches none of this branch's files. The Minimap button was set to D-pad down and pressed in gameplay: it shows and hides the minimap as intended (it works well), and the choice is kept: `longshot_options.ini` went from the game's own to hidden and then to shown. - In the game, the hold (same PC, a DLSS pack of this commit's change on `main` @ 6c9edffe together with my other branches): a tap of D-pad down changes boots, and a hold of a quarter of a second shows or hides the minimap. An earlier 0.4 s hold also worked but was slow for quick boot changes. - Linux, compiler only: `host/oot_minimap.c` and `host/nn_hid.c` compile for a Linux target (clang `-fsyntax-only` against the Linux sysroot's own headers and `host/posix`'s compatibility layer, on a build tree with both of my branches merged). The same check passes on untouched host files and fails without `host/posix`, so it can tell. That is not a Linux build, link or run: the renderer's C++ files and the shader and game build were not compiled for Linux. **Not tested:** these cases were not checked one by one in the run above: the result under each interface option (Normal and Pro), that the pause menu's map still draws after hiding it on Pro, the conversation and cutscene cases, the forced open on Pro, and Linux and a Steam Deck. Their logic is in the game-free test only against a stand-in. The Test Farm can't check them: its settings registry (Beanstalk's `menu_options.py`, generated from `main`'s `gpu/vk/vk_menu.cpp`) has no Minimap button row until this PR merges, so a farm run can't bind the button, and a show or hide writes no log line it could match. A farm result on this PR is build and start evidence only, not evidence of the button's behavior. **Must be tested:** - Windows, any GPU, by hand: In-Game Interface on Normal: Minimap button D-pad down, hold it for a quarter of a second in the field, expecting the minimap to vanish and the rest of the HUD to stay; hold again, expecting it back; tap it, expecting the boots to change and the minimap to stay as it is. Then the same on Pro, expecting a hold of D-pad down to bring a minimap up. Open the pause menu after hiding it on Pro, expecting the big map to draw normally; run into a conversation and a cutscene, expecting the minimap to be hidden as the game does and back as chosen afterwards. - Linux, any GPU, Test Farm (build only): build this branch and start the game with the Minimap button at its default, Off, expecting it to build, start and reach gameplay. This is the evidence for the Linux build box and nothing more: the farm can't set the row (see Not tested). - Linux, any GPU, a tester by hand (behavior): Controls tab, Minimap button on D-pad down. With In-Game Interface on Normal, in the field: a short tap of D-pad down, expecting the boots to change and the minimap to stay as it is; a hold of about half a second, expecting the minimap to hide; another hold, expecting it back. Then the same tap and holds on Pro, where the first hold should bring a minimap up. Pass: all four (tap and hold, Normal and Pro) as described. ### Screenshots After: this PR (a pack of this branch built on `main` @ 6c9edffe, before the rebase onto e090cc48): the Controls tab's new **Minimap button** row on D-pad down, with its help text. ![After: this PR, the Controls tab's Minimap button row on D-pad down](https://git.magicbean.dev/attachments/f43baca3-209e-4e31-bd07-7b72e0f1d1c6) After: this PR, the same build: the minimap on screen in the Ice Cavern with the Minimap button on D-pad down. ![After: this PR, the minimap on screen in the Ice Cavern with the Minimap button on D-pad down](https://git.magicbean.dev/attachments/d1b56597-2f9c-456b-b487-dfd749651f4a) ## Risks **What could break:** the controller read now calls `hos_minimap_buttons` on every read of the first controller, and Link's movement update calls the host once a frame. With the button Off both do almost nothing. With it on, the read calls the game's own screen lookup (`f_80b45cd0`) from the game's thread, as the game itself does when it opens the screen. A wrong gameplay test would only make a press go to the game as it does today, or open the minimap late. **Turning it off:** Minimap button Off (the default), or revert the commit. **Compatibility:** the options file gains two lines, `minimap_button` and `minimap` (an older file reads the defaults). The player's next build translates the game again because the lifted function changes, as for any change to `nx2/oot_patches.py`. The shader and pipeline caches and `MKWVK_API_VERSION` are untouched (the option ids are new `HOS_OPT_*` numbers and no struct changed, as when the earlier options such as `HOS_OPT_HOLD_TOGGLE` were added). ## 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. - [ ] 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: Risks states extra per-frame and controller-read calls when the button is on, with no timing given. - [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). - [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] Switches documented (docs/development.md; the player guide for a menu row) and shipped at their recommended value. - [x] Screenshots of the same spot, captioned like the Measurements columns, for a change that shows on screen. - [x] 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. (Open: built on Windows; for Linux only the host files were compile-checked, see Testing; Linux build asked of the Test Farm, as build evidence only; the button's behavior on Linux is for a tester by hand, see Must be tested.) - [x] Docs updated.
HumanBean force-pushed feat/minimap-toggle from aa626cc97a
Some checks failed
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 4s
CI / Conventional Commit title (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been cancelled
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been cancelled
CI / Workflow lint (actionlint) (pull_request) Has been cancelled
Guide screenshots / Guide images and local UI source review (pull_request) Has been cancelled
Third-party parts / As their notes say (pull_request) Has been cancelled
Third-party parts / The same as upstream (pull_request) Has been cancelled
to a57feb1930
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 5s
CI / Conventional Commit title (pull_request) Successful in 3s
CI / Workflow lint (actionlint) (pull_request) Successful in 7s
Guide screenshots / Guide images and local UI source review (pull_request) Failing after 5s
Third-party parts / As their notes say (pull_request) Successful in 11s
Website / Website on Cloudflare (pull_request_target) Has been skipped
2026-11-15 18:46:23 +00:00
Compare
Owner

Rebased onto main @ 7bacf846: conflicts in gpu/vk/menu_i18n.h (same as above) and gpu/vk/vk_menu.cpp: kept the minimap option's save and load lines beside main's new gpu_device_id block, and dropped the has_vram_budget line main removed. No tests were run here; the test boxes stay yours.

Rebased onto `main` @ 7bacf846: conflicts in gpu/vk/menu_i18n.h (same as above) and gpu/vk/vk_menu.cpp: kept the `minimap` option's save and load lines beside main's new `gpu_device_id` block, and dropped the `has_vram_budget` line main removed. No tests were run here; the test boxes stay yours.
Member

@kendowashere only members of BigBeans can start the farm.

One of them can approve this request by reacting 👍 to it. This request was for a43db60, and the PR has changed since (1575bf7), so a 👍 no longer approves it. Comment @Beanstalk again to ask for the new commit.

@kendowashere only members of `BigBeans` can start the farm. ~~One of them can approve this request by reacting 👍 to it.~~ This request was for `a43db60`, and the PR has changed since (`1575bf7`), so a 👍 no longer approves it. Comment `@Beanstalk` again to ask for the new commit.
kendowashere force-pushed feat/minimap-toggle from a43db600a1
Some checks failed
beanstalk/approval waiting for a BigBean's 👍 on the request
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 4s
CI / Conventional Commit title (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been cancelled
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been cancelled
CI / Workflow lint (actionlint) (pull_request) Has been cancelled
Guide screenshots / Guide images and local UI source review (pull_request) Has been cancelled
Third-party parts / As their notes say (pull_request) Has been cancelled
Third-party parts / The same as upstream (pull_request) Has been cancelled
to 1575bf72a2
Some checks failed
Website / Website on Cloudflare (pull_request_target) Has been skipped
beanstalk/approval waiting for a BigBean's 👍 on the request
PR description / Description follows the template (pull_request_target) Failing after 4s
CI / Conventional Commit title (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Has been cancelled
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Has been cancelled
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Has been cancelled
CI / Workflow lint (actionlint) (pull_request) Has been cancelled
Guide screenshots / Guide images and local UI source review (pull_request) Has been cancelled
Third-party parts / As their notes say (pull_request) Has been cancelled
Third-party parts / The same as upstream (pull_request) Has been cancelled
Website / Website on Cloudflare (pull_request) Has been cancelled
2026-11-15 23:40:22 +00:00
Compare
Author
First-time contributor

@Beanstalk On Linux, any GPU: build this branch and start the game. Open the Controls tab and set Minimap button to D-pad down. In the field, hold D-pad down for about a quarter of a second: the minimap should hide, and a second hold should bring it back (try In-Game Interface on Normal and on Pro). A quick tap should change boots and leave the minimap alone. Pass: it builds and starts, the row is there (Off by default), and the hold and tap behave as described. Please copy any log line containing 'minimap'.

@Beanstalk On Linux, any GPU: build this branch and start the game. Open the Controls tab and set Minimap button to D-pad down. In the field, hold D-pad down for about a quarter of a second: the minimap should hide, and a second hold should bring it back (try In-Game Interface on Normal and on Pro). A quick tap should change boots and leave the minimap alone. Pass: it builds and starts, the row is there (Off by default), and the hold and tap behave as described. Please copy any log line containing 'minimap'.
Member

@kendowashere only members of BigBeans can start the farm.

One of them can approve this request by reacting 👍 to it or to this comment. This request was for 1575bf7, and the PR has changed since (0d54e38), so a 👍 no longer approves it. Comment @Beanstalk again to ask for the new commit.

@kendowashere only members of `BigBeans` can start the farm. ~~One of them can approve this request by reacting 👍 to it or to this comment.~~ This request was for `1575bf7`, and the PR has changed since (`0d54e38`), so a 👍 no longer approves it. Comment `@Beanstalk` again to ask for the new commit.
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: The Tested line gives in-game runs on Windows 11 Pro, RTX 5070 Ti and a DualSense on your PC.
  • Nothing gets worse that I know of: not ticked: Risks states extra per-frame and controller-read calls when the button is on, with no timing given. 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: The Tested line gives in-game runs on Windows 11 Pro, RTX 5070 Ti and a DualSense on your PC. - *Nothing gets worse that I know of*: not ticked: Risks states extra per-frame and controller-read calls when the button is on, with no timing given. Measure that cost and state it in Risks, then tick it.
Member

Farm readiness review for 1575bf72: please separate the Linux build from the new Minimap button setting and tap-versus-hold behavior. The current farm option registry lacks the new row. Provide a supported setup that confirms the binding, or ask a Linux tester to check a short D-pad tap and a longer hold in both Normal and Pro before using a farm result as behavior evidence.

Farm readiness review for `1575bf72`: please separate the Linux build from the new Minimap button setting and tap-versus-hold behavior. The current farm option registry lacks the new row. Provide a supported setup that confirms the binding, or ask a Linux tester to check a short D-pad tap and a longer hold in both Normal and Pro before using a farm result as behavior evidence.
Author
First-time contributor

Thanks, agreed. Testing is now split in the description. The Test Farm is asked only for the Linux build: build, start and reach gameplay with the Minimap button at its default, Off. The farm can't set minimap_button until this merges (its registry comes from main's vk_menu.cpp), and a show or hide writes no log line, so no farm result here counts as evidence of the button's behavior. The tap and hold check on Linux is now a separate hand test: Minimap button on D-pad down, then a short tap (boots change, minimap unchanged) and a hold of about half a second (minimap hides; a second hold brings it back), on both Normal and Pro. If anyone on Linux can run that, please post the four results here.

Thanks, agreed. Testing is now split in the description. The Test Farm is asked only for the Linux build: build, start and reach gameplay with the Minimap button at its default, Off. The farm can't set `minimap_button` until this merges (its registry comes from `main`'s `vk_menu.cpp`), and a show or hide writes no log line, so no farm result here counts as evidence of the button's behavior. The tap and hold check on Linux is now a separate hand test: Minimap button on D-pad down, then a short tap (boots change, minimap unchanged) and a hold of about half a second (minimap hides; a second hold brings it back), on both Normal and Pro. If anyone on Linux can run that, please post the four results here.
Author
First-time contributor

@Beanstalk On Linux, any GPU: build this branch and start the game with default settings, expecting it to build, start and reach gameplay. This is a build check only: leave the Minimap button at Off and don't test the minimap.

@Beanstalk On Linux, any GPU: build this branch and start the game with default settings, expecting it to build, start and reach gameplay. This is a build check only: leave the Minimap button at Off and don't test the minimap.
Member

@kendowashere only members of BigBeans can start the farm.

One of them can approve this request by reacting 👍 to it or to this comment. This request was for 1575bf7, and the PR has changed since (0d54e38), so a 👍 no longer approves it. Comment @Beanstalk again to ask for the new commit.

@kendowashere only members of `BigBeans` can start the farm. ~~One of them can approve this request by reacting 👍 to it or to this comment.~~ This request was for `1575bf7`, and the PR has changed since (`0d54e38`), so a 👍 no longer approves it. Comment `@Beanstalk` again to ask for the new commit.
kendowashere changed title from WIP: feat(input): a minimap toggle button, with the choice kept to feat(input): a minimap toggle button, with the choice kept 2026-11-21 06:26:49 +00:00
Merge remote-tracking branch 'origin/main' into upd/minimap-toggle
Some checks failed
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
CI / Website build and checks (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) Blocked by required conditions
beanstalk/approval changed since the request: ask again
PR description / Description follows the template (pull_request_target) Failing after 6s
0d54e389e0
# Conflicts:
#	README.md
#	gpu/vk/menu_i18n.h
#	gpu/vk/vk_menu.cpp
#	gpu/vk/vk_replay.cpp
#	nx2/oot_patches.py
Some checks failed
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
CI / Website build and checks (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) Blocked by required conditions
beanstalk/approval changed since the request: ask again
PR description / Description follows the template (pull_request_target) Failing after 6s
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 'feat/minimap-toggle:kendowashere-feat/minimap-toggle'
git switch 'kendowashere-feat/minimap-toggle'
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
4 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!711
No description provided.