diff --git a/OSC-Parameters.md b/OSC-Parameters.md index 396953a..720607c 100644 --- a/OSC-Parameters.md +++ b/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. +The port used by WlxOverlay-S can be configured by setting `osc_out_port: ` inside the .yaml files inside `~/.config/wlxoverlay` This requires WlxOverlay-S to be built with the `osc` feature, which is enabled by default. ### Overlay Parameters -- `isOverlayOpen` (bool): True if any overlay window is shown. -- `isKeyboardOpen` (bool): True if the keyboard is shown. -- `isWristVisible` (bool): True if the watch overlay is visible. -- `openOverlayCount` (int 0-255): The amount of open overlay windows. +- `/avatar/parameters/isOverlayOpen` (bool): True if any overlay window is shown. +- `/avatar/parameters/isKeyboardOpen` (bool): True if the keyboard is shown. +- `/avatar/parameters/isWristVisible` (bool): True if the watch overlay is visible. +- `/avatar/parameters/openOverlayCount` (int 0-255): The amount of open overlay windows. ### Headset Parameters -- `headsetBattery` (float 0-1): The battery level of the headset. -- `headsetCharging` (bool): True when the headset is charging. -- `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. - - It is included for compatibility and should not be used for new systems. +- `/avatar/parameters/headsetBattery` (float 0-1): The battery level of the headset. +- `/avatar/parameters/headsetCharging` (bool): True when the headset is charging. +- `/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. + - It is included for compatibility and should not be used for new systems. ### Controller Parameters -- `leftControllerBattery` `rightControllerBattery` (float 0-1): The battery level of the controller. -- `leftControllerCharging` `rightControllerCharging` (bool): True when the controller is charging. -- `averageControllerBattery` (float 0-1): Average battery level of controllers. +- `/avatar/parameters/leftControllerBattery` `rightControllerBattery` (float 0-1): The battery level of the controller. +- `/avatar/parameters/leftControllerCharging` `rightControllerCharging` (bool): True when the controller is charging. +- `/avatar/parameters/averageControllerBattery` (float 0-1): Average battery level of controllers. ### 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. -- `tracker1Battery`, `tracker2Battery`, etc (float 0-1): 1-indexed tracker device battery level. -- `tracker1Charging`, `tracker2Charging`, etc (bool): 1-indexed tracker device charging state. -- `averageTrackerBattery` (float 0-1): Average battery level of all trackers. +- `/avatar/parameters/tracker1Battery`, `/avatar/parameters/tracker2Battery`, etc (float 0-1): 1-indexed tracker device battery level. +- `/avatar/parameters/tracker1Charging`, `/avatar/parameters/tracker2Charging`, etc (bool): 1-indexed tracker device charging state. +- `/avatar/parameters/averageTrackerBattery` (float 0-1): Average battery level of all trackers.