Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/VolcanicArts/VRCOSC

Modular OSC program creator, toolkit, and router made for VRChat. Show your heartrate, time, hardware stats, speech to text, control Spotify, and more! Includes drag-and-drop prefabs for your avatar.
https://github.com/VolcanicArts/VRCOSC

chatbox csharp haptics heartrate media osc osu-framework pishock speech-recognition speech-to-text spotify vrc vrchat vrchat-avatar vrchat-avatars vrchat-osc vrchat-sdk3 vrchat-tool vrcosc windows

Last synced: 4 months ago
JSON representation

Modular OSC program creator, toolkit, and router made for VRChat. Show your heartrate, time, hardware stats, speech to text, control Spotify, and more! Includes drag-and-drop prefabs for your avatar.

Lists

README 

        



# VRCOSC

A modular OSC program creator and toolkit made for [VRChat](https://vrchat.com) built on top of the [osu!framework](https://github.com/ppy/osu-framework)






[![release version](https://img.shields.io/github/v/release/VolcanicArts/VRCOSC?style=for-the-badge)](https://github.com/VolcanicArts/VRCOSC/releases/latest)

[![downloads](https://img.shields.io/github/downloads/VolcanicArts/VRCOSC/total?style=for-the-badge&label=Downloads%20Total)](https://github.com/VolcanicArts/VRCOSC/releases/latest)

[![downloads@latest](https://img.shields.io/github/downloads/VolcanicArts/VRCOSC/latest/total?style=for-the-badge&label=Downloads%20For%20Latest)](https://github.com/VolcanicArts/VRCOSC/releases/latest)

[![commits](https://img.shields.io/github/commit-activity/m/VolcanicArts/VRCOSC?style=for-the-badge)](https://github.com/VolcanicArts/VRCOSC/commits/v2)




[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/O5O8FF9YO)




[![discord](https://discordapp.com/api/guilds/1000862183963496519/widget.png?style=shield)](https://discord.gg/vj4brHyvT5)






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](https://github.com/VolcanicArts/VRCOSC/wiki/Module-Creation).



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](https://discord.gg/vj4brHyvT5) to see some of the configs people have created!

The ChatBox uses a [community-created list](https://github.com/cyberkitsune/chatbox-club-blacklist/blob/master/npblacklist.json) 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](https://github.com/VolcanicArts/VRCOSC/wiki/VRCOSC-Router) page.



We have a [Discord Server](https://discord.gg/vj4brHyvT5) 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](https://github.com/VolcanicArts/VRCOSC/releases/latest) 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](https://github.com/VolcanicArts/VRCOSC/wiki/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](https://discord.gg/vj4brHyvT5) and tell us or [create it yourself](https://github.com/VolcanicArts/VRCOSC/wiki/Module-Creation)!



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](https://github.com/VolcanicArts/VRCOSC/releases/latest) 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 [![pulsoid](https://pulsoid.net/s/github-badge)](https://pulsoid.net/) | Connects to [Pulsoid](https://pulsoid.net/) to display your live heartrate in-game - [Supported Devices](https://www.blog.pulsoid.net/monitors) | VRCOSC-Heartrate.unitypackage |

| HypeRate | Connects to [HypeRate.io](https://www.hyperate.io/) to display your live heartrate in-game - [Supported Devices](https://www.hyperate.io/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](https://www.gnu.org/licenses/gpl-3.0.en.html). Please see [the license file](LICENSE) for more information.



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