feat(ui): add live gameplay HUD placement and shortcut #1855
No reviewers
Labels
No labels
area/accessibility
area/audio
area/input
area/install
area/menu
area/renderer
area/saves
area/tooling
area/upscaling
beanstalk: approved
beanstalk: failed
beanstalk: needs approval
beanstalk: running
beanstalk: tested
ci: approved
good first issue
gpu/amd
gpu/igpu
gpu/intel
gpu/nvidia
help wanted
kind
bug
kind
chore
kind
docs
kind
feature
kind
performance
kind
question
needs measurements
platform/linux
platform/macos
platform/steam-deck
platform/windows
preview
priority
critical
priority
high
priority
low
regression
risk
high
risk
low
risk
medium
status
blocked
status
confirmed
status
duplicate
status
invalid
status
needs-info
status
wontfix
ci: approved
No milestone
No project
No assignees
5 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!1855
Loading…
Reference in a new issue
No description provided.
Delete branch "futondestroyer/Longshot:codex/gameplay-hud"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Summary
Graphics → Screen adds Custom alongside Screen's edges and Middle 16:9. It adjusts the position and size of hearts and magic, action and item buttons, and the minimap. The dungeon's live small-key count follows the minimap. Reset HUD placement restores the default positions and sizes.
The Controls page adds Toggle HUD, initially unbound. A fresh press hides or shows the gameplay HUD for the session. The shortcut takes priority over an overlapping gameplay binding and preserves the assignment for when the shortcut is cleared.
Start with
hos_gameplay_hud_screenandclassifyinhost/hos_wide_ui.c. The minimap and live small-key counter are siblings and share a transform. The full map has a separate small-key count and an icon for the owned Boss Key. The shared screen'sIsMiniMapstate follows #774. If #711 lands too, check both shortcuts with the same D-pad input.Testing
Tested: Windows 11, RTX 4070, NVIDIA 621.01. The llvm-mingw builds of
9027e737andf8cc8688both ran from UTF-8 paths. At the same 21:9 Water Temple camera position on the same disposable one-key checkpoint, Custom moved and scaled the live key count with the minimap. At 16:9 and 21:9, a new W binding hid and restored hearts, magic, items and guides, the minimap, and the key count. The overlapping Move forward binding remained set. Holding W toggled once and Link stayed in place. Original and FSR 3.1 2× frames during camera pans preserved the visible and hidden state.The full map opened while gameplay HUD was hidden and showed its own small-key count. It showed a gold Boss Key when owned, and the corresponding slot stayed empty in the separate no-Boss-Key run. The Kokiri check reached Saria's cutscene, drew its title and opened the pause map and Longshot settings with the HUD hidden. All completed runs exited normally. The source saves retained their hashes.
The before-fix fixture at
abcd0724failed the live-key transform assertion. The final fixture passes. Removing the key transform and removing the scoped hide each fails its own assertion. The Windows UTF-8 path check and the compiled HUD fixture passed under a non-ASCII temporary path.All four strict Windows shards ran on each revision with llvm-mingw Clang. Main
9027e737had 761 passes, 73 failures and 48 skips. Headf8cc8688had 764 passes, 70 failures and the same 48 skips. Every check that failed on the head also failed on the pinned main. The HUD layout row, pad-after-menu and Walk key checks passed on the head. The localgccdriver resolves to Clang.Windows checks that also fail on main
tests/test_appimage_player_build.py,tests/test_auto_handheld.py,tests/test_bug_report_defaults.py,tests/test_capture_read_once.py,tests/test_capture_readback_visibility.py,tests/test_crash_dialog.py,tests/test_crt_options.pytests/test_damage_debug_menu.py,tests/test_dev_ab.py,tests/test_dev_build.py,tests/test_dev_migrate.py,tests/test_dev_packs.py,tests/test_display_startup_failure.py,tests/test_dlss_feature_size.pytests/test_draw_binds.py,tests/test_draw_stream_visibility.py,tests/test_early_split_before_draw.py,tests/test_failed_compile_keeps_objects.py,tests/test_fastfp_fma.py,tests/test_fma_soft.py,tests/test_fpx_sticky.pytests/test_frame_overlap.py,tests/test_fsr3fi_hud_layer.py,tests/test_fsr3fi_hudless_colour.py,tests/test_fsr_image_retirement.py,tests/test_fsr_uniform_ownership.py,tests/test_game_menu_mouse_buttons.py,tests/test_guest_imported.pytests/test_high_fps_fixes.py,tests/test_hold_gpu.py,tests/test_host_guest_writes.py,tests/test_job_queue.py,tests/test_libc_hooks.py,tests/test_lift_cache.py,tests/test_linux_preflight.pytests/test_linux_pressure.py,tests/test_low_vram_texture_mips.py,tests/test_make_game_ngx.py,tests/test_mise_build.py,tests/test_missing_nup.py,tests/test_mods_list.py,tests/test_ngx_sdk.pytests/test_pass_barrier.py,tests/test_pending_guest_import.py,tests/test_pipeline_play_cache.py,tests/test_prepare_cache_save.py,tests/test_present_queue_default.py,tests/test_present_source_crop.py,tests/test_profiling_mode.pytests/test_psychov35_fsr3_fg.py,tests/test_readback_early.py,tests/test_readback_late.py,tests/test_readback_timeout_source.py,tests/test_recording_admission.py,tests/test_replay_write_order.py,tests/test_sampler_admission.pytests/test_sdiv_overflow.py,tests/test_slow_frames.py,tests/test_song_note_cue.py,tests/test_spawn_emit.py,tests/test_split_before_draw.py,tests/test_staging_burst.py,tests/test_texel_buffer_ownership.pytests/test_ub_update_batch.py,tests/test_upscaler_rows.py,tests/test_vbytes.py,tests/test_vcore_escape.py,tests/test_vecfp.py,tests/test_vfpx_elem.py,tests/test_vk_occlusion_queries.pyGuide asset integrity passes for all seven images. Guide source review reports 33 mismatches on
9027e737and 34 onf8cc8688. The added fingerprint isgpu/vk/menu_i18n.hforsettings-graphics.png. It contains the updated Custom HUD help translation. The guide still needs review of its affected source records. The offline check ran without Launcher source.Still to test:
2210931cand verify the Windows build and gameplay by hand. Main advanced during validation with packaging and host-cache changes.Measurements
Verdict: Water Temple -1.3% fps (median 78.3 against 79.3), within the runs' spread (A 78.9 to 79.8, B 76.7 to 80.0). Hyrule Field faster: +0.4% fps (median 117.2 against 116.7), every B run above every A run.
Setup: Windows 11, Core i7-13700F, RTX 4070, NVIDIA 621.01. The default HUD was used on both builds at 1920×1080 output in a 1280×720 window, frame cap lifted, V-Sync and frame generation off. Each scene used the same save and settings and two interleaved pairs. The individual runs measured 20 seconds after a minimum 12-second warm-up and after the scene stopped waiting for pipelines. Startup-wide shader preparation was disabled in both arms (
RX_VK_PRECOMPILE=0). All eight runs had zero cold frames. The supervisor's per-run control pipe names were excluded from settings comparison.9027e737f8cc8688Water Temple individual FPS, A1/A2 79.8 / 78.9 and B1/B2 76.7 / 80.0. Hyrule Field individual FPS, A1/A2 116.8 / 116.6 and B1/B2 116.8 / 117.5.
Risks
HUD placement uses known pane names and the shared dungeon map state. Screen's edges restores default placement. Leaving Toggle HUD unbound gives gameplay inputs their ordinary assignments. The full map stays available during HUD hide and restore.
Checklist
Ready for review
main. The tested rebase is on9027e737. Main advanced to2210931c.mise run testpasses (any failure that also fails onmainis named). Ran the equivalent strict runner in four supported shards.main, or Measurements says why there is nothing to measure.third_party/untouched and the patch is GPL-compatible.When it applies
mainand here, for a change that shows on screen. Matched Water Temple pair.Assisted-by:trailers.Ready to merge
Tested in game: Windows 11 build 26300, RTX 4070 with NVIDIA 621.01. The disposable Kokiri checkpoint reached outdoor play at 16:9 and 21:9. Live W rebinding consumed Move forward, the relocated HUD drew in original and FSR 3.1 2x frames during a pan, and the full map opened while the gameplay HUD was hidden.
Possibly related, for context:
Rebased the unchanged patch onto
89c3d21eand repeated the Windows 16:9 and 21:9 tests at631bc464. Both preserved the full map and captured FSR 3.1 generated frames. The one-key Water Temple copy established that the small-key counter stays fixed when Custom moves the minimap. The shortcut hides the gameplay minimap and key counter, while hearts and other HUD elements can remain visible. The PR stays WIP with both findings.5c8ad1381e631bc46431The Water Temple small-key count now moves and scales with the minimap. Toggle HUD hides and restores the gameplay HUD and the full map keeps both key badges. Verified Windows gameplay at 16:9 and 21:9 with original and FSR 3.1 generated frames, plus Kokiri cutscene and menu behavior. All 22 focused checks pass on
591ab531. The five strict-suite failures specific to this PR now pass. The other 69 checks also failed on the tested main89c3d21e. The description records the rebase and retest still needed for70d22cf1.Hi, nice work on this: live HUD placement and a Toggle HUD key are great additions.
I've been working on something close in Hookshot (a per-element HUD editor, upstream PR https://git.notrexed.dev/Hookshot/Hookshot/pulls/3099), and I have it running in
a Longshot build too. I don't want to step on your PR, so I'd rather build on yours than open a competing one.
What mine has that this PR doesn't seem to cover yet, in case any of it is useful:
minimap (they don't sit in the same spot).
Next on my list is an on-screen edit mode: drag the HUD elements with the mouse (or move them with the stick) and set them from a small floating panel, without going
through the menu rows. Since your PR already places the HUD live, is that something you were planning too? I'd rather not build the same thing twice.
Once this is merged, I'd be happy to send those as small follow-up PRs on top of your Custom layout (same rows and same placement code, nothing duplicated, and keeping
your small-key counter with the minimap). Or if you'd rather fold some of it in here, I can share the code. Which would you prefer?
591ab53134f8cc868845Rebased six identical patches onto main
9027e737. Exact headf8cc8688passed Windows Water Temple gameplay at 16:9 and 21:9, including Custom placement, HUD hide and restore, both dungeon key indicators, and FSR 3.1 generated frames. All 70 strict-suite failures also failed on the tested main. The description records the two-scene timing, Guide source drift, and outstanding review gates. Main has since advanced to2210931c.The same Water Temple room and camera at 21:9, with one unspent small key.
Main
9027e737, Screen's edgesPR
f8cc8688, Custom@Beanstalk Please test the Linux host build and UTF-8 path handling on the current PR head
f8cc86884592ac3f182230d20aea46c79a43b6b6. Use a Linux worker with the documented host toolchain, put the build workspace or output under a path containing a non-ASCII character, and run the repository's focused UTF-8 path fixture. Expected results are a successful host build and a passing fixture. Please report the tested commit, distro, compiler, and build and fixture results. This request covers those two Linux checks.@futondestroyer approval of
f8cc868recorded. This diff touches sensitive paths, so a second member ofBigBeansmust approve it too.Beanstalk test farm
Commit
3d1941b· approved by nobody yet · dashboardA member of
BigBeanscan review this commit and comment@Beanstalkto test it.@rebase
I rebased this pull request onto
main(e0ef1b5721): the new head is3d1941bd96.Conflicts resolved:
Nothing was built or run: read the resolution before merging.
Automated rebase by BeanBot (gpt-6.1-terra), asked for by HumanBean. Nothing was run; a maintainer decides.
f8cc8688453d1941bd96WIP: feat(ui): add live gameplay HUD placement and shortcutto feat(ui): add live gameplay HUD placement and shortcutllun referenced this pull request2026-11-20 22:13:26 +00:00