feat(debug): add transition autosave control and quick menu shortcut #614
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
2 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!614
Loading…
Reference in a new issue
No description provided.
Delete branch "Tommy/Longshot:codex/debug-autosave"
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?
Type: feat · Risk: medium · Tested on: Windows 11, RTX 4090 · Needs: Windows and Linux, any GPU
Why
Debug tools can change progression, and an automatic save can persist those changes during testing. Players need a way to suppress transition autosaves and a shortcut to reach the debug controls in-game. See #578.
What changed
The Debug menu lets players opt out of transition autosaves. A keyboard shortcut opens the compact debug menu during play.
Measurements
Verdict: Windows in-game pass for the tested route. Off blocked both autosaves after the fix, On wrote one at each crossing, and System → Save still worked with Off.
Hardware: Windows 11 build 26200, RTX 4090 (Vulkan driver ID 0x9b438000), Ryzen 7 7700X, 32 GB RAM.
Scene: Hyrule Field and Kakariko Village, 2560x1440, Debug tools Off.
Method: One round trip per toggle state from the same disposable starting save. Checked progress-file hashes and cross-checked save requests in the trace log.
How to reproduce: Set Transition autosave Off, load the Hyrule Field save at the Kakariko entrance, wait 75 seconds before each crossing, then compare progress slots. Repeat from the same starting save with the toggle On. With Off, use System → Save to verify manual saving separately.
Baseline: Earlier PR build
3b54a58dwith Off reproduced the bug. Main has no toggle, so the matched On and Off runs use the fixed build.Short runs could produce no save even with On. With the wait, suppressing reason 2 alone still let both saves through. The final filter covers reason 1, 2 and 6 at the observed transition call sites.
3b54a58d, Off8fd316cd, Off8fd316cd, OnThe earlier build reproduced the issue. The paired final runs used identical settings and waits apart from the toggle. See docs/tested/ for Codex run02 and run03.
Flags and settings
This PR adds a saved Debug menu toggle and a diagnostic trace switch.
transition_autosaveHOS_OOT_TRACE_SAVESTesting
Tested: The paced Windows A/B and manual-save check on
8fd316cdpassed. On the earlier Windows RTX 4090 build, the user confirmed F10 and Home, walked between Hyrule Field and Kakariko Village with transition autosave off, and made a manual save afterward. The crossings left six monitored progress files unchanged and the manual save changed one. A later warp sweep logged seven blocked transition requests alongside other save requests. The local build was based on7ff5256ewith Vulkan driver ID 0x9b438000. On rebased commit1f0a276d, the keyboard menu, preset exemption, and option-ID checks passed. The updated Debug row fixture on9a5b94f4verifies the toggle is visible and effective with Debug tools on or off. The upscaler round-trip fixture also passed after its update.Final game-free Windows suite: 506 passed, 16 failed, 72 skipped. The exact upstream base
e090cc48had 505 passed, the same 16 failures, and 72 skipped: tests/test_appimage_player_build.py, tests/test_cpm_discovery.py, tests/test_cpp_preflight.py, tests/test_crash_dialog.py, tests/test_env_on.py, tests/test_lift_cleanup_error.py, tests/test_linux_preflight.py, tests/test_make_game_cache.py, tests/test_make_game_prepare.py, tests/test_missing_nup.py, tests/test_oot_state_tap.py, tests/test_readback_late.py, tests/test_tested_configurations.py, tests/test_vk_pgo.py, tests/test_vram_budget_row.py, tests/test_walk_key.py. The new save-filter test passed on Windows and Ubuntu WSL and caught the missed request on the earlier branch.On
3b54a58d(based one090cc48), I used a disposable save on Windows 11 build 26200, RTX 4090 (Vulkan driver ID 0x9b438000), Ryzen 7 7700X and 32 GB RAM, at 2560x1440. With Debug tools Off, I set Transition autosave Off, restarted, and verified both settings were still Off. Walking Hyrule Field → Kakariko Village → Hyrule Field produced a new progress slot at each crossing despite four logged suppressions. The same trace also showed additional request reasons 1 and 2. The follow-up runs above isolated both arrival requests. System → Save then updated one progress slot with the toggle still Off. I set the toggle On and walked back into Kakariko. The transition requests went through and a new progress slot appeared. The game closed cleanly. See docs/tested/2026-11-15-transition-autosave-codex-run01.md.Additional Windows boundary tests: Rebased on
aa95d35fand rebuilt atc2e30565. Each test waited 75 seconds after staging, then walked through the exit with Debug tools Off. The staging teleports were tracked separately.Each walk issued the same four requests at the three already covered call sites. Off suppressed all four on every crossing. On suppressed none. No additional save path appeared during these walks. Market and Kokiri staging teleports also wrote progress with On and did not write with Off. Gerudo staging did not write in either run. The first Gerudo Off staging attempt timed out and was repeated in a fresh run before measuring the walk. See Codex runs 04–06 under
docs/tested/.The rebased game-free Windows suite returned 506 passes, 16 failures and 72 skips. The focused save-hook and Debug menu tests passed. The newly appearing options-budget check reports a duplicate
gpu_device_idsetting on both the PR and upstreamaa95d35f.Retest on
ceccd963: Windows build05e45da9repeated the Castle Town Market exit into Hyrule Field, with Debug tools Off and a 75-second wait after staging. Off suppressed all four known requests and wrote zero progress saves. On allowed all four and wrote one progress save. Both runs closed cleanly. See Codex runs 07–08 under docs/tested/.On the latest tested rebase, the Windows suite returned 529 passes, 21 failures and 80 skips. The same run on main at
ceccd963returned 528 passes, the same 21 failures, and 80 skips. The added transition autosave regression passed. The common failures weretests/test_appimage_player_build.py,tests/test_auto_handheld.py,tests/test_bug_report.py,tests/test_cpp_preflight.py,tests/test_crash_dialog.py,tests/test_crt_options.py,tests/test_env_on.py,tests/test_hardware_report.py,tests/test_lift_cleanup_error.py,tests/test_linux_preflight.py,tests/test_make_game_cache.py,tests/test_make_game_prepare.py,tests/test_missing_nup.py,tests/test_oot_state_tap.py,tests/test_options_budget_once.py,tests/test_pads_after_menu.py,tests/test_readback_late.py,tests/test_tested_configurations.py,tests/test_vk_occlusion_queries.py,tests/test_vk_pgo.py,tests/test_walk_key.py.Wording update (
71e37883): The Windows Vulkan renderer built successfully with llvm-mingw. The Debug menu and save-filter checks passed. The same-environment Windows suite returned 520 passes, 30 failures, and 80 skips. Main atceccd963returned 519 passes, the same 30 failures, and 80 skips. The extra pass is the save-filter regression. The shared failures werenx2/test_nup_paths.py,tests/test_appimage_player_build.py,tests/test_auto_handheld.py,tests/test_bug_report.py,tests/test_control.py,tests/test_copy_writable.py,tests/test_cpm_discovery.py,tests/test_cpp_preflight.py,tests/test_crash_dialog.py,tests/test_crt_options.py,tests/test_dev_packs.py,tests/test_env_on.py,tests/test_hardware_report.py,tests/test_lift_cleanup_error.py,tests/test_linux_preflight.py,tests/test_make_game_cache.py,tests/test_make_game_prepare.py,tests/test_missing_nup.py,tests/test_oot_state_tap.py,tests/test_options_budget_once.py,tests/test_pads_after_menu.py,tests/test_pipeline_cache_file.py,tests/test_portable_builder_home.py,tests/test_portable_builder_startup.py,tests/test_readback_late.py,tests/test_release.py,tests/test_tested_configurations.py,tests/test_vk_occlusion_queries.py,tests/test_vk_pgo.py,tests/test_walk_key.py.Two-button dialog (
b770e2b7): The Windows Vulkan renderer built with llvm-mingw. Game-free checks verified that Cancel preserves the settings and Enable Debug Tools turns autosave off and saves both settings. The menu-key and autosave filter checks passed. Full Windows run had 520 passes, 30 failures, and 80 skips. All 30 failures also appeared on the same-environment main baseline. The updated dialog still needs a visual check in-game.Not tested: A native Linux game build and run, physical F10/Home on the rebased Windows build, and autosave events outside the tested areas remain to be verified.
Must be tested:
Risks
What could break: Other autosave triggers can still persist progression changes while the toggle is off. Additional maps and non-transition autosaves still need coverage. The filter matches the observed call sites and leaves unrelated requests alone.
Turning it off: Set Autosave back to On to restore normal transition autosaving. Turning Debug tools off keeps the saved autosave setting.
Compatibility: Existing options files default to transition autosave On when the new setting is absent. The renderer uses the existing option callback, and neither renderer interface struct changes.
Issues
See #578.
Checklist
Everyone
type(scope): description) of the status line's type.main. The Windows build was tested onceccd963. Main advanced toc64e864fduring testing and merges cleanly.python -I -B tests/run_all.pypasses (any failure that also fails onmainis named).third_party/untouched (a new folder with aPROVENANCE.mdinstead).When it applies
Assisted-by:/Co-Authored-By:trailers.docs/tested/for each new measured run (format indocs/tested-configurations.md).tests/that reads changed source updated in this PR, not weakened.4fd44d3b051f0a276dfbRebased onto main at
6c9edffe. The keyboard menu, preset exemption, and option-ID checks passed on1f0a276d. The description now lists the remaining autosave and shortcut checks needed before merge.Transition autosave now lives in the general Debug tab and applies with Debug tools off. The Debug row test covers both modes, and the option and trace flag are documented.
The Windows renderer builds on
67bd9264. The Windows suite comparison is in the description, including the failures also reproduced on main and the Builder timeout that passed on rerun.67bd9264923b54a58de1Rebased on
e090cc48and tested the Windows game build at3b54a58d. Off persisted with Debug tools disabled and blocked the known transition requests, but both crossings still wrote progress saves. Manual Save worked with Off, and the On comparison also wrote a save. The test result is recorded in docs/tested; keeping this draft open for the remaining autosave investigation.Fixed both map-arrival autosave requests. With 75 seconds before each crossing, Off wrote zero autosaves, On wrote two, and manual saving worked with Off. The new regression check passes on Windows and Ubuntu. The full Windows suite has the same 16 failures as the exact upstream base.
aae1e9334dc2e30565c9Rebased onto
aa95d35fand tested three more natural exits into Hyrule Field onc2e30565: Gerudo Valley, Market and Kokiri Forest. Each wrote zero progress saves with Off and one with On. All walking traces matched the existing filter, and no additional save path appeared.68456184af3d04415d7fRebased onto
main@bbe6fdf2: no conflicts. No tests were run here; the test boxes stay yours.3d04415d7f999f40478dNew commits pushed, approval review dismissed automatically according to repository settings
WIP: feat(debug): add transition autosave control and quick menu shortcutto feat(debug): add transition autosave control and quick menu shortcutmooki referenced this pull request2026-11-16 05:42:23 +00:00