OBS Scene Switching

OBS Scene Switching

Optional. If you run OBS, !restartvm / !revertvm can switch your OBS scenes automatically: a themed scene while the VM operation runs, then back to your VM capture scene when it's done.

Setup

1. In OBS: Tools → WebSocket Server Settings → enable the WebSocket server (built into OBS 28+). Default port is 4455. If you enable authentication, note the password.
2. Put your scene names into src/settings.json - they must match your OBS scene names exactly:

"obs": {
  "enabled": true,
  "host": "127.0.0.1",
  "port": 4455,
  "password": "",
  "activeCapture": "Desktop",
  "scenes": {
    "restartvm": { "during": "Restarting VM" },
    "revertvm": { "during": "Reverting VM" }
  }
}

How it works

• enabled: false (default) = integration off, nothing happens.
• activeCapture - the scene that shows your VM capture; switched to when the operation finishes.
• scenes.<op>.during - the scene shown while each operation runs.
• Empty scene names = no switch for that moment.

Flow: !restartvm / !revertvm → switch to the during scene → run the VM operation → switch back to activeCapture.

Notes

• Scene switches are best-effort: OBS failures only log a warning and never block the VM operation.
• Reconnects automatically if the OBS WebSocket connection drops (e.g. you restart OBS mid-session).
• Requires Node 22+ (uses Node's built-in WebSocket, no dependencies - same rule as the Live-Chat-Fallback).