Welcome

Welcome to the OBS Utils documentation.

OBS Utils is a Foundry VTT module for managing the connection between Foundry and OBS Studio — it drives a streamer-friendly view of the game canvas, lets you compose actor-targeted overlays for your stream, and ties Foundry events to OBS scene switches.

Quickstart

Start with Getting Started for installation and a tour of the Director window.

Feature guides

• Stream Composer — designing actor overlays (Inline, Canvas)
• Overlay Animations — keyframe-based animation tracks and triggers
• Triggers — Foundry events that drive overlay animation transitions
• Custom CSS — styling overlays at four scopes
• OBS Remote — Foundry events triggering OBS actions
• Bundles — packaging and sharing overlay sets as .vmoverlay files
• Multi-GM Co-DM Handover — passing the active GM seat between Co-DMs
• Scene Camera Presets — per-scene saved viewports
• Manual OBS Mode — forcing OBS Mode on a browser or user
• Director API — registering custom Director tabs and reading Director state
• Camera Keyframes — keyframed camera preset sequences
• API — registering custom overlay types and OBS Remote event types

Video tutorials

Official tutorial playlist on YouTube — note that the videos predate V5 and the editor UI has changed substantially; the underlying concepts still apply.