Documentation

Everything you need to run your overlay with ModDeck.

Quick start

  1. Open the dashboard.
  2. Click Get OBS Browser-Source Link and copy the URL.
  3. In OBS, add a Browser source, paste the URL, and set it to 1920×1080.
  4. Drag widgets onto the canvas, then hit Push to Live — your OBS source updates instantly.
ModDeck is browser-based — nothing to install. Your mods just open a link.

OBS setup

Add the overlay as a single Browser source per scene:

SettingValue
Source typeBrowser
URL…/overlay.html?c=YOUR_CHANNEL (use Get OBS Link)
Resolution1920 × 1080
AudioCheck “Control audio via OBS” if you use the soundboard
PerformanceLeave “Shutdown source when not visible” off

The overlay background is transparent, so only your widgets show over your scene.

Inviting mods

ModDeck is built so your moderators can run the overlay without any access to your OBS, audio mixer, or stream keys — they only control a blank web canvas that sits over your stream.

Live multi-account login and the mod allow-list are landing in the next release. Today the dashboard runs in a local/demo channel so you can build and preview everything.

Staging & Live

You always edit the staging canvas — viewers never see it. When something looks right:

  • Push to Live — copies staging onto the live overlay your viewers see.
  • Swap Live / Stage — exchanges them, so you can pull the current live layout back to edit.
  • Presets save a single styled layout; Scenes save the whole canvas for 1-click recall.

Canvas & keyboard shortcuts

ActionHow
PanHold Space + drag, or middle-mouse drag
ZoomScroll (toward cursor) · toolbar +/
RecenterFrame button
SelectClick · Shift+click multi · drag a box on empty space
Move / resizeDrag the element · drag a corner handle
NudgeArrow keys (Shift = 10px)
Edit textDouble-click a text element (Enter save, Esc cancel)
Duplicate / DeleteCtrl/Cmd+D · Delete
Undo / RedoCtrl/Cmd+Z · add Shift to redo

Widget reference

17 widgets, each with its own properties (position, size, opacity, rotation, FX filters, and an optional auto-scheduler):

💬 Combined ChatKick/Twitch/YouTube chat with platform icons.
🔔 Alert BoxSub/follow/raid alerts with animation + test trigger.
⏱️ TimerCountdown or count-up with a label.
🎯 Progress GoalAnimated goal bar (subs, follows, bits…).
📊 Live PollQuestion + options with animated vote bars.
✅ To-Do ListChecklist with done states.
🔢 TallyBig counter with +/−.
📰 TickerScrolling marquee text.
📋 Event ListRecent-events feed.
🎡 Prize WheelSpin for giveaways; same result on stream.
📝 TextHeadlines & lower-thirds (inline editable).
🖼️ Image / SlideshowOne image or a cycling set.
🎬 VideoLooping/auto-playing video.
⬛ ShapeRectangles, circles, pills.
🔳 QR CodeLive-generated, recolorable.
🌐 BrowserEmbed any website (optional interactive).
💻 Custom CodeSandboxed HTML/CSS/JS.

Soundboard & telestrator

🔊 Soundboard

Open it from Quick Actions → Soundboard. Add MP3/WAV URLs and hit Play to fire a sound through the overlay (it plays in OBS). Stop All cuts everything.

✏️ Telestrator (draw on stream)

Use the Pen / Erase tools in the toolbar to draw over your stream in real time — great for analyzing plays. Pick a color, erase strokes, or Clear the whole drawing. Hold Space to pan while the pen is active.

FAQ

Can mods break my stream?

No — they only control the overlay canvas, never your OBS, audio, or keys.

Does it work with StreamElements / Streamlabs?

Yes. Add ModDeck as one more Browser source on top of your existing setup.

Is it free?

Yes. (Early build — live login & cross-device sync are on the way.)

← Back to home