OBS Scripting

Write Python or Lua scripts that run INSIDE OBS Studio. Loaded via Tools → Scripts. The obspython / obslua modules expose a pragmatic subset of libobs: lifecycle callbacks, property UIs, frontend events, signals, hotkeys, timers. There is NO Qt access, NO top-level menu injection, NO compiled binary — for those, use obs-plugins.

Quick start

• Brand-new script: → Step 1 (locate dir + enable Python) → Step 2 (skeleton)
• Add a config UI: → Step 3 (properties + settings)
• React to stream/record/scene events: → Step 4 (frontend events + signals)
• Hotkey or periodic task: → Step 5 (hotkeys + timers)
• Verify an API exists: obs-docs skill, obsdocs.py search --query <name> --page scripting

When to use

• Automate something inside OBS without compiling a C++ plugin.
• Add a per-install tool with a small UI (scene switcher, auto-record on signal, hotkey macro).
• Integrate with external services from inside OBS (HTTP poll, write file on scene change).
• Prototype behavior that would later become a real plugin.