Modbot Docs
Companion

Talk in Discord or VRChat

Swap your microphone between a private Discord call and VRChat with one button on the headset panel or one key, and mute or deafen Discord the same way. Off unless you switch it on, and nothing it does leaves your PC.

You are in an instance with other staff and need to talk to them privately, without the people around you hearing it, and then talk to the instance again without fumbling for either program. Talk in Discord or VRChat does the swap for you: it mutes one side and opens the other.

ButtonVRChat's microphoneDiscord's microphone
Talk in Discordmuted firstthen opened
Talk in VRChatopened lastclosed first
Discord Muteleft aloneDiscord's Toggle Mute pressed once
Discord Deafenleft aloneDiscord's Toggle Deafen pressed once

The side being closed always goes first. If VRChat's microphone cannot be muted, Discord is not opened, so a private conversation never reaches the instance because half a swap worked.

It is off until you switch it on

A fresh install has it off, and so does a companion updated into a version that has it. While it is off nothing listens, nothing is announced to VRChat and no key is ever pressed.

Settings → Talk in Discord or VRChat → On is the whole of the consent. Switching it off again gives everything back.

What you set up once

In VRChat, turn on OSC in the Action Menu, under Osc → Enabled, and turn on Toggle Voice in VRChat's settings. The companion cannot do either for you. VRChat shows a notice naming Modbot the first time it hears from it. Other OSC programs keep working, because Modbot takes no fixed port.

In Discord, the companion has no way to ask Discord to mute without a sign-in, so it presses the same keys you would. Under Discord's Keybinds, set Toggle Mute and Toggle Deafen to keys no other program wants, such as F13 to F24 or a number-pad key. Then, in the companion's Settings, record the same two keys by pressing them in Discord Toggle Mute and Discord Toggle Deafen. Clear takes a key back out; Escape gives up recording.

If Discord is not running, the press goes to whichever program is in front, VRChat included. Pick keys nothing else uses.

On the headset panel

With it on, three small icons sit under the tabs of the main panel, on every screen, on the same row as Save a clip (or alone when Clips is off), and stay when you are not in a group's instance.

IconSays
First, two arrowsA D beside it for Talking in Discord, a V for Talking in VRChat, no letter when neither is. Tapping it moves you to the other side.
Second, a microphoneDiscord Mute; struck through while Discord Muted is on.
Third, headphonesDiscord Deafen; struck through while Discord Deafened is on.

An icon on a side, or a Discord switch that is on, is drawn in a colour of its own. When something fails, one line under the row says what, for example that VRChat did not answer.

On the keyboard

The same three buttons can be keys that work while VRChat has the keyboard. In the same Settings card, record Talk in Discord or VRChat hotkey, Discord Mute hotkey and Discord Deafen hotkey. They start unset, and a hotkey is only claimed from Windows while Talk in Discord or VRChat is on and a key is recorded.

  • A hotkey is taken from every other program while it is claimed. It may be a function key on its own, such as F15, or any key with Ctrl or Alt. A letter, digit, punctuation mark, space, Enter, Tab or arrow on its own is refused, because it would stop working everywhere else.
  • A key lives in one place. A hotkey and a key Modbot presses for Discord can not share their main key (F13 and Ctrl+F13 are the same key here): recording one takes the other out of its place. That keeps a hotkey from also being a key Modbot presses for Discord, which would start the next press by itself.
  • While you record a key, the hotkeys are given back, so recording over a hotkey records it.
  • If another program already has a key, the card says so and the rest carries on.
  • Clear gives a hotkey back to Windows.

What it does and does not know

VRChat tells Modbot when its microphone changes, so the first button always shows the real state, even when you muted by hand.

Discord does not say. Modbot remembers only what its own presses did, starting from not muted and not deafened. If you mute Discord by hand, the memory is out of step: the buttons still work, but Talk in Discord may press the wrong way once. One more press of Discord Mute puts both right again. Nothing is remembered after the companion restarts.

What leaves your PC

Nothing. The packets to and from VRChat stay on this PC's own loopback address, the announcement that lets VRChat find Modbot is a notice on your local network, and the keys are pressed on this PC. The companion still does not read your keyboard: pressing a key and claiming a hotkey are the only two things it does with one, and a hotkey is a claim on exactly the keys you recorded.

When something does not work

You seeDo
VRChat didn't answer. Turn on OSC in VRChat's Action Menu, under Osc.Turn on OSC in VRChat.
VRChat's microphone didn't change. Turn on Toggle Voice in VRChat's settings.Turn on Toggle Voice.
Modbot could not start listening for VRChat. Trying again.Nothing; it tries again every 30 seconds and the line goes when it works. The reason is in the companion's log.
Record Discord's Toggle Mute key in Settings.Record the key (the same for Toggle Deafen).
Windows would not send the key.Try again; nothing was changed.
A hotkey needs Ctrl or Alt, or a function key.Record a function key, or add Ctrl or Alt.
Another program has F15.Record a different hotkey.
Only works on Windows.Windows only.

Modbot is not endorsed by or affiliated with VRChat Inc. or Discord Inc. VRChat is a trademark of VRChat Inc. Discord is a trademark of Discord Inc. SteamVR is a trademark of Valve Corporation. Windows is a trademark of Microsoft Corporation. Docker is a trademark of Docker, Inc. PostgreSQL is a trademark of the PostgreSQL Community Association of Canada. Railway is a trademark of Railway Corp. Other names are trademarks of their respective owners; see Legal. Modbot and its logo are trademarks of the Modbot project. Open source under AGPL-3.0.

On this page