obs
Installation
SKILL.md
OBS Studio Control
OBS Studio 28+ ships obs-websocket v5 built in: a WebSocket server (default port 4455,
password-protected) that exposes almost everything the UI can do — scenes, inputs, scene
items, filters, transitions, outputs, media and UI state — as JSON requests. A job script
runs in a local Python process and talks to the running OBS through
scripts/obs_client.py, a standard-library-only v5 client: nothing
to pip install, nothing to load inside OBS. Everything here was run against OBS 32.2.2
with obs-websocket 5.7.4 (macOS). Check obsWebSocketVersion in the ping reply; on
another version, GetVersion → availableRequests is the source of truth.
- scripts/obs-run.sh — run a
.py(or-c 'inline');--pingchecks the connection,--statedumps scenes with items, inputs, outputs and settings. - scripts/obs-start.sh — launch OBS (optionally with
--collection/--profile/--scene) and wait for the websocket. - scripts/obs_collection.py — build a whole scene collection
from a compact spec and either
applyit live orinstallit as a file. - scripts/example-scene-setup.py — a complete build → verify job to copy the shape from.