GUIDE

OBS dock

The OBS dock lets you sign into Shiny's Streaming Services from OBS, check your counters and chat overlays, and add them to the current scene as a Browser source with one click. You can increment or reset counters, start, pause, and reset timers, create a Twitch clip, rename items, change values, create new overlays, or delete them without leaving OBS.

Add the dock to OBS

  1. In OBS, open View → Docks → Custom Browser Docks…
  2. Dock name: Shiny Streaming
  3. URL: https://services.shinyarmor.net/obs
  4. Click Apply, then Close. A new dock panel appears.

You can also open /obs in a normal browser to try the same panel.

Sign in with your account key

  1. Open the dashboard Account page in your regular browser.
  2. Reveal and copy your account key.
  3. Paste it into the OBS dock and click Open dock.

OBS uses its own browser, so you are not already logged in there. From the dock, Ctrl+click or middle-click Open Account so it opens in your regular browser; a normal click copies the link instead. The key is the same secret already used in Display URLs. Treat it like a password.

One-click add to your scene

  1. In OBS, open Tools → WebSocket Server Settings.
  2. Enable the WebSocket server. Copy the password (OBS generates one).
  3. In the dock, open Settings, paste the password, keep port 4455, and click Connect to OBS.
  4. Pick a counter, timer, chat overlay, or combined overlay and click Add to scene.

That creates a Browser source on the current program scene using the existing /view/… Display URL. Counters, timers, and chat use the dock source width and height (default 1920×1080). Combined overlays ignore those settings and use that layout’s canvas size (720p, 1080p, ultrawide, or a custom size) so the scene stays unstretched.

If WebSocket is off or the connection fails, Copy URL still works — paste it into a Browser source the usual way.

Control counters, timers, and clips

Each death counter, win/loss display, and timer has the same actions as the public API / Nightbot commands:

  • Deaths: +1, −1, Reset, and Set.
  • Win/loss: add or remove a win, tie, or loss; reset one column or reset all; set a value.
  • Timers: Start, Pause, Reset, plus add, remove, or set seconds. There is no separate Stop command — Pause stops the clock, and Reset returns it to the duration or baseline.
  • Create clip sits at the top of the dock and calls the same clip API as the dashboard command.

Buttons hit /api/… with your account key, then refresh the values shown in the dock. Chat and combined overlays do not have increment commands; edit those, or use a controller for a custom Stream Deck layout.

Edit, create, or delete from OBS

Use Edit to change the name, values (deaths, wins, timer seconds), chat sources, combined overlay canvas size, or mark an item as current. Create makes a new overlay with the same defaults as the dashboard. Delete removes it from your account; it does not automatically remove the OBS source.

Full styling (fonts, display masks, custom chat effects) still lives in the dashboard.