WIP: fix(input): custom ocarina note buttons count with the controller in the background #1168
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!1168
Loading…
Reference in a new issue
No description provided.
Delete branch "TrashPanda/Longshot:fix/background-ocarina-remaps"
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: fix · Risk: low · Tested on: Linux, RTX 4070 Ti (game-free checks) · Needs: Windows, any GPU
Why
With "Controller in background" on, the controller works behind another window, except the ocarina notes bound to custom buttons: those were dropped, so the ocarina could not be played that way.
Restored from Hookshot 2944, by jarynclouatre, and split out of #286 so it can be reviewed and merged on its own.
How to reproduce
Seen on: any OS, a controller
Settings and switches: Controller in background on; an ocarina note bound to a custom button
Steps: put another window in front and play that note on the controller
Expected: the note plays
Actual: nothing plays
What changed
oc_pad_wordgives the remapped notes in the background when the pads count there, by the same ruleread_inputuses (pads_behind). The keyboard's note keys still count only with the window in front.Commits, each with its original author and message:
428c40cdfix(input): custom ocarina note buttons count with the controller in the background (jarynclouatre)With "controller in the background" on (
HOS_INPUT_BACKGROUND=1or themenu's row), the pads reach the game behind another window, but an
ocarina note bound to a custom pad button did not:
oc_pad_wordreturned the game's word unchanged whenever the window was not in front,
so the remapped notes were dropped while the rest of the pad worked.
oc_pad_wordgives the notes in the background when the pads countthere, by the same rule
read_inputuses (pads_in_backgroundon theswitch, else the menu's row), through a small
pads_behindhelper.oc_notestakes the keyboard's note keys only with the window infront, so a key held in another program never plays a note. The pads'
note buttons count in both cases.
tests/test_ocarina_notes.py, new case: with the pads counting in thebackground, a pad's note button plays its note and the keyboard's note
key does not; without the row the word is unchanged. It fails on main
(
oc_pad_word(0)gives no L), and passes here.tests/test_input_background.py: its fixture takes the new helper.Full suite on Linux: 442 passed, 85 skipped, 1 failed
(
test_bake_portability:zstandardis not installed on this machine;it fails the same on main).
Not tested in the game.
Restored-from: https://github.com/NotRexed/Hookshot/pull/2944
Measurements
Verdict: nothing to measure: a correctness fix off the frame path, covered by game-free checks.
Flags and settings
None.
Testing
Tested: On Linux (kernel 7.0), RTX 4070 Ti,
main@71b1edd8, this PR @428c40cd:tests/test_ocarina_notes.py,tests/test_input_background.pypass. The full suite (tests/run_all.py) has not been run on this branch yet; a comment will follow when it has.Not tested: Playing the ocarina in the game behind another window. Opened as work in progress until it runs in the game.
Must be tested:
Risks
What could break: ocarina input with the window in the background.
Turning it off: revert the commit.
Compatibility: Nothing changes.
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.third_party/untouched (a new folder with aPROVENANCE.mdinstead).python -I -B tests/run_all.pypasses (any failure that also fails onmainis named).When it applies
mainand passing here.Tested in game: Linux (Ubuntu 26.04.1, kernel 7.0.0-43), RTX 4070 Ti 12 GB, NVIDIA 595.99.02, Ryzen 7 9800X3D: this branch built together with the other 18 split from #218 and #284-#288, merged onto main @
71b1edd8(make_game.py --update, build v3.0.0-rc.5-82-g5952bb3d), then played by a scripted tour through the control bridge (scripts/memtour.py: a save loaded, Zora's Domain, the Market, Hyrule Field and Death Mountain Trail, 40 s each with walking and camera swings). All 4 stops reached, a clean quit, and no device loss or Vulkan error in the log. Only scripted input ran; no controller was connected and the game was not put in the background, so the ocarina remaps in the background were not tried by hand.This and #1169 both change
tests/test_input_background.py(the functions the check cuts fromhost/nn_hid.c). Whichever merges second needs a one-line rebase there: cutpads_in_background,pads_behindandpads_merge, in that order. Both were built and run together that way (see the first comment).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
Checkout
From your project repository, check out a new branch and test the changes.