feat(menu): many places on the Teleport page, each with a picture taken in your own game #823
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
1 participant
Notifications
Due date
No due date set.
Dependencies
No dependencies set
Reference
MagicBeanDev/Longshot!823
Loading…
Reference in a new issue
No description provided.
Delete branch "samaBR/Longshot:feat/teleport-places"
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: Windows 11, RTX 4070 SUPER · Needs: Linux, any GPU
Why
The Debug tab's Teleport page goes to a map's start only, by its internal name, so finding the place you want means
guessing. This lists many more places (the ones a Fast Travel mod offers: villages, dungeons' entrances, shops, story
spots), each with a picture of it from your own game, so you can see where you are going. Only with the Debug tools on.
It was tested by players on Hookshot (Teleport pictures and its places); this is the same feature on Longshot.
What changed
The Teleport page shows the places beside the maps it had, and a picture of each, taken from the game's own picture the
first time Link stays at a place for a few seconds with the menu closed. Retake picture takes it again, on a key or button
the player chooses.
gpu/vk/vk_menu.cppthe Teleport page (places, pictures, Retake picture, the "picture saved" line),gpu/vk/oot_tp_places.handoot_tp_places_data.hthe places,gpu/vk/oot_teleport_capture.hthe pictures (a workerwrites one file a place in
teleport_pictures/),gpu/vk/vk_replay.cppteleport_capture(the middle of the pictureat 480x270, at present time).
host/hos_main.coot_capture_tick(Link settled at a place) and the places' arrival (entrance event, storyflags).
nx2/teleport_places.pyreads the places' positions, arrival events and story flags from the player's own mapsinto
teleport_places.bin(nx2/make_game.py); without it the places arrive with the plain event and take no pictures.Measurements
Verdict: works in the game (190 places read from the player's maps, travel to them as child and adult, a picture
taken at each place, Retake picture) and costs nothing seen: the game holds its 60 fps cap with the Debug tools on and
pictures being taken, as with main. With the Debug tools off nothing runs. Not measured uncapped.
Hardware: Windows 11, RTX 4070 SUPER (driver 32.0.16.2114), 2560x1440
Scene: in play, the game's 60 fps cap, defaults otherwise
Method: the
vk: ... fpsandvi: ... frames presentedlines oflongshot_log.txtacross the play session, teleportingto several places and staying at each until its picture was taken
How to reproduce: Debug tab, Debug tools on, Travel > Teleport, travel to a place and stay a few seconds with the menu closed, the FPS counter on
aa95d35fb27ed3c9Flags and settings
No new menu row: the pictures are taken whenever the Debug tools are on. One key setting, documented in the README.
HOS_OPT_TELEPORT_PICTURES; 59 and 61 are main's, 60 and 62 the item wheel's)retake_keyTesting
Tested:
python -I -B tests/run_all.pyon Windows, rebased onmain@bbe421f5: the 17 that fail fail onmain@bbe421f5too (test_auto_handheld, test_bug_report, test_bug_report_defaults, test_crash_dialog, test_crt_options, test_guest_imported, test_hardware_report, test_linux_preflight, test_longshot_ctl, test_make_game_cache, test_missing_nup, test_pads_after_menu, test_pending_guest_import, test_run_all_changed, test_tested_configurations, test_vk_occlusion_queries, test_walk_key; the others that failed under the parallel run (20 at once) pass alone). A build ofthe renderer of the rebased branch compiles. The Guide screenshots check (
scripts/check_guide_screenshots.py --review-sources) fails onmain@bbe421f5too,with the same review list (settings-graphics.png and others); this PR's changes don't show on the Graphics tab that image shows. (This PR adds gpu/vk/vk_ui.h to that list.) In the game (Windows, RTX 4070 SUPER, a build of this branch over main
aa95d35f): travel to the newplaces as child and adult, the pictures taken and shown, Retake picture.
Not tested: Linux, AMD and Intel GPUs, Steam Deck.
Must be tested:
menu closed, expecting its picture on the page the next time (Test Farm: @Beanstalk linux, a Teleport place's picture)
Risks
What could break: only the Debug tab's Teleport page and its pictures; nothing runs with the Debug tools off.
Turning it off: the Debug tools off (the default), or revert the commit.
Compatibility: saves untouched;
longshot_options.inigainsretake_key; the picturesare written in the game folder's
teleport_pictures/;teleport_places.binis made at build time from the player's owngame; the vk ABI is unchanged.
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. (made with Claude Code: each commit says so)tests/that reads changed source updated in this PR, not weakened.b27ed3c92f4400bb2458Rebased onto
main@16d87c83: one conflict in vk_replay.cpp (teleport_capturekept after main'sshot_ask_recordwith its CRT headless picture; the Teleport pictures stay the window's picture). The game-free checks fail in the same 19 asmain, the renderer of the rebased branch builds, and the Guide screenshots check fails onmaintoo (this PR adds vk_ui.h to its review list).4400bb245804a2877118Rebased onto
main@79b1fd8f: only gpu/vk/menu_i18n.h conflicted (the per-language counts, recounted). The game-free checks fail in the same 21 asmain@79b1fd8f, the renderer of the rebased branch builds, and the Guide screenshots check fails onmaintoo.04a287711833fa6f2456Rebased onto
main@bbe421f5. Option 59 is nowmain's transition autosave (and 61 its Invert mouse horizontal; 60 and 62 are the item wheel's), soHOS_OPT_TELEPORT_PICTURESis 63. The other conflicts keep both sides: the Retake picture row withmain's Autosave row in the tests, itsretake_keywith the playback device keys in the settings file, and menu_i18n.h (the Teleport page's old help line, no longer used, dropped; counts recounted). The game-free checks fail in the same 17 asmain@bbe421f5, the renderer of the rebased branch builds, and the Guide screenshots check fails onmaintoo.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.