feat(menu): many places on the Teleport page, each with a picture taken in your own game #823

Open
samaBR wants to merge 1 commit from samaBR/Longshot:feat/teleport-places into main
First-time contributor

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.

  • renderer: gpu/vk/vk_menu.cpp the Teleport page (places, pictures, Retake picture, the "picture saved" line),
    gpu/vk/oot_tp_places.h and oot_tp_places_data.h the places, gpu/vk/oot_teleport_capture.h the pictures (a worker
    writes one file a place in teleport_pictures/), gpu/vk/vk_replay.cpp teleport_capture (the middle of the picture
    at 480x270, at present time).
  • host: host/hos_main.c oot_capture_tick (Link settled at a place) and the places' arrival (entrance event, story
    flags).
  • build: nx2/teleport_places.py reads the places' positions, arrival events and story flags from the player's own maps
    into teleport_places.bin (nx2/make_game.py); without it the places arrive with the plain event and take no pictures.
  • menu text in the 13 languages; README.

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: ... fps and vi: ... frames presented lines of longshot_log.txt across the play session, teleporting
to 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

Before: main @ aa95d35f After: this PR @ b27ed3c9
fps in play, Debug tools on, pictures taken n/a 60.0 (cap)
fps in play, Debug tools off 60.0 (cap) 60.0 (cap)
[hos host] menu: Teleport places: 190 of 190 from teleport_places.bin
[hos host] menu: Teleport to From the Lost Woods (Kokiri Forest), adult
[hos host] menu: Teleport screenshot of From the Lost Woods (KokiriForest_Adult#0) taken (2 in memory)
[hos host] menu: Teleport screenshot of Minuet of Forest warp (SacredForestMeadow_Adult#2) taken (3 in memory)
[hos host] vk: 8880 presents, 60.0 fps; a frame: 1119 draws (0 skipped), 65 dispatches, 152 passes, 136 barriers, 6 submits
[hos Presentation Thread] vi: 8799 frames presented (60.0 fps over the last 5.0 s, interval 1)

Flags and settings

No new menu row: the pictures are taken whenever the Debug tools are on. One key setting, documented in the README.

Flag What it is Before this PR After this PR Effect Helps / doesn't help / untested Recommendation
option id 63 (HOS_OPT_TELEPORT_PICTURES; 59 and 61 are main's, 60 and 62 the item wheel's) the host asks whether pictures are taken none the Debug tools' state the host watches for Link settling only then n/a as is
retake_key the Retake picture key or button none none takes the picture again helps unset

Testing

Tested: python -I -B tests/run_all.py on Windows, rebased on main @ bbe421f5: the 17 that fail fail on main @
bbe421f5 too (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 of
the renderer of the rebased branch compiles. The Guide screenshots check (scripts/check_guide_screenshots.py --review-sources) fails on main @ bbe421f5 too,
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 new
places as child and adult, the pictures taken and shown, Retake picture.

Not tested: Linux, AMD and Intel GPUs, Steam Deck.

Must be tested:

  • linux: turn on the Debug tools, open Debug > Travel > Teleport, travel to a place, stay there a few seconds with the
    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.ini gains retake_key; the pictures
are written in the game folder's teleport_pictures/; teleport_places.bin is made at build time from the player's own
game; the vk ABI is unchanged.

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).
  • Measurements has a verdict, or one line saying why there is nothing to measure.
  • 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. (made with Claude Code: each commit says so)
  • A check under tests/ that reads changed source updated in this PR, not weakened.
  • Docs updated.
**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. - renderer: `gpu/vk/vk_menu.cpp` the Teleport page (places, pictures, Retake picture, the "picture saved" line), `gpu/vk/oot_tp_places.h` and `oot_tp_places_data.h` the places, `gpu/vk/oot_teleport_capture.h` the pictures (a worker writes one file a place in `teleport_pictures/`), `gpu/vk/vk_replay.cpp` `teleport_capture` (the middle of the picture at 480x270, at present time). - host: `host/hos_main.c` `oot_capture_tick` (Link settled at a place) and the places' arrival (entrance event, story flags). - build: `nx2/teleport_places.py` reads the places' positions, arrival events and story flags from the player's own maps into `teleport_places.bin` (`nx2/make_game.py`); without it the places arrive with the plain event and take no pictures. - menu text in the 13 languages; README. ## 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: ... fps` and `vi: ... frames presented` lines of `longshot_log.txt` across the play session, teleporting to 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 | | Before: main @ aa95d35f | After: this PR @ b27ed3c9 | |---|---|---| | fps in play, Debug tools on, pictures taken | n/a | 60.0 (cap) | | fps in play, Debug tools off | 60.0 (cap) | 60.0 (cap) | ``` [hos host] menu: Teleport places: 190 of 190 from teleport_places.bin [hos host] menu: Teleport to From the Lost Woods (Kokiri Forest), adult [hos host] menu: Teleport screenshot of From the Lost Woods (KokiriForest_Adult#0) taken (2 in memory) [hos host] menu: Teleport screenshot of Minuet of Forest warp (SacredForestMeadow_Adult#2) taken (3 in memory) [hos host] vk: 8880 presents, 60.0 fps; a frame: 1119 draws (0 skipped), 65 dispatches, 152 passes, 136 barriers, 6 submits [hos Presentation Thread] vi: 8799 frames presented (60.0 fps over the last 5.0 s, interval 1) ``` ### Flags and settings No new menu row: the pictures are taken whenever the Debug tools are on. One key setting, documented in the README. | Flag | What it is | Before this PR | After this PR | Effect | Helps / doesn't help / untested | Recommendation | |---|---|---|---|---|---|---| | option id 63 (`HOS_OPT_TELEPORT_PICTURES`; 59 and 61 are main's, 60 and 62 the item wheel's) | the host asks whether pictures are taken | none | the Debug tools' state | the host watches for Link settling only then | n/a | as is | | `retake_key` | the Retake picture key or button | none | none | takes the picture again | helps | unset | ## Testing **Tested:** `python -I -B tests/run_all.py` on Windows, rebased on `main` @ bbe421f5: the 17 that fail fail on `main` @ bbe421f5 too (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 of the renderer of the rebased branch compiles. The Guide screenshots check (`scripts/check_guide_screenshots.py --review-sources`) fails on `main` @ bbe421f5 too, 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 new places as child and adult, the pictures taken and shown, Retake picture. **Not tested:** Linux, AMD and Intel GPUs, Steam Deck. **Must be tested:** - linux: turn on the Debug tools, open Debug > Travel > Teleport, travel to a place, stay there a few seconds with the 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.ini` gains `retake_key`; the pictures are written in the game folder's `teleport_pictures/`; `teleport_places.bin` is made at build time from the player's own game; the vk ABI is unchanged. ## 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] Measurements has a verdict, or one line saying why there is nothing to measure. - [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. (made with Claude Code: each commit says so) - [x] A check under `tests/` that reads changed source updated in this PR, not weakened. - [x] Docs updated.
feat(menu): many places on the Teleport page, each with a picture taken in your own game
Some checks failed
PR description / Description follows the template (pull_request_target) Successful in 5s
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
b27ed3c92f
The Debug tab's Teleport page lists the Fast Travel's places (positions, arrival events and story flags read from the
player's own maps by nx2/teleport_places.py) beside the maps it had, and shows 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 (a worker writes one file a place in
teleport_pictures/; nothing is shipped). Retake picture (a key or button of the player's choice, option id 59) takes it again.
Only with the Debug tools on. In the menu's 13 languages.

Ported from Hookshot (Teleport pictures and its places).

Feito com Claude Code
samaBR force-pushed feat/teleport-places from b27ed3c92f
Some checks failed
PR description / Description follows the template (pull_request_target) Successful in 5s
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 4400bb2458
Some checks failed
PR description / Description follows the template (pull_request_target) Successful in 5s
Website / Website on Cloudflare (pull_request_target) Has been skipped
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 19:48:02 +00:00
Compare
Author
First-time contributor

Rebased onto main @ 16d87c83: one conflict in vk_replay.cpp (teleport_capture kept after main's shot_ask_record with its CRT headless picture; the Teleport pictures stay the window's picture). The game-free checks fail in the same 19 as main, the renderer of the rebased branch builds, and the Guide screenshots check fails on main too (this PR adds vk_ui.h to its review list).

Rebased onto `main` @ 16d87c83: one conflict in vk_replay.cpp (`teleport_capture` kept after main's `shot_ask_record` with its CRT headless picture; the Teleport pictures stay the window's picture). The game-free checks fail in the same 19 as `main`, the renderer of the rebased branch builds, and the Guide screenshots check fails on `main` too (this PR adds vk_ui.h to its review list).
samaBR force-pushed feat/teleport-places from 4400bb2458
Some checks failed
PR description / Description follows the template (pull_request_target) Successful in 5s
Website / Website on Cloudflare (pull_request_target) Has been skipped
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
to 04a2877118
Some checks failed
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
Website / Website on Cloudflare (pull_request) Has been cancelled
2026-11-15 22:21:11 +00:00
Compare
Author
First-time contributor

Rebased onto main @ 79b1fd8f: only gpu/vk/menu_i18n.h conflicted (the per-language counts, recounted). The game-free checks fail in the same 21 as main @ 79b1fd8f, the renderer of the rebased branch builds, and the Guide screenshots check fails on main too.

Rebased onto `main` @ 79b1fd8f: only gpu/vk/menu_i18n.h conflicted (the per-language counts, recounted). The game-free checks fail in the same 21 as `main` @ 79b1fd8f, the renderer of the rebased branch builds, and the Guide screenshots check fails on `main` too.
samaBR force-pushed feat/teleport-places from 04a2877118
Some checks failed
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
Website / Website on Cloudflare (pull_request) Has been cancelled
to 33fa6f2456
Some checks are pending
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
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
PR description / Description follows the template (pull_request_target) Successful in 4s
2026-11-16 05:33:45 +00:00
Compare
Author
First-time contributor

Rebased onto main @ bbe421f5. Option 59 is now main's transition autosave (and 61 its Invert mouse horizontal; 60 and 62 are the item wheel's), so HOS_OPT_TELEPORT_PICTURES is 63. The other conflicts keep both sides: the Retake picture row with main's Autosave row in the tests, its retake_key with 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 as main @ bbe421f5, the renderer of the rebased branch builds, and the Guide screenshots check fails on main too.

Rebased onto `main` @ bbe421f5. Option 59 is now `main`'s transition autosave (and 61 its Invert mouse horizontal; 60 and 62 are the item wheel's), so `HOS_OPT_TELEPORT_PICTURES` is 63. The other conflicts keep both sides: the Retake picture row with `main`'s Autosave row in the tests, its `retake_key` with 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 as `main` @ bbe421f5, the renderer of the rebased branch builds, and the Guide screenshots check fails on `main` too.
Some checks are pending
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
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
PR description / Description follows the template (pull_request_target) Successful in 4s
This pull request has changes conflicting with the target branch.
  • gpu/vk/menu_i18n.h
  • gpu/vk/vk_menu.cpp
Some workflows are waiting to be reviewed.
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.
git fetch -u 'feat/teleport-places:samaBR-feat/teleport-places'
git switch 'samaBR-feat/teleport-places'
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
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!823
No description provided.