Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop and start menu.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software or prefabs check the FAQ.

New Screens

Startup

• This allows you to define paths to exes to start when modules are ran
• This is a replacement for what was previously in the Media module

Run

• The run screen is what's taken over from the original module overlay when the modules were ran
• This allows you to enable/disable modules, and change module settings at runtime!
• Do note that enabling/disabling modules and changing some module settings requires restarting modules

New Modules

Haptic Control

• Avatar haptic feedback!
• Allows you to define and alter haptic variables from an avatar's animator and trigger haptics on left, right, or both controllers

Other Changes

• Completely refactored serialisation
  • This standardises serialisation (file saving) throughout VRCOSC
  • All module data is now saved inside a single modules.json file
  • All your settings will be automatically migrated over. If this fails, please message me on Discord
• Added 2 more Clip layers to the ChatBox Timeline
• Hide Clip name when Clip is too thin
• Fixed ChatBox formatting crash when gap was too large when using /n
• Fixed multiple HeartRateModule issues to do with connectivity and timeouts
• Changed behaviour of Auto Start/Stop with VRChat setting
  • You now don't need to disable this to manually run the modules
• Added progress visualisation variable to MediaModule
  • Just a fun visual of the current progress using some Unicode characters!

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.503.0...2023.509.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop and start menu.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software or prefabs check the FAQ.

What's Changed

• Allow ChatBox formats to contain /v and /n
  • /v will add a new line and make the ChatBox's width in-game shrink to fit the text
  • /n will add a new line by automatically generating the spaces used before, keeping the wide width
• Fix ChatBox configs not loading when Unicode characters were used
• Fix Clips being able to overlap when dragging individual ends
• Catch occasional bad hook in SpeechToText
• Standardise Heartrate parameter management between Heartrate modules
• Remove excess memory usage when logging using Heartrate modules
• Filter ChatBox events as well as states by enabled modules
• Add power usage (in Watts) to HardwareStats
• Add VRAMUsage (in %) to HardwareStats
• Refactored HardwareStats to get correct values (most for AMD CPUs... Thanks AMD)
• Remove SRanipal module
  • To anyone still using it, VRCFT released their V5 update. A guide on how to setup the router for it is available here
• Fix the updater's progress notification staying open if the update failed
• Fix NullReferenceException in SpeechToText if the model wasn't loaded when modules were shutdown
• Add Accessibility ModuleType
• Unlink Clock parameters from Clock's Mode
  • The watch prefab requires 12 hour time so this allows for the ChatBox to show 24 hour without affecting the watch

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.430.0...2023.503.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop and start menu.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software or prefabs check the FAQ.

Notice

Some of you may have experienced VRCOSC refusing to open after 2023.428.0. This is because your install of Windows does not have a voice pack installed which it should've done by default.
I've removed the Windows Speech dependency from Speech To Text now so this is no longer an issue, but it does mean that because of initialisation problems anyone who has/had this issue is stuck on 2023.428.0 as the auto-updater doesn't have time to initialise.
If anyone has experienced this you will need to reinstall VRCOSC using the setup exe from this release onwards.

What's Changed

• Fixed some prefabs not initialising correctly after module restarts
• Removed Windows Speech Recognition dependency from Speech To Text
• Added Text Generating state to Speech To Text
• Ensure Heartrate Enabled is constantly up-to-date

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.429.0...2023.430.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop and start menu.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software or prefabs check the FAQ.

What's Changed

• Added manual listening toggle for Speech To Text
• Fixed ChatBox not constantly updating

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.428.0...2023.429.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop and start menu.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software or prefabs check the FAQ.

What's Changed

New Module - Speech To Text

• Speech To Text works by querying a model you download (linked in app) using VOSK's local processing
• An Idle and Text Generated state has been provided for you to permanently show what's been recognised
• A Text Generated event has been provided for you to show what you've said for X seconds
• You can choose whether to always have it listening or only listen when you're muted in-game
• This is experimental. Feedback is very much welcomed!

Other Changes

• Various ChatBox improvements
• Fixed a crash when no CBV3 Clip was selected and you tried to toggle a module
• Fixed a crash when a module has no default state

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.426.0...2023.428.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop and start menu.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software or prefabs check the FAQ.

What's Changed

• Major ChatBoxV3 Timeline UI and UX improvements
  • The Timeline length can now be changed (min 5 seconds, max 4 minutes)
  • Performance improvements when dragging Clips
  • Fixed incorrect colours clashing
  • Added copy to clipboard button for each module variable
• Fixed a NullReferenceException in Media module causing a silent crash on first module run
• Fixed a crash that resulted from changing into a local avatar
• Fixed a crash when the ChatBoxV3 config isn't loaded correctly. A notification will now popup
• Fixed a DivideByZeroException in all Heartrate modules
• Improved HardwareStats performance
• Added ChatBoxV3 notice in all module settings
• Adjusted Weather module's default format
• Added average tracker battery to OpenVRStatistics module

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.424.0...2023.426.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop and start menu.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software or prefabs check the FAQ.

What's Changed

• Fixed Controls prefab not being hooked up to ChatBox V3
• Allow /chatbox prefixes to update in the background when not on the running screen
• Fix ChatBox V3 not saving when a Clip priority is changed
• Fixed time not formatting correctly in the Clock module
• Add in-app link to ChatBox V3 Wiki
• Add in-app link to VRCOSC Router Wiki
• Fix possible NullReferenceException in Media module
• Adjust AFK module's delta update
• Fixed maximum delta update calculation
• Fixed a silent unhandled exception when a port is already in use for the main OSC client and Router
• Fixed a silent unhandled exception when OpenVR wasn't initialised
• Altered OpenVR detection and initialisation to work better fixing a race condition
• Allow hours to show up in the Media module's time and duration variables
• Format Weather module's condition by sunrise/sunset

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.423.0...2023.424.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop and start menu.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software or prefabs check the FAQ.

What's Changed

ChatBoxV3

This is it! ChatBoxV3 is a brand new system built to support everything that anyone's suggested!

It can:

• Show multiple modules' variables in the same string.
• Provide support for events (Media now playing can now show up for X seconds!)
• Provide complete customisation for the 60 second timeline loop, where you control the priority and time of every clip
• Provide live updates for customisation while modules are running

A standardisation pass has been done on all variables provided by the modules so that there are no longer different delimitators for ChatBox formats. What was previously %% and $$ is now uniformly {}. All module variables available to a specific clip are listed in the screen

As with any change this large, your previous ChatBoxV2 (module based) settings will be lost. There's no way for me to do a conversion due to how different the systems are.

A lot of work has gone into this in the backend to make it as easy to use as possible.
More updates will be coming in the near future to improve the UX of the screen, as well as some inevitable bug fixes.
I'm super proud of it, feedback is very much welcomed.

New Module: AFK

• Allows for a ChatBox string to be displayed when you are (or aren't) AFK.
• 2 variables have been provided for the amount of time you've been AFK, or the time when you went AFK
• This is based off VRC's provided isAFK animator parameter

Other Changes

• Allow for tab switching even when modules are running
• Add weather condition to Weather module
• Fix synchronous hang when modules start
• Add more variables to Media
• Add smoothing filter to all Heartrate modules
• Add HeartrateNormalised bound editing
• Completely decoupled the Module base class from Component to simplify external module creation
• Refactored ModuleManager to allow for an infinite number of sources opening the doors for future sources (such as the internet)
• Warn for non-initialised Media hook. This should give an indication as to whether you need to restart your PC or not
• Updated libraries
  • osu!framework had an update to provide support for all different kinds of renderers so VRCOSC should be more performant on older computers and be less GPU heavy when in VR

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.309.1...2023.423.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software check the FAQ.
• If you have trouble with the prefabs, check the Prefabs FAQ.

What's Changed

• Fix crash when using eye tracking
• Fix various other eye tracking issues
• Add more guard clauses to avatar config loading
• Add another AMD CPU variant to HardwareStats

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.306.1...2023.309.1

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software check the FAQ.
• If you have trouble with the prefabs, check the Prefabs FAQ.

What's Changed

• Fix crash when using eye tracking
• Fix various other eye tracking issues
• Add more guard clauses to avatar config loading
• Add another AMD CPU variant to HardwareStats

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.306.1...2023.309.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software check the FAQ.
• If you have trouble with the prefabs, check the Prefabs FAQ.

What's Changed

• Hotfix for missing API keys

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.306.0...2023.306.1

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software check the FAQ.
• If you have trouble with the prefabs, check the Prefabs FAQ.

What's Changed

SRanipal Module

• A built-in hot-swappable module for VRCFaceTracking's Vive face and eye tracker functionality
• I've verified the face tracking works correctly, but I don't own an eye tracker. Please report any bugs if found!

Other Changes

• Added VRAM stats to HardwareStats
• Fixed older AMD CPUs not reporting their temperature
• Allow ChatBoxText to have an adjustable speed
• Fixed a race condition crash
• Added setting to auto-launch with SteamVR to remove confusion
• Replaced the muted button on the Media prefab with the current song position
• Changed settings to use validation textboxes
• Allow paused text in the Media module to sample the available variables
• Allow volume to be displayed as a Media variable

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.205.0...2023.306.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software check the FAQ.
• If you have trouble with the prefabs, check the Prefabs FAQ.

What's Changed

External module support!

VRCOSC now supports externally made modules. Head over to the Module Creation doc on the wiki to get started with installing a template and creating a module.

As always, I will provide as much help as possible. No feature request is too small to make it easier for you to create a custom module, so please reach out if you'd like something.

OSC Router

OSCRouter is a program that routes network data through other ports to stop port binding issues occurring. This is mainly to help with the fact that VRC only has a single OSC port.

Unfortunately, OSCRouter seems to be quite outdated, and also cannot handle VRCFaceTracking's data. To counter this, I've created my own router and embedded it into VRCOSC as a new screen. Hopefully this should be pretty easy to use and will mean that you can run as many OSC programs as you like while needing 1 less program.

The VRCOSC router will automatically start when the modules are started.

Other Changes

• Updated to use PolySharp to use C#11 features
• Added ticker functionality into ChatBoxText
• Fixed an int text box bug
• Fixed a COMException crash due to media updates
• Modules are now listed in order by type, then by alphabetical order
• Parameter names are now editable again
• Fixed Weather formatting bug when temperature was exactly 0
• Avatar ID is now passed through OnAvatarChange

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2023.109.0...2023.205.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the software check the FAQ.
• If you have trouble with the prefabs, check the Prefabs FAQ.

What's Changed

• Refactored OpenVR library to be standardised and expandable
• Reworked updater flow to ensure less crashes and bugs
• Refactored OSC library to be more memory efficient and fast
• Optimised parameter lookups to not leak memory
• Fixed an insufficient disk space crash in the media hook
• Fixed Oculus controllers not detecting thumb positions
• Fixed OpenVR sessions with multiple controllers connected to prioritise the connected controllers
• Created experimental Weather module to get local weather data
• Force the ChatBox notification sound to be off
• Added FPS calculation to OpenVRStatistics
  • Normalised to 240fps as a parameter and can be displayed in the ChatBox
• Disabled UI scaling

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2022.1226.0...2023.109.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the prefabs, check the Prefab FAQ.

What's Changed

• Re-written media interface to use own code instead of a library
  • This code is more specialised to my use case and should provide a better experience
• Fixed HeartrateModule's default spacing for the ChatBox
• Adjusted the HeartrateModule's normalised value to normalise from 240 instead of 60
  • This was causing any value over 60 to not sync correctly to remote users
  • This will require an update of your Heartrate prefab. The only thing changed is the heartbeat animation
• Bump framework

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2022.1219.0...2022.1226.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the prefabs, check the Prefab FAQ.

What's Changed

• Fixed a possible OscClient crash
• Fixed a possible HardwareStats crash
• Fixed a possible HypeRate crash
• Slowed OpenVR checks to slow down memory leakage when using VRCOSC without SteamVR running (Thanks Valve...)
• Fixed Media sometimes not obtaining the right source
• General Media improvements to controlling and providing data
  • Should be more compatible with more source types

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2022.1218.0...2022.1219.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the prefabs, check the Prefab FAQ.

What's Changed

• Allow SteamVR to start VRCOSC (Can be found in your overlay apps inside SteamVR's settings)
• Add setting to optionally close VRCOSC when SteamVR stops
• Rewrote a lot of the core systems for stability
  • This has removed all asynchronous code in favour of everything being completely synchronous
  • VRCOSC is now less likely to crash unexpectedly on slower systems
  • UX flow is also a lot better now meaning unexpected behaviour should no longer occur
• Fixed an issue where typing in a text box would cause VRCOSC to lag
• Fixed an issue where VRCOSC would auto-pause YouTube
• Fixed an issue where users that emptied the Media module's Start List would have all settings underneath not load correctly
• Fixed an issue where processes would start incorrectly from the Media module
• Improved how OpenVR battery data is gathered
• Battery data is no longer sent from OpenVR Statistics if the device cannot provide battery data
• Changed the in-app terminal to use each module's visual name instead of class name for clarity
• Changed the way force updates happen for the Media data gathering
• Updated OpenVR to latest version (https://www.nuget.org/packages/VolcanicArts.Libs.OpenVR/)
• Added splash screen when installing fresh

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2022.1211.1...2022.1218.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the prefabs, check the Prefab FAQ.

What's Changed

Quick hotfix for a pretty annoying crash that happens due to the new OSC listeners I implemented.
See the last release for the full changelog

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2022.1211.0...2022.1211.1

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the prefabs, check the Prefab FAQ.

What's Changed

New Prefab - Trackers

• The trackers prefab lets you show the battery levels of your trackers on your avatar using real Vive tracker models
• This prefab is setup exactly the same as the others, with the guide showing you exactly what to do
• Please read to the end of the guide if you intend on using this prefab, as you must turn your trackers on in real life in the same order that is assigned in Unity. This is a SteamVR limitation

New Prefab - Controls

• Global controls for VRCOSC
• Currently just allows you to disable VRCOSC from sending values to the ChatBox, but this is very useful for when you want to use the ChatBox manually or want to turn off the ChatBox for a photo but don't want to stop VRCOSC from running

New Modules!

OpenVR Statistics

• Gets statistics from your OpenVR (SteamVR) session
• Including:
  • HMD, Controller, and Tracker connected states
  • HMD, Controller, and Tracker charging states
  • HMD, Controller, and Tracker battery levels

OpenVR Controller Statistics

• Parses all your controller inputs into useable values
• Including:
  • Thumb positions (A, B, Pad, and Stick)
  • Finger positions (Only applicable if you use the Index controllers)

Gesture Extensions

• Parses the Index finger positions to turn them into gestures
• The gestures currently supported are as follows:
  • 0 - Double Gun - Like Finger Gun but with the middle finger extended as well
  • 1 - Middle Finger - Only your middle finger up
  • 2 - Pinky Finger - Only your pinky finger up

ChatBox Text

• Show a custom line of text in the ChatBox

Themes!

• Themes have been implemented
• Check them out in the settings menu
• When you select a theme, restart VRCOSC to see the effect
• Feel free to pull request new themes if you want to design one!

Other Changes

• Added ability to change ChatBox time between sending to compensate for VRChat lag on less powerful machines
• The ChatBox code now supports UTF-8 (No more ? in the ChatBox for Latin characters)
• Fixed a performance regression with OpenVR initialisation
• Fixed a performance regression when typing in text boxes
• Fixed a bug with TimedTask where the update wouldn't actually run immediately
• Module settings will now disable if other settings are in an incorrect state
• Simplify force updating of media to take into account slow loading websites
• Fixed HardwareStats sometimes crashing when stopping the modules

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2022.1203.0...2022.1211.0

Installation

• Download and run VRCOSCSetup.exe (It may get blocked by your antivirus (including Windows Defender)). A shortcut will be made on your desktop.
• Join the Discord Server to get help or make suggestions.
• If you have trouble with the prefabs, check the Prefab FAQ.

What's Changed

Completely refactor ChatBox logic

This is a pretty big change. I've tried to explain it as best as possible below.

TL;DR:
Timed modules will show every X seconds for Y seconds. They have priority over Always modules.
Always modules will show constantly but only if they have valid text. Non valid Always modules will be skipped. Always modules' priorities are taken into account to decide which module to show.

• The new ChatBox logic allows you to set whether you want a module to always show or show on a timer
• The always mode will continuously show in the ChatBox, unless the module is sending no value, in which the ChatBox will then show the details of an always module that is a lower priority.
• For example. If we enable Media and Clock and set them both to always, the Media module will always show the details of the song that is playing unless the media is paused. When it is paused, it stops sending values and defaults back to the Clock module which is always sending the time.
• Currently the priorities are in the following order: Media -> Heartrate (HypeRate & Pulsoid) -> Clock or HardwareStats.
• If there are no always modules that are sending valid text, the ChatBox will clear.
• The timed mode allows users to set, for example, the Clock module to show the time every 60 seconds for 10 seconds.
• If you have multiple timed modules, they will queue to show their details.
• Once there are no timed modules in the queue, the ChatBox will default back to the highest always module with a valid value.

Other Changes

• Allow Media to optionally show a value when it's paused
• Allow HeartRateModule to reconnect on disconnecting
• Fix multiple asynchronous issues
• Changed graphics of "Reset" button for all settings. Should make it more clear as to the purpose of the button
• Fix Auto Start/Stop breaking the GUI when VRC is already started on app start
• Removed AutoFocus setting
• Deleted all deprecated code
• Bumped dependencies

Full Changelog: https://github.com/VolcanicArts/VRCOSC/compare/2022.1116.0...2022.1203.0