Repository navigation
Home
Audience: anyone deciding whether to install Coffee Pub Studio, or looking for where to read more about it.
The production side of the Coffee Pub suite: a standalone macOS and Windows app that wraps any web page in a fixed-size Chromium window so OBS can capture it as its own source, and keeps that OBS source cropped, pointed and in sync. It's optimized for running FoundryVTT sessions but not exclusive to Foundry -- it works with any web-based experience. It signs in to Coffee Pub Tavern to publish each player at the table as their own OBS source, and it runs a small local HTTPS server so a Foundry module -- Coffee Pub Herald first -- can trigger an OBS action (switch scene, show or hide a source, start or stop recording or streaming) when something happens in the game.
OBS window-capture source management is not yet wired up on Windows; see Known issues.
- Getting started -- the first five minutes.
- Settings, windows and the edge dock -- adding windows, the edge dock, keyboard shortcuts, Retina displays.
- Windows and regions as OBS sources -- connecting to OBS, the whole-window source, and cropping part of a window into its own source.
- Coffee Pub Tavern in OBS -- publishing the party as OBS sources.
- Configuration file reference -- the config.json shape, field by field.
- Automations API -- let a Foundry module drive OBS through Studio.
- Automations architecture -- how the Automations feature is built and why.
- Design tokens and Design components -- the control panel's own colors, layout tokens, and reusable UI patterns.
See the repository README for requirements and how to get the app.