VTuber Integration

Overview

VMSC integrates with popular VTuber software to let stream events control your avatar in real time. When a viewer sends a gift, follows, or triggers a chat command, VMSC can change your avatar's expression, fire a hotkey, load a different model, or inject custom parameters — all automatically.

Three integration paths are supported:

• Veadotube Mini & Full — WebSocket-based control for Veadotube avatars.
• VTube Studio — Full API integration with token-based authentication for Live2D models.
• Custom WebSocket — Generic WebSocket output for any WebSocket-compatible VTuber software.

Veadotube Mini & Full

Veadotube is a lightweight VTuber tool that uses PNG or GIF-based avatars with expression states. VMSC connects to Veadotube's WebSocket server to switch expressions and states from stream events.

Setup

1. Enable WebSocket in Veadotube

   Open Veadotube and enable the WebSocket server in its settings. Note the port number (default is 40404 for Mini, 40405 for Full).

2. Configure VMSC

   In VMSC, go to Outputs > VTuber and select Veadotube as the integration type. Enter the WebSocket address (e.g., ws://localhost:40404).

3. Test the Connection

   Click Test Connection. A green status indicator confirms VMSC is connected to Veadotube.

Capabilities

• Set expression/state — Switch the avatar to a named state (e.g., "happy", "angry", "surprised").
• Push-to-talk states — Temporarily activate a state while an event is active, then revert.
• State list sync — VMSC fetches the list of available states from Veadotube so you can select them in the action editor dropdown.

VTube Studio

VTube Studio is the most popular Live2D VTuber application. VMSC integrates through the official VTube Studio API using token-based authentication, providing deep control over your Live2D model.

Setup

1. Enable the API in VTube Studio

   Open VTube Studio, go to Settings > API, and enable the API server. The default port is 8001.

2. Configure VMSC

   In VMSC, go to Outputs > VTuber and select VTube Studio. Enter the API address (e.g., ws://localhost:8001).

3. Authenticate

   Click Connect. VTube Studio will display an authentication prompt on screen asking you to approve VMSC. Click Allow in VTube Studio. VMSC stores the authentication token for future sessions.

4. Verify

   Once authenticated, the status indicator turns green and the available models, expressions, and hotkeys are loaded into VMSC.

Capabilities

Custom WebSocket Output

For VTuber software not natively supported, VMSC offers a generic Custom WebSocket output. This sends JSON-formatted messages to any WebSocket server, letting you integrate with virtually any VTuber application that accepts WebSocket input.

Setup

1. Select Custom WebSocket

   In Outputs > VTuber, select Custom WebSocket as the integration type.

2. Enter the WebSocket URL

   Provide the WebSocket address of your target application (e.g., ws://localhost:9000).

3. Define Message Templates

   Create JSON message templates that VMSC sends when an action fires. Use template variables to inject event data.

{
  "action": "setExpression",
  "expression": "{{event.expressionName}}",
  "duration": 5000,
  "user": "{{user.nickname}}"
}

VTuber Actions in Rules

VTuber control is available as an action target in the Rules system. When adding an action to a rule, select VTuber and choose from the available actions based on your configured integration:

• Set Expression — Change the avatar's expression/state.
• Trigger Hotkey — Fire a VTube Studio hotkey (VTS only).
• Load Model — Switch the active model (VTS only).
• Inject Parameter — Set a model parameter value (VTS only).
• Send Custom Message — Send a custom JSON payload (Custom WebSocket only).

Combine VTuber actions with other actions in the same rule for multi-layered responses. For example, a gift could trigger an excited expression, play a sound alert, and send a TTS thank-you message simultaneously.

Troubleshooting