controller config stuff

[briaguya-ai]

I made an issue for discovery around how to better support the controller mapping/configuration needs of any given port with LUS Kenix3/libultraship#342

after some discussion, the idea of just having a list like source engine games do came to mind, it's not perfect, and it could be considered an "advanced" configuration menu, but i figured it'd be worth it to mock up what that might look like (in text form)

what we could do is a collapsible list, so something like this (the [Set] thing would be a button like we have in the current menu that shows the mapped name, with the ability to map multiple things (maybe using shift-click like pcsx2))

> Start/Pause (N64 Start) [Set]
> Talk to Navi (N64 C^) [Set]
> Movement Controls
  > Map analog X [Set] (i'm thinking being able to automatically set both left and right could be cool) 
    > Left [Set]
    > Right [Set]
  > Map analog Y [Set]
    > Forward [Set]
    > Back [Set]
  > Analog movement configuration
    > Deadzone
      > [Deadzone control w/ preview]
    > Virtual Notches
      > [notch slider (maybe w/ preview)]
  > Modifiers
    > Walk speed modifier 1 [Set]
    > Walk speed modifier 2 [Set]
> Action Controls
  > Action (N64 A) [Set]
  > Sword (N64 B) [Set]
  > Shield (N64 R) [Set]
  > Items
    > Original (N64 C < v >)
      > Left [Set]
      > Right [Set]
      > Down [Set]
    > Additional (dpad) [(enable/disable checkbox?)]
      > Left [Set]
      > Right [Set]
      > Up [Set]
      > Down [Set]
      > Assign modifier (only appears when dpad support in pause screen enabled)
> Ocarina Controls
  > D4 (N64 A) [Set]
  > F4 (N64 Cv) [Set]
  > A4 (N64 C>) [Set]
  > B4 (N64 C<) [Set]
  > D4 (N64 C^) [Set]
  > Disable songs (N64 L) [Set]
  > Pitch up (N64 R) [Set]
  > Pitch down (N64 Z) [Set]
> Menu Controls (this section will probably need some work, not sure how to handle it)
  > (not sure how to best handle this, relying on shift-click to map dpad and analog feels like a step backwards, i think if we continue to have a "simple" mapping option that just directly goes from physical controller button to n64 button this can be autofilled decently well based on that, so having 2 could work)
  > Analog
    > X [Set]
      > Left [Set]
      > Right [Set]
    > Y [Set]
      > Up [Set]
      > Down [Set]
  > Digital [(enable/disable dropdown? disabled/pause screen only/text boxes only/text boxes and pause screen?]
    > Left [Set]
    > Right [Set]
    > Up [Set]
    > Down [Set]
  > Confirm (N64 A) [Set]
  > Cancel (N64 B) [Set]
  > Hold to skip [Set]
  > Allow cursor on any slot [(dropdown)]
> Camera Controls
  > Target (N64 Z) [Set]
    > [Toggle/Hold] (i figure we can make this a dropdown and have it here since it's a global setting not per-save)
  > Enter first-person (N64 C^) [Set]
  > Aiming
    > Aiming analog X [Set]
      > Left [Set]
      > Right [Set]
    > Aiming analog Y [Set]
      > Up [Set]
      > Down [Set]
    > Gyro aiming [(enable/disable checkbox)]
      > (no idea what needs to be in here)
    > (maybe something splitting shield aiming from the rest of it? we have separate settings right now)
    > (i think we can skip invert options as this would allow mapping up/down/left/right for aiming however people want)
    > Aim sensitivity [(maybe enable checkbox, probably don't need to have a checkbox though)]
      > Horizontal [(maybe just have a "default button here, that way we don't need an enable checkbox)]
        > [Sensitivity slider]
      > Vertical [(maybe just have a "default button here, that way we don't need an enable checkbox)]
        > [Sensitivity slider]
    > Auto centering [(checkbox, default enabled)]
  > Free Camera [(enable/disable checkbox)]
    > X [Set]
      > Left [Set] (probably need to be more specific about this, as this could mean "move the camera that is behind link to the left" or "make the camera behind link move to a position where we can see stuff to the left")
      > Right [Set]
    > Y [Set]
      > Up [Set]
      > Down [Set]
    > Sensitivity
      > Horizontal
        > [Sensitivity slider]
      > Vertical
        > [Sensitivity slider]
    > Distance
      > [Distance slider]
    > Speed
      > [Speed slider]
> Rumble
  > (probably should have stuff about which motor and intensity in here)
> (Ivan?)
> (Debug?)

this is just a first pass, but if nothing else this really made it clear to me just how many options we have

switching away from the current "controller configuration" and "additional controller options" menus, where people need to use both, to having an advanced menu that can do everything seems like a good thing, but it'll be important to think about the basic setup ux too

mostly trying to start a conversation with this one

[briaguya-ai]

might need something about modifier keys for aiming for people playing on keyboard or controllers with only digital inputs

[briaguya-ai]

maybe font-awesome could help with this, music notes for ocarina notes could be cool

[briaguya-ai]

could be cool to have a list of connected devices at the top (maybe with a refresh button) but not a dropdown, we should just allow mapping from any of them at any time

the idea behind the list would be to help people figure out if the game was seeing their controller or not

[briaguya-ai]

another thing to think about in here is deadzone (and future analog calibration options), i'm not sure if we have any way to uniquely identify controllers that have been disconnected and reconnected (to be able to tell the difference between a new xbox controller and one that has a worn out joystick for example) so that's probably worth looking into

assuming we figure the unique id part out, we could either have any of the deadzone etc. sections either

• include a subsection for each connected controller with the settings
• have a dropdown to pick a controller to apply the settings to

this is also a question that applies to Kenix3/libultraship#342, so any thoughts about how to handle this in a future LUS generic controller options menu would be cool too

[jbodner09]

Ocarina input also needs a cancel button

[briaguya-ai]

Ocarina input also needs a cancel button

good call, also need to add shooting gallery/bombchu bowling stuff (maybe just "minigame item")

[briaguya-ai]

and epona stuff

• shooting
• carrots

[briaguya-ai]

show/hide map (N64 L) is another missing one

[briaguya-ai]

thinking about how to handle the basic/advanced split and i think doing it all in one window should be possible

> Basic
  > All? the n64 buttons. maybe not dpad because that's not useful without advanced configuration
  > Analog stick (just the one)
    > not sure how to keep this simple while also providing the calibration etc. options people need
    > maybe just point people to advanced to set up aim vs movement sensitivity?
    > don't want to overwhelm with virtual notches and deadzone settings and things, but also don't want to hide those settings
> Advanced
  > everything from original post/previous comments

this also got me thinking about how to handle the UX for displaying mappings, i know we currently update the text of the button to match the button matched on the controller, but maybe moving away from that to something like

n64 button (in basic)/action (in advanced)	things we can do in this menu	mappings
N64 A	[set]
N64 A	[set] [clear]	xbox A
N64 A	[set] [clear]	xbox A, xbox B
N64 A	[clear]	advanced

i think this could handle all the possible scenarios

• if we don't have anything mapped our only button is "set"
• if we have one or more buttons mapped to a basic button we can set or clear
  • not sure if we want to force people to clear and treat "set" as "add", or if we want to do something like pcsx2 and do shift+click to add additional bindings (maybe switch the "set" button to say "add" when shift is held?)
  • maybe something about removing from the multiple individually would make sense, but that could make things quite complex
• now for the complex one, the "advanced" state for basic buttons
  • this would not be set if
    • the mapping had only been done via basic OR
    • all of the advanced mappings for actions that default to that n64 button are the same
  • this means it would only be set if there were actions that default to that n64 button that mapped to different physical buttons
    • in this state, we would want to only show the "clear" button, and ideally have a warning message "clearing this will clear some of your advanced controller mappings, are you sure?" or something

[briaguya-ai]

another thing that could be really helpful for simple mapping would be presets/profiles

we could probably make these for some of the most common/popular controllers

• xbox one/series
• ps4/ps5
• switch pro

the hardest part of these imo would be naming, unlike pcsx2 where automapping is going to a ps2 controller (which already has a layout that matches the controllers being automapped), we'd need to have options for sword on xbox X vs sword on xbox b vs sword on xbox A etc

it might be something where built-in presets don't make sense, and we'd instead want to have a repo of dev/user generated ones and a way to load them or something

at the same time, we already have a concept of "default" so people can get up and running without needing to manually map, so maybe having some built-in (or just "included") wouldn't be a bad thing

[briaguya-ai]

basic and advanced could also be tabs instead of separate collapsible sections in a big list

i'm still very unsure about where to put analog stick calibration stuff, some of it makes sense in the advanced sections as it's directly related to actions (aiming sensitivity etc.), but some of it feels more like "i just need my stick to work" stuff, in which case i feel like having it on a separate tab entirely might make sense. any thoughts there are very welcome.

[briaguya-ai]

another thing to think about is how to handle someone mapping the same physical button to multiple things. do we want to clear out where it was mapped before? i'm leaning towards moving away from the current strategy of clearing out where it was mapped before, and instead just allowing multiple actions (or n64 buttons) to be mapped to one physical button.

[briaguya-ai]

ocarina analog stick pitch

[inspectredc]

would we want this go into allowing for binding hotkeys for certain features as well, e.g. fullscreen, toggling collision viewer? or just in-game actions

[inspectredc]

for debug, actions that come to mind are debug camera movements + toggling the camera, frame advancing, navigating pause warp menu, skip cutscene

[briaguya-ai]

would we want this go into allowing for binding hotkeys for certain features as well, e.g. fullscreen, toggling collision viewer? or just in-game actions

possibly. i'm not sure if that would fit in as a subcategory of "advanced," or if we go the multiple tabs route we might want to have it be a third tab (so we'd have "basic", "advanced", "hotkeys")

edit: the other option would be to have hotkeys as their own menu separate from this

[briaguya-ai]

heavily leaning towards multimapping being the default behavior of the "set" button, and requiring users to hit clear to reset a button

this could probably be aided by having a "full clear" option of some sort somewhere

[jbodner09]

multimapping in the other direction (letting multiple buttons perform the same action) would make a lot of people happy since "can we have multiple buttons perform the same action" has been a request since forever, so having it be consistent and the default behavior sounds like the right call.

[briaguya-ai]

@jbodner09 i touched on UX for that here #3215 (comment)

edit: sorry for the ping, i was going fast and just noticed you said

so having it be consistent and the default behavior sounds like the right call.

[briaguya-ai]

"can we have multiple buttons perform the same action" has been a request since forever

i'm very aware #27 (check who made the issue)

[briaguya-ai]

i think using tabs instead of multiple sections is the move. to start we'd just have basic and advanced, and then we can add a tab for hotkeys/macros? (not sure about naming there)

the main reasoning here is that i expect the hotkeys ux to be a little different. having every single thing that can be hotkeyed in a giant list feels pretty bad, so we'd want to have a default set (reset etc.) that always appear, and then the ability to add more.

we'd also want to have the ability to require multiple buttons be pressed at once to trigger these, which isn't a pattern we need in the basic and advanced tabs.

one of the main focuses of that tab would be the "create new hotkey" functionality, which could get as complex as allowing a sequence of console commands (think spawn enemies), while also providing a decently straightforward/simple UX for toggling existing cvars (ideally using the same names that are shown in the menus, instead gMyCvarName)

[Pepe20129]

for debug, actions that come to mind are debug camera movements + toggling the camera, frame advancing, navigating pause warp menu, skip cutscene

also the registry editor and the debug menus that it can enable (like audio debugger)