diff --git a/Customize-UI.md b/Customize-UI.md index 87d94e7..8095ad7 100644 --- a/Customize-UI.md +++ b/Customize-UI.md @@ -278,6 +278,33 @@ These work on windows created with ShowUi / ShowMirror, as well as built-in over A showcase of this can be found on the `kbd` button in [watch.yaml](https://github.com/galister/wlx-overlay-s/blob/f4b10f825e010ef48c2e9573343385328a32ea6c/src/res/watch.yaml#L26). +#### SendOscValue +This requires WlxOverlay-S to be built with the `osc` feature, which is enabled by default. + +Sends an arbitrary OSC parameter to the `osc_out_port` set in the config file (default: `9000`). Values can be any of the following types: `Bool`, `Float`, `Int`, `String`, and multiple values can be sent to the same parameter at once. + +**Set a VRChat [avatar parameter](https://docs.vrchat.com/docs/osc-avatar-parameters#avatar-parameters--config-files) `VRCEmote` to `2`:** +```yaml + - type: SendOscValue + parameter: "/avatar/parameters/VRCEmote" + values: + - type: Int + value: 2 +``` + +**Send a message to VRChat's [chatbox](https://docs.vrchat.com/docs/osc-as-input-controller#chatbox):** +```yaml + - type: SendOscValue + parameter: "/chatbox/input" + values: + - type: String + value: "OSC chatbox text" # text to send + - type: Bool + value: True # send immediately without opening the chatbox + - type: Bool + value: True # play chatbox noise +``` + #### Internal Use There are some types that are meant to be used internally, but feel free to use them, too. See: [ButtonData, ButtonAction](https://github.com/galister/wlx-overlay-s/blob/main/src/gui/modular/button.rs)