Skip to content

Controlling Oyasumi over OSC

Raphii edited this page Dec 21, 2023 · 6 revisions

Note: If you came here looking for updated info, this page is still outdated. I'll get to it some time soon!

Some Oyasumi features can be controlled over OSC. This page goes over the exact specification of how Oyasumi can be controlled this way.

Toggles

There are are a few toggles that can be controlled over OSC. All of them expect a single boolean value. Any OSC message that would not change the value from its current state is ignored.

OSC Address Description
/avatar/parameters/Oyasumi/SleepMode Sets the sleep mode to active (true) or inactive (false).
/avatar/parameters/Oyasumi/SleepingAnimations Sets whether sleeping animation automations are currently enabled (true) or disabled (false).
/avatar/parameters/Oyasumi/StatusAutomations Sets whether status automations are currently enabled (true) or disabled (false).
/avatar/parameters/Oyasumi/AutoAcceptInviteRequests Sets whether automatically accepting invite requests is currently enabled (true) or disabled (false).

Commands

There are several commands that can be sent to Oyasumi, using the Oyasumi/Cmd parameter. This parameter lives at the OSC address /avatar/parameters/Oyasumi/Cmd. It expects an integer value, and is meant to be used with "Button" controls in VRChat menus. Commands are activated whenever the value at this address changes to the command's respective value. Therefore, if you want to execute the same command twice, you first have to reset the value back to 0.

The following commands are currently available:

Command Number Name Description
0 Idle Reserved to do nothing. This is the idle value for the value at the command address. It is used to reset between activating commands.
1 Initialize Setting this will make Oyasumi synchronize its internal state to VRChat. Currently, this means it will set the current states for the available toggles to their respective parameters.
2 Turn off all trackers Turns off all currently connected Tracker devices that are capable of being turned off.
3 Turn off all controllers Turns off all currently connected Controller devices that are capable of being turned off.
Has a deliberate 2 second delay to give users who use this from an expression menu the time to close the menu before their controller turns off.
4 Turn off all devices Turns off all currently connected devices that are capable of being turned off.
Has a deliberate 2 second delay to give users who use this from an expression menu the time to close the menu before their controller turns off.