Skip to content

added chatbox and face tracking osc endpoints #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
loliwut merged 1 commit into from
Dec 27, 2025
Merged

added chatbox and face tracking osc endpoints #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 47 additions & 5 deletions docs/chilloutvr/game/osc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,24 +12,66 @@ available endpoints dynamically.

### Endpoints

**Avatar Parameters**
#### Avatar Parameters

- `/avatar/parameters/<parameter_name>` Read/write to avatar parameters

**Avatar Switch**
#### Avatar Switch

- `/avatar/change` Trigger avatar switching (or listen for avatar changes)

**Avatar Profiles**
#### Avatar Profiles

- `/avatar/profile/change` Trigger avatar profile changes (or listen to the changes). The available avatar profiles for
the current avatar can be acquired from OSCQuery.

**Input**
#### Input

- `/input/<input_name>` Simulate game inputs like jump, move, etc.

**OSC Query**
#### ChatBox

* `/chatbox/typing`
Sends typing state events to the ChatBox.
**Args:**

1. `bool` - IsTyping (`true` = typing, `false` = stopped)
2. `bool` *(optional)* - SoundNotification (play typing sound)

* `/chatbox/input`
Sends a message to the ChatBox as if entered by the user.
**Args:**

1. `string` - Message text
2. `bool` - SendWithoutOpeningKeyboard
3. `bool` *(optional)* - SoundNotification
4. `bool` *(optional)* - ShowInChatBoxBubble
5. `bool` *(optional)* - ShowInHistoryWindow

!!! tip "Filtering ChatBox OSC Messages"
ChatBox messages sent via OSC are labeled as "OSC" and can be filtered in settings.
The global toggle is in **Audio & Comms → ChatBox - Enable OSC Msgs**, or per-user in **ChatBox Visibility Settings** when a player is selected.

#### Face Tracking

Face tracking over OSC uses **VRCFaceTracking Unified Expression parameter names** sent to the `/avatar/parameters` endpoint.
Unified Expression parameters sent to this endpoint are automatically routed to the native face-tracking system.

<sub>Reference: [https://docs.vrcft.io/docs/tutorial-avatars/tutorial-avatars-extras/parameters](https://docs.vrcft.io/docs/tutorial-avatars/tutorial-avatars-extras/parameters)</sub>

* `/avatar/parameters/<unified_expression_parameter_name>`
Read/write Unified Expression values via OSC.

Only the **final parameter name** needs to match. Any leading path is ignored for greater compatibility with existing tools.

**Example:** `/avatar/parameters/vendor/version/potato/NoseSneerLeft` → `NoseSneerLeft`

When using the `CVRFaceTracking` component, avatars do **not** need explicit VRCFT parameters defined in their animator. If both are present, both will be updated.

!!! tip "Intercepting Face Tracking Parameters from Avatar Parameters Endpoint"
This behavior exists for compatibility with existing OSC tools and may change if a dedicated face-tracking OSC endpoint is standardized.

#### OSC Query

- Supports OSCQuery protocol for service discovery ([spec](https://github.com/Vidvox/OSCQueryProposal){:target="_blank"})

Expand Down