WIP: feat(gameplay): a Run speed slider (100% to 200%) #1231
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!1231
Loading…
Reference in a new issue
No description provided.
Delete branch "TrashPanda/Longshot:feat/run-speed"
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: Windows, any GPU
Why
Players who want Link to cross the world faster, for example over Hyrule Field, have only the Debug tab's Movement speed. It shows only with the debug tools on, offers five fixed steps (1x to 3x) and is back to 1x at every start. This adds Gameplay → Run speed, a saved slider any player can use without turning on the debug tools. No issue asks for this exactly (searched "run speed", "movement speed", "sprint"); the nearest is a sprint toggle. See #1005.
What changed
A Gameplay row, Run speed, from 100% to 200% in steps of 5 and 100% (original) by default, makes Link run, walk and swim faster while the player steers him. It uses the speed scaling Movement speed already has, so it inherits that feature's limits: only Link's own character controller, only while the left stick is pushed, and only for speeds up to 15 m/s. Cutscenes, scripted walks and ledge climbs keep their pace, and the physics step still stops him at walls.
oot_speed_choice()andoot_player_speed()inhost/hos_main.cpick the Debug tab's Movement speed when it is above 1x (it sends 100 while the tools are off), else Run speed. Anything outside 100 to 200 counts as 100. The log names which row chose:gameplay: run speed 150%orcheats: movement speed 200%.gpu/vk/vk_menu.cppis a slider that stops at its ends (is_slider,stops_at_ends) and usestx_fov's "100% (original)" label.opts.run_speedingpu/vk/vk_menu.his saved asrun_speedinlongshot_options.ini.vk_replay.cpp's option callback answersHOS_OPT_RUN_SPEED.HOS_OPT_RUN_SPEED = 96ingpu/vk/vk_api.h. Every id from 62 to 71, plus 80, 88 and 90, is taken by an open pull request (checked across every PR head), so 96 stays clear of them. Only the existing option callback changes, so there is noMKWVK_API_VERSIONbump.gpu/vk/menu_i18n.h, machine-made like the rest).docs/development.md's options-file table.tests/test_run_speed.pycutsoot_speed_choice()from the source and runs it: Run speed alone, out-of-range values, Movement speed above 1x first, and Movement speed at 1x or out of range. It also reads the id, the row (range, step, live, no restart), the default, the slider, the saved key, the README line, and that onlyhost/hos_main.creads the option.Measurements
Verdict: it works as set. Over a fixed 90-frame stick hold, Link covers 1.47x the distance at 150% and 1.92x at 200%, with no change at 100%. The ratios fall a little short of 1.5 and 2 because each hold starts from a standstill and includes his acceleration.
Hardware: Ubuntu 26.04.1 LTS, kernel 7.0.0-43; RTX 4070 Ti 12 GB, NVIDIA 595.99.02; Ryzen 7 9800X3D, 32 GB
Scene: Hyrule Field (child), reached by the control bridge's teleport; headless, 1920x1080, the game folder's options, Debug tools Off
Method: through
scripts/longshot_ctl.py,option set run_speed N, then the left stick held forward for 90 frames and back for 90, measuring Link's horizontal distance fromstatus'spos. 100, 150 and 200% were run interleaved, twice each, 4 holds per setting; the table shows the median (the holds agree within 0.6 m).Baseline: Run speed at 100% on the same build, interleaved with the other settings in one session; at 100% the scaling returns before touching the speed, so this is main's movement.
How to reproduce: any save in Hyrule Field; Gameplay → Run speed at 100%, 150% and 200%; hold forward for 1.5 s at each.
b402d18eb402d18eb402d18eNo frame-rate effect is expected: the change is a multiply on one float, made only when Link's controller sets its speed.
Flags and settings
One new menu row and ini key; the default leaves Link's speed unchanged.
run_speedTesting
Tested:
make_game.pyand ran it headless through the control bridge. Hyrule Field, the stick held at 100, 150 and 200%: numbers above, the log naming each change, no device loss or Vulkan error. The run is recorded indocs/tested/2026-11-16-run-speed-trashpanda-field1.md. The build was made on main615b2498, just before this rebase onto623a0ca3; the feature's code is the same.scripts/screenshots' fixture, extended locally to the Gameplay tab and not committed (picture in the first comment).python -I -B tests/run_all.pyon Linux: the newtests/test_run_speed.pyand the checks it touches (test_option_ids,test_movement_speed,test_menu_i18n,test_readme_menu_rows,test_camera_speed,test_oot_fov,test_menu_keys,test_tested_configurations) pass. After the rebase onto623a0ca3: 649 passed, 24 failed, 21 skipped. 23 of the 24 fail the same on main623a0ca3on this PC (test_walk_key,test_damage_debug_menu,test_upscaler_rows,test_linux_preflight,test_make_game_cacheand others). The 24th,test_crash_record, failed only inside the full parallel run and passes alone, 3 runs of 3.Not tested:
Must be tested:
gameplay: run speed 150%inlongshot_log.txt(Test Farm: @Beanstalk windows, set Gameplay Run speed to 150% and run in Hyrule Field).Risks
What could break: Link's movement while Run speed is above 100%: a room or puzzle timed around his running speed, or a narrow ledge he now overshoots. At 100%, the default, nothing changes: the scaling returns before touching the speed.
Turning it off: Run speed at 100% (original), or revert the commit.
Compatibility: A new
run_speedline inlongshot_options.ini; older builds ignore it. Saves, shader and pipeline caches and the vk ABI (MKWVK_API_VERSION) are unchanged.Checklist
Everyone
type(scope): description) of the status line's type.can't be run by hand is in Testing's Not testable by hand, with why.
in Risks.
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
docs/tested/for each new measured run (format indocs/tested-configurations.md).Players who want Link to cross the world faster had only the Debug tab's Movement speed: shown only with the debug tools on, in five fixed steps, and back to 1x at each start. Gameplay's Run speed is a saved slider any player can use. - Gameplay -> Run speed, 100% to 200% in steps of 5, 100% (original) the default, saved as run_speed; it applies at once. - host/hos_main.c: oot_player_speed takes the Debug tab's Movement speed when it is above 1x, else Run speed (HOS_OPT_RUN_SPEED, 96: 62 to 90 are taken by open pull requests). The scaling is the one Movement speed already has: Link's controller only, only while he is steered, only up to 15 m/s, so cutscenes and ledge climbs keep their pace. The log says which row chose ("gameplay: run speed N%"). - The row's texts in the 13 menu languages; README and the options file table. - tests/test_run_speed.py: the choice between the two rows, cut from the source and run, and the row, default, slider, saved key and README line. The option callback answers the new id; MkwVkHost and MkwVkRenderer are unchanged, so no MKWVK_API_VERSION bump.Tested in game: Linux (Ubuntu 26.04.1, kernel 7.0.0-43), RTX 4070 Ti, NVIDIA 595.99.02, headless through the control bridge: Hyrule Field (child), Run speed set to 100/150/200% twice each, the left stick held 90 frames forward and back. Median distance per hold 6.29 m / 9.28 m (1.47x) / 12.11 m (1.92x); the log named each change (gameplay: run speed N%); no device loss or Vulkan error. Built on main
615b2498just before rebasing onto623a0ca3(same feature code).Gameplay → Run speed, this PR @
b402d18e, set to 150% (rendered game-free from the menu's own code withscripts/screenshots' fixture, extended locally to the Gameplay tab; not committed):Brought up to the ready-for-review standard (#1454): the checklist's Everyone list has two new boxes, added here from what this PR's description and comments show (please check they match what you know).
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.