VRChat OSC connection settings

Setup

Plugin pages are hidden from the sidebar until you turn them on; see showing a plugin's pages.

  1. In VRChat, turn on OSC from the Action Menu: Options → OSC → Enabled.
  2. In MultiShock, open Manage plugins and click Configure on VRChatOSC. The defaults work for VRChat running on the same computer:
    • VRChat Remote Host 127.0.0.1 and VRChat Receive Port (send target) 9000 are where MultiShock sends.
    • Local Receive Port 9001 is where MultiShock listens. With Use any available local receive port on, it picks a free port if 9001 is taken and advertises it over OSCQuery.
    • Enable OSCQuery advertisement and discovery and Prefer OSCQuery discovered VRChat endpoint let MultiShock find VRChat automatically.
  3. Leave Enable plugin and Auto-start connection on app startup on, then click Save. Use Start and Stop to control the connection by hand.

Saving while Auto-start connection on app startup is off stops the connection, so click Start afterwards if you want it running.

The VRChatOSC page in the sidebar shows the connection status, the active send target, a form to send a test message, and a log of incoming messages. "Connected" means MultiShock's sockets are open, not that VRChat is running, so use the incoming message log to confirm VRChat is talking to it.

Send a test message

On VRChatOSC, enter the OSC Address and Arguments, then click Send. Arguments accept individual values such as true or a JSON array such as [true, 1]. The test form requires at least one argument. Use an address that matches a parameter your avatar actually exposes.

The form reports whether it sent the message or encountered an error. A successful send is not confirmation that the avatar accepted or used the parameter.

Troubleshooting

  • Check the active send target and incoming message log, not just Connected.
  • If no messages arrive, confirm OSC is enabled in VRChat and that its outgoing endpoint reaches MultiShock's active local receive port.
  • If another program owns the port, review Use any available local receive port and OSCQuery discovery, or assign non-conflicting ports.
  • When discovery selects the wrong endpoint, review OSCQuery Client Name Filter and Prefer OSCQuery discovered VRChat endpoint in the plugin configuration.
  • If saving stopped the connection because auto-start is off, click Start.

Continue with avatar and contact flows or the node reference.

Contributors

Thank you to everyone who has helped improve this documentation.

bwmpbwmp