Guides:SteamVR Bindings: Difference between revisions
m (Collapsed glossary sections) |
(Some more table edits & Added controller info) |
||
| Line 214: | Line 214: | ||
|vector2 | |vector2 | ||
| | | | ||
|- | |||
! colspan="5" |Advanced Controls | |||
|- | |- | ||
|Start Move (Advanced) | |Start Move (Advanced) | ||
|Global | |Global | ||
|When this is clicked, begin moving. | |When this is clicked, begin moving. | ||
|boolean | |boolean | ||
|optional | |optional | ||
| Line 241: | Line 243: | ||
|No_Gesture_After_Move | |No_Gesture_After_Move | ||
|Global | |Global | ||
|Prevents | |Prevents gesture wheel touches after Start move click is released | ||
|boolean | |boolean | ||
|optional | |optional | ||
| Line 247: | Line 249: | ||
|No_Gesture_After_Rotate | |No_Gesture_After_Rotate | ||
|Global | |Global | ||
|Prevents gestures after Start rotate click is released | |Prevents gestures wheel touches after Start rotate click is released | ||
|boolean | |boolean | ||
|optional | | optional | ||
|- | |- | ||
! colspan="5" | | ! colspan="5" |Other | ||
|- | |- | ||
|Toggle Microphone | |Toggle Microphone | ||
| Line 271: | Line 273: | ||
|optional | |optional | ||
|- | |- | ||
|Toggle HUD | | Toggle HUD | ||
|Global | |Global | ||
|Toggles the hud | |Toggles the hud | ||
| Line 296: | Line 298: | ||
|- | |- | ||
|Open Camera | |Open Camera | ||
|Global | | Global | ||
|Toggles the camera | |Toggles the camera | ||
|boolean | |boolean | ||
| Line 304: | Line 306: | ||
|Global | |Global | ||
|Activates Safe mode | |Activates Safe mode | ||
|boolean | |boolean | ||
|suggested | |suggested | ||
|- | |- | ||
| Line 310: | Line 312: | ||
|Global | |Global | ||
|When active, trigger AFK in VRChat | |When active, trigger AFK in VRChat | ||
|boolean | |boolean | ||
|optional | |optional | ||
|- | |- | ||
! colspan="5" |One Handed | ! colspan="5" |One Handed | ||
|- | |- | ||
|Move & Rotate (One Handed) | |Move & Rotate (One Handed) | ||
|One_Hand | |One_Hand | ||
|Combined movement & rotation | | Combined movement & rotation | ||
|vector2 | |vector2 | ||
|suggested | |suggested | ||
|- | |- | ||
| Line 331: | Line 333: | ||
|When Start Move & Rotate released, continue as long as this is active. | |When Start Move & Rotate released, continue as long as this is active. | ||
|boolean | |boolean | ||
|optional | |optional | ||
|- | |- | ||
|No_Gesture_After_Move_Rotate | |No_Gesture_After_Move_Rotate | ||
|One_Hand | |One_Hand | ||
|Prevents gestures afterMove & Rotate is released | |Prevents gestures afterMove & Rotate is released | ||
|boolean | | boolean | ||
|optional | |optional | ||
|- | |- | ||
! colspan="5" |Udon | ! colspan="5" |Udon | ||
|- | |- | ||
|Udon Menu | |Udon Menu | ||
| Line 351: | Line 353: | ||
|Registerable by VRChat worlds with Udon. | |Registerable by VRChat worlds with Udon. | ||
|vector1 | |vector1 | ||
|optional | | optional | ||
|- | |- | ||
|Udon Grip Axis | |Udon Grip Axis | ||
| Line 362: | Line 364: | ||
|Global, 1H | |Global, 1H | ||
|Registerable by VRChat worlds with Udon. | |Registerable by VRChat worlds with Udon. | ||
|boolean | |boolean | ||
|optional | |optional | ||
|- | |- | ||
| Line 370: | Line 372: | ||
|Menu | |Menu | ||
|Clicks on menu items | |Clicks on menu items | ||
|boolean | | boolean | ||
|suggested | |suggested | ||
|- | |- | ||
| Line 426: | Line 428: | ||
|- | |- | ||
|SkeletonLeftHand | |SkeletonLeftHand | ||
|Global | | Global | ||
| rowspan="2" |Used to retrieve bone transform data from the related controllers | | rowspan="2" |Used to retrieve bone transform data from the related controllers | ||
|skeleton | |skeleton | ||
| Line 701: | Line 703: | ||
|- | |- | ||
|Gesture_Wheel_Held_Right | |Gesture_Wheel_Held_Right | ||
|Global | |Global | ||
| | | | ||
| Line 734: | Line 730: | ||
| | | | ||
|boolean | |boolean | ||
|optional | |||
|- | |||
|Disable_Gesture_Tracked | |||
|Global | |||
|(?) | |||
|boolean | |||
|optional | |optional | ||
|} | |} | ||
==Walkthroughs== | ==Walkthroughs== | ||
===Adding new inputs=== | ===Adding new inputs=== | ||
TODO | TODO | ||
=== Double tap menu=== | ===Double tap menu=== | ||
TODO | TODO | ||
=== Creating Chords=== | ===Creating Chords=== | ||
TODO | TODO | ||
| Line 756: | Line 758: | ||
TODO | TODO | ||
===DPAD overlap percentage=== | === DPAD overlap percentage=== | ||
TODO | TODO | ||
==Don'ts== | ==Don'ts== | ||
There's certain things you can do to bindings that can cause issues. Try to avoid them when possible | There's certain things you can do to bindings that can cause issues. Try to avoid them when possible | ||
| Line 766: | Line 769: | ||
[[File:Multiple actions per controller.png|alt=Bad vs Good method for multiple actions via one control source|800x800px]] | [[File:Multiple actions per controller.png|alt=Bad vs Good method for multiple actions via one control source|800x800px]] | ||
A functional use case would be setting '''action menu''' to Single and '''quick menu''' to Double; this will introduces a small delay after the single press input which can be interrupted by a double click to open the quick menu without accidentally opening the action menu. | A functional use case would be setting '''action menu''' to <code>Single</code> and '''quick menu''' to <code>Double</code>; this will introduces a small delay after the <code>single</code> press input which can be interrupted by a <code>double</code> click to open the '''quick menu''' without accidentally opening the '''action menu'''. | ||
==Controller info & fixes== | ==Controller info & fixes== | ||
=== | ====Can't do gestures at all==== | ||
By default coming into the Input 2.0 update, gestures were set to disabled. You can enable them in them in the [[Action Menu]]. | |||
<code>Path: [[Action Menu]] ➜ [[Action Menu|Options]] ➜ [[Action Menu|Avatar]] ➜ Gestures</code> | |||
TODO: GIF navigating to toggle | |||
====Double tap is opening the Main Menu==== | |||
This feature was introduced with Input 2.0. You can disable it in the [[Settings#Controls|Controls]] section of the [[Main Menu]] | |||
TODO: Location of toggle in context | |||
====Disabling finger tracking==== | |||
Skeletal based finger tracking is enabled by default for all controller types. You can disable it in the [[Settings#Controls|Controls]] section of the [[Main Menu]] | |||
TODO: Location of toggle in context | |||
=== | ===Reverting to old finger tracking=== | ||
If you prefer the old finger tracking method, navigate to the [[Action Menu#Quick Actions|Quick Actions]] section of the [[Action Menu]] and enabling Legacy fingers. <sup>(this will need to be done on a per-avatar basis)</sup> | |||
<code>Path: [[Action Menu]] ➜ [[Expressions]] ➜ [[Action Menu|Quick Actions]] ➜ Legacy Fingers</code> | |||
TODO: GIF navigating to toggle | |||
TODO: | |||
====Default & Community bindings==== | ====Default & Community bindings==== | ||
| Line 786: | Line 803: | ||
TODO: Link to SteamVR beta for a fix on community bindings (remove later when fixed) | TODO: Link to SteamVR beta for a fix on community bindings (remove later when fixed) | ||
====Hard bindings reset ==== | ====Hard bindings reset==== | ||
In rare cases, a full hard reset of your bindings may be needed due to issues with SteamVR. | In rare cases, a full hard reset of your bindings may be needed due to issues with SteamVR. | ||
| Line 814: | Line 831: | ||
===Index=== | ===Index=== | ||
====Easier | ====Easier Object holding==== | ||
===HP Reverb G2=== | ===HP Reverb G2=== | ||
Revision as of 09:35, 29 August 2024
[Reason: No reason provided.]
SteamVR input is a universal keybind system for all controllers usable in SteamVR. Instead of binding keys like "space" to jump, VR game developers provide actions we can directly bind to inputs on SteamVR controllers. The UI also provides a way for users to find or share community bindings. [1]
Official VRChat SteamVR Input 2.0 documentation[2]
Official VRChat SteamVR input 2.0 FAQ[3]
Where
Standard method
- Open SteamVR
- Find Settings
- Select Controllers
- Set Advanced Setting to Show
- Select Show Binding UI
- Select VRChat from the list of applications
Via web browser
- Go to http://localhost:27062/dashboard/controllerbinding.html while SteamVR is running
- Select
VRChatfrom the list of applications
Via VRChat
Glossary
| Terms | Explanation |
|---|---|
| Bindings | A complete set of bindings between inputs and actions that can be saved and shared in the Steam Workshop. |
| Action | Behavior that can be bound to inputs or chords, like movement, selection, or bringing up the camera or personal mirror. |
| Action set | A group of actions that corresponds to a specific context, like using the menu or action menu, or global actions that are available in any context. |
| Control source | A specific physical actuator on a controller, like a joystick, trigger, button, or trackpad. |
| Control source mode
(Use control as) |
A mapping that defines how a control source's movements or sensors are interpreted as inputs.
For example, a trackpad can be mapped as dpad or a button, and a joystick can be mapped as joystick or scroll wheel. |
| Input | A specific movement or sensor reading from a control, interpreted through a control source mode.
For example, a button's control source mode might provide touch, press, hold, or double-press inputs. |
Mostly from the official docs but with some edits for clarity.
Control Source Modes
| Control Source Mode | ExpandProvided Inputs |
|---|
Inputs
| Input | Usage | Types | ExpandControl Source |
|---|
Actions
Every bindable Action for SteamVR controllers in VRChat. Found in VRChat\VRChat_Data\StreamingAssets\SteamVR\actions.json (Descriptions are community created)
| Action | Action Set | Description | Type | ExpandRequirement |
|---|
Walkthroughs
Adding new inputs
TODO
TODO
Creating Chords
TODO
Dead zones
TODO
Trigger thresholds
TODO
Changing haptics
TODO
DPAD overlap percentage
TODO
Don'ts
There's certain things you can do to bindings that can cause issues. Try to avoid them when possible
Multiple actions per control source
When you bind multiple actions like this, it stops them from functioning instantaneously and can make them unpredictable. [1]
A functional use case would be setting action menu to Single and quick menu to Double; this will introduces a small delay after the single press input which can be interrupted by a double click to open the quick menu without accidentally opening the action menu.
Controller info & fixes
Can't do gestures at all
By default coming into the Input 2.0 update, gestures were set to disabled. You can enable them in them in the Action Menu.
Path: Action Menu ➜ Options ➜ Avatar ➜ Gestures
TODO: GIF navigating to toggle
Double tap is opening the Main Menu
This feature was introduced with Input 2.0. You can disable it in the Controls section of the Main Menu
TODO: Location of toggle in context
Disabling finger tracking
Skeletal based finger tracking is enabled by default for all controller types. You can disable it in the Controls section of the Main Menu
TODO: Location of toggle in context
Reverting to old finger tracking
If you prefer the old finger tracking method, navigate to the Quick Actions section of the Action Menu and enabling Legacy fingers. (this will need to be done on a per-avatar basis)
Path: Action Menu ➜ Expressions ➜ Quick Actions ➜ Legacy Fingers
TODO: GIF navigating to toggle
Default & Community bindings
TODO: guide to the binding select page with an image.
TODO: Link to SteamVR beta for a fix on community bindings (remove later when fixed)
Hard bindings reset
In rare cases, a full hard reset of your bindings may be needed due to issues with SteamVR.
TODO
Vive
Vive is a little special, two default binding modes are available with different feature sets. (TODO: write about them)
No touch to move / Emotes are "sticky"
It's likely that you previously used Vive Advanced controls before Input 2.0. You can restore Advanced behavior you're used to by switching from Default Bindings over to the Default Advanced Bindings which can be found on the bindings select page.
Difficulty moving
The default thresholds for movement on Vive controllers require you to hit the very edges of the touchpad. This can be changed by adjusting Dead zones.
TODO: Recommended values for Simple & Advanced
Accidental jumping
With a mix of adjustments to Overlap percentage & Dead zone on the Trackpad DPADs, you can restore pre-Input 2.0 behavior.
TODO: Recommended values for both
Grip isn't doing hand open / Isn't clearing gestures
This seems to be an oversight with Vive Advanced Bindings, you'll need to add the Gesture_wheel_cancel_open_left & right actions to your grips as a Button press inputs.
TODO: image showing what the newly added button should look like
Index
Easier Object holding
HP Reverb G2
TODO: More controller types, need users with more experience on other types.
