Skip to content

Unofficial OSC Documentation

Lioncat6 edited this page Jul 2, 2023 · 22 revisions

Disclaimer: This is an unofficial record of what I've learned about the VRChat OSC and its parameters. WIP

The goal of this page is to include every avatar parameter out there


All testing was done with python-osc so your results may vary across other osc platforms

Setable Parameters (Parameters that can be set from another program or app)

Parameter Path Parameter Name Parameter Description
*modified from the official wiki
1.0 indicates a Float value while 1 on its own is synonymous with True
Parameter Data Type
*guess due to non-functioning parameter
Range
*guess due to non-functioning parameter
Notes
Float values: Make sure to send the value as a Float or the game occasionally interprets it as a bool
Boolean values: You can also send 1 or 0 respectively
/input/Vertical Vertical Move forwards (1.0) or Backwards (-1.0) Float -1 to 1
/input/Horizontal Horizontal Move right (1.0) or left (-1.0)* Float -1 to 1
/input/LookHorizontal LookHorizontal Look Left and Right. Smooth in Desktop, VR will do a snap-turn when the value is 1.0 if Comfort Turning is on* Float -1 to 1
/input/UseAxisRight UseAxisRight Use held item, presumably, the one held in the right hand* bool* [True, False]* Does not work in my testing.
Tested int, Float, and bool data types on desktop
/input/GrabAxisRight GrabAxisRight Grab item, presumably, the one held in the right hand* bool* [True, False]* Does not work in my testing.
Tested int, Float, and bool data types on desktop
/input/MoveHoldFB MoveHoldFB Move a held object forwards (1.0) and backwards (-1.0)* Float -1 to 1
/input/SpinHoldCwCcw SpinHoldCwCcw Spin a held object Clockwise (1.0) or Counter-Clockwise (-1.0)* Float -1 to 1
/input/SpinHoldUD SpinHoldUD Spin a held object Up (1.0) or Down (-1.0)* Float -1 to 1
/input/SpinHoldLR SpinHoldLR Spin a held object Left (1.0) or Right (-1.0)* Float -1 to 1
/input/MoveForward MoveForward Move forward while this is 1. bool [True, False]
/input/MoveBackward MoveBackward Move backward while this is 1. bool [True, False]
/input/MoveLeft MoveLeft Move left while this is 1. bool [True, False]
/input/MoveRight MoveRight Move right while this is 1. bool [True, False]
/input/LookLeft LookLeft Turn to the left while this is 1. Smooth in Desktop, VR will do a snap-turn if Comfort Turning is on. bool [True, False]
/input/LookRight LookRight Turn to the right while this is 1. Smooth in Desktop, VR will do a snap-turn if Comfort Turning is on. bool [True, False]
/input/Jump Jump Jump if the world supports it. bool [True, False]
/input/Run Run Walk faster if the world supports it. bool [True, False]
/input/ComfortLeft ComfortLeft Snap-Turn to the left - VR Only. bool [True, False] Untested
/input/ComfortRight ComfortRight Snap-Turn to the right - VR Only. bool [True, False] Untested
/input/DropRight DropRight Drop the item held in your right hand - VR Only. bool [True, False] Untested
/input/UseRight UseRight Use the item highlighted by your right hand - VR Only. bool [True, False] Untested
/input/GrabRight GrabRight Grab the item highlighted by your right hand - VR Only. bool [True, False] Untested
/input/DropLeft DropLeft Drop the item held in your left hand - VR Only. bool [True, False] Untested
/input/UseLeft UseLeft Use the item highlighted by your left hand - VR Only. bool [True, False] Untested
/input/GrabLeft GrabLeft Grab the item highlighted by your left hand - VR Only. bool [True, False] Untested
/input/PanicButton PanicButton Turn on Safe Mode. bool [True, False]
/input/QuickMenuToggleLeft QuickMenuToggleLeft Toggle QuickMenu On/Off. Will toggle upon receiving '1' if it's currently '0'. bool [True, False] Functions the same as pressing escape on desktop
/input/QuickMenuToggleRight QuickMenuToggleRight Toggle QuickMenu On/Off. Will toggle upon receiving '1' if it's currently '0'. bool [True, False] Functions the same as pressing escape on desktop
/input/Voice Voice Toggle Voice - the action will depend on whether "Toggle Voice" is turned on in your Settings. If so, then changing from 0 to 1 will toggle the state of mute. If "Toggle Voice" is turned off, then it functions like Push-To-Mute - 1 is muted, 0 is unmuted. bool [True, False]
/chatbox/input s b n input Input text into the chatbox. If b is True, send the text in s immediately, bypassing the keyboard. If b is False, open the keyboard and populate it with the provided text. n is an additional bool parameter that when set to False will not trigger the notification SFX (defaults to True if not specified). [str, bool, bool] ...
/chatbox/typing typing Toggle the typing indicator on or off. bool [True, False]
/tracking/trackers/1/position 1/position Hip Position https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/1/rotation 1/rotation Hip Rotation https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/2/position 2/position Chest Position https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/2/rotation 2/rotation Chest Rotation https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/3/position 3/position Foot 1 Position https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/3/rotation 3/rotation Foot 1 Rotation https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/4/position 4/position Foot 2 Position https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/4/rotation 4/rotation Foot 2 Rotation https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/5/position 5/position Knee 1 Position https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/5/rotation 5/rotation Knee 1 Rotation https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/6/position 6/position Knee 2 Position https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/6/rotation 6/rotation Knee 2 Rotation https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/7/position 7/position Elbow 1 Position https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/7/rotation 7/rotation Elbow 1 Rotation https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/8/position 8/position Elbow 2 Position https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/8/rotation 8/rotation Elbow 2 Rotation https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/head/position head/position Head Position https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/trackers/head/rotation head/rotation Head Rotation https://docs.vrchat.com/docs/osc-trackers [Float, Float, Float] ... Does not function at all when using desktop Mode
/tracking/eye/EyesClosedAmount EyesClosedAmount 0~1 value for how closed the eyes are. Currently, we only support a single value simultaneously controlling the blink of both eyes. In the future, we'll add support for separate per-eye winking. Float 1 to 0
/tracking/eye/CenterPitchYaw CenterPitchYaw https://docs.vrchat.com/docs/osc-eye-tracking [Float, Float] ...
/tracking/eye/CenterPitchYawDist CenterPitchYawDist https://docs.vrchat.com/docs/osc-eye-tracking [Float, Float, Float] ...
/tracking/eye/CenterVec CenterVec https://docs.vrchat.com/docs/osc-eye-tracking [Float, Float, Float] ...
/tracking/eye/CenterVecFull CenterVecFull https://docs.vrchat.com/docs/osc-eye-tracking [Float, Float, Float] ...
/tracking/eye/LeftRightPitchYaw LeftRightPitchYaw https://docs.vrchat.com/docs/osc-eye-tracking [Float, Float, Float, Float] ...
/tracking/eye/LeftRightVec LeftRightVec https://docs.vrchat.com/docs/osc-eye-tracking [Float, Float, Float,Float, Float, Float] ...
  • Unofficial Settable Parameters - Community-made parameters that only work on supporting avatars. Suggest your own parameters in the issues tab. THIS IS VERY WIP
    • HRtoVRChat_OSC | Parameter Path | Parameter Name | Parameter Description
      *modified from its official wiki
      1.0 indicates a Float value while 1 on its own is synonymous with True | Parameter Data Type
      *guess due to non-functioning parameter | Range
      *guess due to non-functioning parameter | Notes
      Float values: Make sure to send the value as a Float or the game occasionally interprets it as a bool
      Boolean values: You can also send 1 or 0 respectively | |:--------------------------------:|:------------------:|:----------------------------------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------:|:----------------------------------------------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | /avatar/parameters/onesHR | onesHR | HRtoVRChat_OSC - Ones spot in the Heart Rate reading; 123 (legacy) | int | 0 to 9 | | | /avatar/parameters/tensHR | tensHR | HRtoVRChat_OSC - Tens spot in the Heart Rate reading; 123 (legacy) | int | 0 to 9 | | | /avatar/parameters/hundredsHR | hundredsHR | HRtoVRChat_OSC - Hundreds spot in the Heart Rate reading; 123 (legacy) | int | 0 to 9 | | | /avatar/parameters/isHRConnected | isHRConnected | HRtoVRChat_OSC - Returns whether the device's connection is valid or not | bool | [True, False] | | | /avatar/parameters/isHRActive | isHRActive | HRtoVRChat_OSC - Returns whether the connection is valid or not | bool | [True, False] | | | /avatar/parameters/isHRBeat | isHRBeat | HRtoVRChat_OSC - Estimation on when the heart is beating | bool | [True, False] | | | /avatar/parameters/HRPercent | HRPercent | HRtoVRChat_OSC - Range of HR between the MinHR and MaxHR config value | Float | ... | | | /avatar/parameters/FullHRPercent | FullHRPercent | HRtoVRChat_OSC - Range of HR between the MinHR and MaxHR config value on a scale of -1 to 1 | Float | -1 to 1 | | | /avatar/parameters/HR | HR | HRtoVRChat_OSC - Returns the raw HR, ranged from 0 - 255. (required) | int | 0 to 255 | |

Readable Parameters - Can be read.

Clone this wiki locally