Advanced Features

VibeCheck OSC API

VibeCheck features an OSC API that listens while the app is enabled. At the moment the API is early in development and has only three endpoints. To use the API, the parameter on your avatar must be a synced parameter.

Synced parameters include:

• Parameters listed in the VRCExpressionParameters script.
• Contacts and Physbones script parameters.

Endpoints

App Specific Endpoints

Enable or disable VibeCheck OSC

State IN vibecheck/state

This endpoint changes the app's OSC state. There are two states: enabled (true) and disabled (false).

Parameters

bool (true=enable / false=disable)

Toy Specific Endpoints

Enable or disable all toys that are assigned a specific anatomy tag.

Anatomy IN vibecheck/api/anatomy/{ANATOMY_TYPE}/enabled

This endpoint changes the toy's enabled state. The app user can specify the anatomy tag for each toy. When the API endpoint for a specified anatomy tag is hit it will change the all the toy's features to disabled or enabled. There are two states: enabled (true) and disabled (false).

Parameters

bool (true=enable / false=disable)

ANATOMY_TYPE

Anatomy address parameter types (Not case-sensitive):

Anus
Breasts
Buttocks 
Chest
Clitoris 
Face
Feet
FootL
FootR
HandLeft 
HandRight
Hands
Labia
Mouth
NA
Nipples
Penis
Perineum 
Testicles
Thighs
Vagina
Vulva
Wrist

Send the battery life of a specific toy to VRChat as the specified avatar parameter.

OSC Data OUT {toy_name}/{toy duplicate id}/battery

This endpoint sends the battery of the specified toy to VRChat as an avatar parameter.

This endpoint can be copied from a connected toy by clicking the clipboard icon. The toy name will be lowercase and spaces will be underscores. The address will have a "duplicate id" that will increment when multiple of the same toy is connected, this allows multiple toy data when using two or more of the same toy. Keep the duplicate id in mind when adding the copied parameter to your avatar!

Parameters

float (battery percentage 0.0 - 1.0)