Designer lets you build browser-ready components for Companion.
You can use them in a browser or in OBS Browser Source.
¶ What it is for
- Stream overlays in OBS Browser Source
- Browser widgets on a second screen
- Lightweight custom UI linked to Companion events
¶ Basic workflow
- Open Designer from the sidebar.
- Click
Create New. - In
Create Component, setNameand clickCreate. - Use
Editto open the Designer window. - Use
Copy URLwhen you are ready to load it in browser/OBS.
Each card supports:
Copy URLEditDuplicateDelete
¶ URL and hosting behavior
- URL format is:
http://companion.local:{httpServerPort}/component/{componentName} - Port comes from HTTP server settings.
- If HTTP server is off, the URL will not load.
¶ In the editor
The editor window gives you:
PreviewHTML EditorFormatSaveExit
The editor supports HTML, CSS, and Lua.
For the client API itself, see Companion lib.