Configure Bridge overlays in OBS

These steps assume OBS Studio. Other apps with a Browser Source (Streamlabs Desktop, etc.) are similar.

Before you start

1. Install and run Kinkajou Bridge.
2. Add at least one printer so /v1/printers returns an instance.
3. Keep Bridge on the same PC as OBS (default API: http://127.0.0.1:29067).
4. Open Printers → Details for that printer and copy the overlay URL (or the printer id).

Add a Browser Source (one per printer)

1. In OBS, under Sources, click + → Browser.

2. Name it after the printer (for example P1S Overview) and click OK.

3. Set URL to the overlay you want. Include printer= for that machine. Omit host when Bridge uses the default http://127.0.0.1:29067.

   Overview (full summary + times, WebSocket):

   https://overlays.kinkajou.dev/bridge/overview/?printer=YOUR_PRINTER_ID
   

   Compact (progress + times + status, WebSocket):

   https://overlays.kinkajou.dev/bridge/compact/?printer=YOUR_PRINTER_ID
   

   Non-default Bridge address (example port 9000):

   https://overlays.kinkajou.dev/bridge/overview/?printer=YOUR_PRINTER_ID&host=http://127.0.0.1:9000
   

   Local Hugo preview while developing:

   http://127.0.0.1:1313/bridge/overview/?printer=YOUR_PRINTER_ID
   

4. Set size (Width × Height):

   Overlay	Start with
   Overview	520 × 280
   Compact	480 × 90
   Status	420 × 140
   Progress	480 × 160

5. Check Shutdown source when not visible if you want to save CPU when the scene is hidden.

6. Leave Refresh browser when scene becomes active enabled so the WebSocket reconnects cleanly when you switch scenes.

7. Click OK.

8. Repeat for each additional printer with a different printer= id.

Find your printer id

1. In Bridge: Printers → Details — copy Printer id (or use the pre-built overlay links).
2. Or call GET http://127.0.0.1:29067/v1/printers and copy each object’s id.
3. If you omit printer, the overlay uses the first printer Bridge returns — fine for a single-printer setup, ambiguous with several.

Tips

• Use a transparent background in OBS; these overlays use transparent page backgrounds.
• Compact uses a colored left accent + badge so print state (printing / paused / complete / error) is readable at a glance.
• Overview and Compact listen on ws://127.0.0.1:29067/v1/events and re-fetch status when that printer changes, while ticking remaining/elapsed locally each second.
• If the widget stays empty, confirm Bridge is running and that OBS can reach 127.0.0.1:29067 (same machine).
• Custom look? Call the Bridge HTTP/WS API yourself with fetch / WebSocket — see the overlay developer docs.