VRCOSC

A modular OSC program creator and toolkit made for VRChat built on top of the osu!framework

VRCOSC is intended to act as a wrapper around VRChat's OSC system to make creating OSC programs easier, provide interfaces for other APIs and frameworks that might be useful to an OSC project, and act as a centralised source for useful OSC programs so that a user will only need to download a single application. Our framework supports developing your own modules to save you the trouble of having to setup everything yourself, as well as allowing other people to seamlessly use your module on their PC. Check out how to create a module here.

VRCOSC's powerful ChatBox design system allows you to display what you want, when you want, how you want. Check out the ChatBox-Config forum channel of our Discord Server to see some of the configs people have created! The ChatBox uses a community-created list to block all modules apart from the accessibility and health related modules (SpeechToText, Pulsoid, and Hyperate) from using the ChatBox when in club/event worlds as a courtesy to performers and event staff. You can turn this off in VRCOSC's settings, but we recommend you keep it on for respect.

VRCOSC's router lets you route other OSC programs through our app to stop port binding issues. Common setups can be found on the Routing Wiki page.

We have a Discord Server for posting suggestions or to get help with anything to do with VRCOSC.

If you like VRCOSC, please star the repo. It really helps!

Featuring:

• Responsive GUI generation
• Automated configuration management
• A powerful ChatBox design system
• An in-built router to work with other OSC apps
• Program modularity for easy development
• Automatic updates
• Common API interfaces
• Drag-and-drop Unity prefabs

Getting Started

• Download VRCOSCSetup.exe from the Releases page
• Tick the modules you'd like to use
• Download any prefabs you want and add them to your avatar (Guides are available inside each prefab)
• Press the run button!

Check the FAQ if you have any issues with installing or using any of the prefabs.

Official Modules

If you have a module idea join the Discord Server and tell us or create it yourself!

Note: The VRCOSC-Controls.unitypackage prefab is global controls for VRCOSC. It does not require a module to use.

All prefabs listed can be downloaded from the Releases page

Module	Description	Prefab
Media	Allows for media display in the ChatBox and full control over media from your action menu	VRCOSC-Media.unitypackage
Pulsoid	Connects to Pulsoid to display your live heartrate in-game - Supported Devices	VRCOSC-Heartrate.unitypackage
HypeRate	Connects to HypeRate.io to display your live heartrate in-game - Supported Devices	VRCOSC-Heartrate.unitypackage
Speech To Text	Run Speech To Text using any language model and display the result in your ChatBox
Clock	Sends your local time as hours, minutes, and seconds to be displayed on a wrist watch	VRCOSC-Watch.unitypackage
PiShock	Allow you to control groups of PiShock shockers directly from your avatar	VRCOSC-PiShock.unitypackage
Hardware Stats	Gather's hardware stats to send to your avatar and display in the ChatBox
Haptic Control	Allows for triggering controller haptics using variables from your avatar
OpenVR Statistics	Gets statistics from your OpenVR (SteamVR) session	VRCOSC-Trackers.unitypackage
OpenVR Controller Statistics	Gets controller statistics from your OpenVR (SteamVR) session
Gesture Extensions	Allows for custom gestures to be sent to VRChat from your Index controllers
AFK Display	Displays how long you've been AFK for in the ChatBox
Process Manager	Open and close apps on your PC using avatar parameters
Weather	Gets weather from a postcode/zipcode/city to display in the ChatBox
Counter	Counts how many times a parameter on your avatar changes to be displayed in the ChatBox
ChatBox Text	Displays custom text in the ChatBox that can also function like a ticker tape
Discord	Allows for toggling of mute and deafen from the action menu	VRCOSC-Discord.unitypackage
Exchange Rate	Retrieves exchange rate information for currencies and displays them in the ChatBox

License

This program is licensed under the GNU General Public License V3. Please see the license file for more information.

Other libraries included in this project may contain different licenses. See the license files in their repos for more information.