RomanNum3ral
/
wayvr
mirror of https://github.com/wayvr-org/wayvr.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update OSC-Parameters.md (@Spaceey1)

Aleksander 2025-10-12 10:13:25 +02:00
parent dee9a1a8ff
commit 1ae393f7d9
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
OSC-Parameters.md

@ -1,32 +1,33 @@
For compatibility, WlxOverlay-S implements all of the OSC parameters used by [XSOverlay](https://xsoverlay.vercel.app/OSC), as well as several more based on the same format for extended functionality. For compatibility, WlxOverlay-S implements all of the OSC parameters used by [XSOverlay](https://xsoverlay.vercel.app/OSC), as well as several more based on the same format for extended functionality.
The port used by WlxOverlay-S can be configured by setting `osc_out_port: <value>` inside the .yaml files inside `~/.config/wlxoverlay`
This requires WlxOverlay-S to be built with the `osc` feature, which is enabled by default. This requires WlxOverlay-S to be built with the `osc` feature, which is enabled by default.
### Overlay Parameters ### Overlay Parameters
- `isOverlayOpen` (bool): True if any overlay window is shown. - `/avatar/parameters/isOverlayOpen` (bool): True if any overlay window is shown.
- `isKeyboardOpen` (bool): True if the keyboard is shown. - `/avatar/parameters/isKeyboardOpen` (bool): True if the keyboard is shown.
- `isWristVisible` (bool): True if the watch overlay is visible. - `/avatar/parameters/isWristVisible` (bool): True if the watch overlay is visible.
- `openOverlayCount` (int 0-255): The amount of open overlay windows. - `/avatar/parameters/openOverlayCount` (int 0-255): The amount of open overlay windows.
### Headset Parameters ### Headset Parameters
- `headsetBattery` (float 0-1): The battery level of the headset. - `/avatar/parameters/headsetBattery` (float 0-1): The battery level of the headset.
- `headsetCharging` (bool): True when the headset is charging. - `/avatar/parameters/headsetCharging` (bool): True when the headset is charging.
- `hmdBattery` (int 0-100): Legacy OVR Toolkit style: The battery level of the headset. - `/avatar/parameters/hmdBattery` (int 0-100): Legacy OVR Toolkit style: The battery level of the headset.
- This may change in the future, as [OVR Toolkit's docs](https://wiki.ovrtoolkit.co.uk/#/OSC?id=how-do-i-use-it-1) state this parameter is a float 0-1 despite it being an int in the software. - This may change in the future, as [OVR Toolkit's docs](https://wiki.ovrtoolkit.co.uk/#/OSC?id=how-do-i-use-it-1) state this parameter is a float 0-1 despite it being an int in the software.
- It is included for compatibility and should not be used for new systems. - It is included for compatibility and should not be used for new systems.
### Controller Parameters ### Controller Parameters
- `leftControllerBattery` `rightControllerBattery` (float 0-1): The battery level of the controller. - `/avatar/parameters/leftControllerBattery` `rightControllerBattery` (float 0-1): The battery level of the controller.
- `leftControllerCharging` `rightControllerCharging` (bool): True when the controller is charging. - `/avatar/parameters/leftControllerCharging` `rightControllerCharging` (bool): True when the controller is charging.
- `averageControllerBattery` (float 0-1): Average battery level of controllers. - `/avatar/parameters/averageControllerBattery` (float 0-1): Average battery level of controllers.
### Tracker Parameters ### Tracker Parameters
Tracker parameters are dynamic, and increase in number for as many tracker devices are connected. For example with 3 trackers connected, parameters for trackers 1, 2, and 3 will be sent. Tracker parameters are dynamic, and increase in number for as many tracker devices are connected. For example with 3 trackers connected, parameters for trackers 1, 2, and 3 will be sent.
- `tracker1Battery`, `tracker2Battery`, etc (float 0-1): 1-indexed tracker device battery level. - `/avatar/parameters/tracker1Battery`, `/avatar/parameters/tracker2Battery`, etc (float 0-1): 1-indexed tracker device battery level.
- `tracker1Charging`, `tracker2Charging`, etc (bool): 1-indexed tracker device charging state. - `/avatar/parameters/tracker1Charging`, `/avatar/parameters/tracker2Charging`, etc (bool): 1-indexed tracker device charging state.
- `averageTrackerBattery` (float 0-1): Average battery level of all trackers. - `/avatar/parameters/averageTrackerBattery` (float 0-1): Average battery level of all trackers.