Overview

The WebSocket Hub is a new tab on the Sources page, introduced in v1.2.58. It provides a centralized dashboard for every WebSocket connection that VMSC maintains — both built-in platform connections and custom ones you configure yourself.

The hub is divided into three sections: Built-in Connections, Custom WebSocket Server, and Custom WebSocket Clients.

Built-in Connections

This section displays a status dot for every active WebSocket connection that VMSC manages internally. Each dot is color-coded:

  • Green — Connected and healthy.
  • Yellow — Connecting or reconnecting.
  • Red — Disconnected or errored.
  • Gray — Not configured / disabled.

The following built-in connections are tracked:

ConnectionDescription
TikFinity BridgeWebSocket bridge to TikFinity for extended TikTok event support.
Overlay ServerThe local overlay server that powers overlays, alerts, chat popout, and stream deck.
StreamlabsConnection to Streamlabs for donation and alert data.
StreamElementsConnection to StreamElements for tips and activity feed.
PiShockWebSocket connection to PiShock devices for haptic feedback integration.
VoicemodConnection to Voicemod for voice effect control.

Clicking a connection row expands it to show connection details such as the remote URL, uptime, and last error message (if any).

Custom WebSocket Server

VMSC can host a custom WebSocket server that external tools and scripts can connect to. This is useful for building your own integrations, bots, or dashboards that need to receive real-time data from VMSC.

Configuration

SettingDescription
Port The TCP port the server listens on. Default is 8765. Choose a port that does not conflict with other services.
Auth Token An optional authentication token. If set, clients must send this token in the connection handshake to be accepted.

Controls

Use the Start and Stop buttons to control the server. When running, the panel displays the current client count — the number of external clients connected to the server.

The custom server broadcasts all VMSC events (chat messages, gifts, follows, rule triggers, etc.) to connected clients as JSON messages. Refer to the Plugins documentation for the event payload schema.

Custom WebSocket Clients

In addition to hosting a server, VMSC can act as a WebSocket client and connect to external WebSocket endpoints. This lets you pull data from external services into VMSC.

Adding a Client

  1. Click + Add Client in the Custom WebSocket Clients section.
  2. Enter the WebSocket URL (e.g., wss://example.com/ws).
  3. Give the client a name for identification in the hub.
  4. Optionally enable Auto-Reconnect to automatically reconnect if the connection drops.

Per-Client Controls

Each client entry in the hub has its own controls:

  • Connect / Disconnect — Manually open or close the connection.
  • Auto-Reconnect toggle — Enable or disable automatic reconnection.
  • Message count — A running count of messages received from the remote endpoint.
  • Status dot — Green when connected, red when disconnected.
Custom clients are for advanced users. VMSC does not parse or act on messages from custom client connections by default. Use the Plugins system or Rules with a WebSocket trigger to process incoming data.