Community:VRCOSC

From VRChat Wiki
IconOnly CL Portal.png
V · ECommunity-written content
The following was created by the community. It may contain material not directly endorsed by the VRChat team. To learn more, consider reading Contributing to the VRChat Wiki.
Vrrat posed-right.png
V · EThis page is a stub.
You can help the VRChat Wiki by improving it.
[Reason: Not much information here! Please expand and proofread in reference to the Manual of Style.]

VRCOSC is a third-party application developed by VolcanicArts[1] that simplifies the creation of OSC programs through an extensible module system.

Origin

The application's first pre-release (version 2022.325.0) appeared on GitHub on March 25, 2022[2] with the initial feature set consisting of a handful of modules that allowed sending certain avatar parameters into VRChat from external sources (such as heart rate data from an external API, or information about the user's computer) through the OSC protocol[3].

Initially the module system required users to create pull requests (meaning to suggest a change to the application code itself) to introduce new modules.[3] Despite this limitation, the goal of the application has been to allow for extension by modules from the start.

The first stable release of the application arrived on May 27, 2022 with version 2022.527.0.[4]

Features

VRCOSC v1

The "v1" version of the application supports a handful of features out of the box[5] via built-in modules, for example:

  • desktop media controls via the Action Menu and showing of the currently playing song in the Chatbox
  • displaying live heart rate information in the Chatbox and sending it as avatar parameters
  • providing speech-to-text (also sometimes referred to as "live transcription") via voice recognition and the Chatbox
  • allowing for the creation of custom gestures for headsets with individual finger tracking support
  • ability to count parameter changes on an avatar (e.g. to count the number of collisions with a PhysBone collider)
  • displaying the user's hardware statistics in the Chatbox

These modules also contain prefabs that can be placed on an avatar and are set up to interact with the module's parameters to display certain information on the avatar itself, e.g. displaying the heartrate on the avatar's wrist.

In addition, external modules are also supported via user-supplied DLLs placed in a specific folder of the user's computer. These modules have the ability to define custom parameters and behavior in C# using the VRCOSC SDK.[6]

VRCOSC v2

A complete rewrite of the application is currently in progress, which, in addition to the features of v1, adds support for the automatic installation and updating of modules through GitHub repositories, as well as OSCQuery support, which should improve the compatibility and reliability of the OSC connection.

Community Impact

The program has split the community due to its inclusion of Chatbox support, which makes it easy for its users to repurpose the in-game chat functionality to send messages in quick succession to display arbitrary text, including values from the application's many modules. The Discord server for the application also encourages users to share their own "chatbox configs", which the app allows easy import and export on in the form of JSON files.

When the Chatbox feature was first introduced, VRChat did not include a notification sound for chat messages.[7] In response to a feedback post, this feature was subsequently implemented[8] to let others nearby know a chat message was sent was someone. It was quickly discovered by the users of the app and this change caught the developer off-guard, prompting an announcement that a hotfix is coming, and ultimately the issue was fixed in version 2023.109.0 of the application.[9]

To this day, some people consider the use of the Chatbox for anything other than its original intended purpose, serving as a text-based method of communication for those who are e.g. mute or hard of hearing, a cardinal sin. Others, however, see it as a fun way to overshare to people in their immediate surroundings.

As a compromise between the creators of OSC programs and world authors, the Chatbox Club Blacklist[10] project emerged, and an option was implemented in version 2024.220.1 of the app[11] to disable the chatbox functionality in worlds on the list by default. This prevents obnoxiously large chat boxes from obstructing the view and breaking immersion.

References