Skip to content

VRCSubs OSC Avatar Toggle Setup

Jump to bottom
CyberKitsune edited this page Oct 3, 2022 · 2 revisions

VRCSubs Avatar Toggles

When using VRCSubs often, you may wish for an easier way to pause the chatbox transcription, or an easier way to toggle translation on an off without going to your desktop and restarting the script. After a recent update, you can now do this via Avatar Parameters! If you have a custom avatar, or make avatars for VRCSubs users, you may wish to add toggles.

This feature is entirely optional! If you don't want to do avatar specific setup, VRCSubs will work without any of this!

Currently the following toggles are supported:

  • Pause (vrcsub-Pause AV3 bool param) - When set to True, VRCSubs will pause all transcription
  • Enable Translation (vrcsub-EnableTranslation AV3 bool param) - When set to True, VRCSubs will translate the chatbox output to the language specified in Config.yml
  • Follow Mic Mute (vrcsub-FollowMicMute AV3 bool param) - When set to True, VRCSubs will automatically pause when your microphone is muted in VRChat
  • Don't wait when translating (vrcsub-TranslateInterumResults AV3 bool param) - When set to True and translation is enabled, VRCSubs will try and translate messages before you're done talking. You may wish to toggle this off for some languages.

Setting Up Toggles

Mostly-Automated

To easily set up the toggles on a custom avatar, do the following:

  1. Open your AV3 Avatar Unity Project
  2. Import VRLabs's Avatars 3.0 Manager unitypackage
  3. Import VRCSubsExpressionMenu.unitypackage from this repo
  4. Go to VRLabs -> AV3 Manager

  1. Click the Parameters tab, drag your avatar GameObject into Avatar, and at the bottom, select "VRCSubsParams" in "Paramaters to copy", then click "Copy Parameters"

  1. Last, locate the expression menu on your AV3 avatar descriptor

  1. Within the expression menu properties, select "Add Control", set the name to "VRCSubs", and the type to "Sub Menu" -- Then, set the Sub Menu property to VRCSubsMenu

  1. All done! You'll now have the VRCSubs Expression submenu in the game! Ensure AllowOSCControl is set to true in the VRCSubs config.yml. You may need to also "Reset Config" in the OSC Settings submenu in VRChat the first time you add the paramaters.

Clone this wiki locally