feat(scripts): memtour.py --repo-save, a tour from a repository save #1221
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!1221
Loading…
Reference in a new issue
No description provided.
Delete branch "TrashPanda/Longshot:feat/memtour-repo-save"
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: low · Tested on: Linux, RTX 4070 Ti · Needs: none
Why
scripts/memtour.py(the memory tour: teleports through areas and samples the game's memory) could only start from afull save folder, which
assets/savesdoesn't ship, so nobody could run a tour from the saves every checkout has. Anda tour from those saves stopped at its third area: a text box (Kakariko's first visit, the owl in Hyrule Field) holds
every teleport back until A is pressed, and the tour only waited, so every later teleport was refused. Both stood in
the way of measuring #1069's fix.
What changed
--repo-save NAMEstarts the tour from a repository save, and a teleport refused because "an event is playing" isasked again after an A press.
scripts/memtour.py:--repo-savebeside--save(one of the two is required), passed tostart_sessionaslongshot_ctl.py launch --repo-savepasses it;Tour.teleport()presses A after an "event is playing" refusalbefore it asks again.
tests/test_memtour.py: an event refusal presses A until the text box closes; a busy refusal presses nothing.Measurements
Verdict: nothing to measure: a script and its tests. What it does in the game is below.
Flags and settings
None (a script's argument,
--repo-save).Testing
Tested:
python -I -B tests/test_memtour.py(17 tests) andpython -I -B tests/run_all.pyon Linux (only thechecks that fail on
mainon this PC fail, none new). In the game, Ubuntu 26.04.1, RTX 4070 Ti, from--repo-save kokiri-start: before the A press, a tour of Hyrule Field, Kakariko and the Market stopped at its thirdarea (
teleport_error ... an event is playingto the end). With it, 16 tours of Kakariko and the Market(
--dests 2,3,2,3,2,3,2,3) each reached 7 or 8 of their 8 areas, a text box passed by one press when there was one(
teleport_erroronce, thenteleport). The tours behind #1069's measurements were run with it.Not tested: Windows (the script samples
/proc: Linux only, as before). Routes through Hyrule Field still stopsometimes: with the A press, one such tour reached 4 of its 8 areas, the owl's talk letting a teleport through between
its boxes and the map never changing after that. The tours above leave the field out.
Must be tested: None.
Risks
What could break: an A press when the event is not a text box (a cutscene): A skips nothing there and does
nothing else in one.
Turning it off: revert the commit.
Compatibility: Nothing changes.
Issues
See #1069
Checklist
Everyone
type(scope): description) of the status line's type.main.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.mainand passing here.tests/that reads changed source updated in this PR, not weakened.Tested in game: Ubuntu 26.04.1, RTX 4070 Ti, NVIDIA 595.99.02: 16 tours of Kakariko and the Market from --repo-save kokiri-start, each reaching 7 or 8 of 8 areas, a text box passed by one A press; before the A press a tour stopped at its third area.
Checks that fail on
main@0cab3548on this PC (Ubuntu 26.04.1; its toolchain lacks what they need),python -I -B tests/run_all.py:tests/test_audio_output_devices.pytests/test_bug_report.pytests/test_bug_report_defaults.pytests/test_crash_record.pytests/test_crt_options.pytests/test_dlss_feature_size.pytests/test_failed_compile_keeps_objects.pytests/test_fsr_uniform_ownership.pytests/test_guest_imported.pytests/test_hardware_report.pytests/test_import_reach.pytests/test_lift_lookups.pytests/test_linux_preflight.pytests/test_linux_update.pytests/test_make_game_cache.pytests/test_missing_nup.pytests/test_mods_size_table.pytests/test_nonuniform_image_arrays.pytests/test_parallel_init_order.pytests/test_pending_guest_import.pytests/test_replay_write_order.pytests/test_run_all_changed.pytests/test_vk_occlusion_queries.pytests/test_walk.pytests/test_walk_key.pyThis PR's run fails the same ones and nothing else (
tests/test_control.pytimed out once in the full run on #1222's branch and passes alone).Possibly related, for context:
WIP: feat(scripts): memtour.py --repo-save, a tour from a repository saveto feat(scripts): memtour.py --repo-save, a tour from a repository saveView command line instructions
Checkout
From your project repository, check out a new branch and test the changes.