Documentation
Quick start
- Open the dashboard.
- Click Get OBS Browser-Source Link and copy the URL.
- In OBS, add a Browser source, paste the URL, and set it to 1920×1080.
- Drag widgets onto the canvas, then hit Push to Live — your OBS source updates instantly.
OBS setup
Add the overlay as a single Browser source per scene:
| Setting | Value |
|---|---|
| Source type | Browser |
| URL | …/overlay.html?c=YOUR_CHANNEL (use Get OBS Link) |
| Width × Height | 1920 × 1080 |
| Audio | Check “Control audio via OBS” so alert sounds, Media Share videos & the soundboard are heard on stream (and volume-controllable in the OBS mixer) |
| Local file | Leave unchecked |
| Custom CSS | Leave the OBS default — it keeps the background transparent |
| Performance | Leave “Shutdown source when not visible” off |
The overlay background is transparent, so only your widgets show over your scene. Everything else can stay at OBS defaults — click OK and you're set.
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.
- Sign in with Kick. In the right panel under Mods with Access, type your mod's Kick username and click ADD.
- Click Copy mod invite link and send it to them (DM, Discord, wherever).
- They open the link, sign in with Kick, and land in your channel — they can edit the canvas and Push to Live alongside you.
A green dot next to a name means that mod is online and editing right now. Remove a mod any time with the ✕ — that instantly revokes their access.
Live alerts
ModDeck can pop an on-stream alert when someone follows, subscribes, gifts subs, or sends Kicks on Kick. Drop an Alert Box widget on the canvas to set where it appears and how it looks — real events animate in there automatically (one at a time, so a gift-bomb queues neatly).
Each event type (Follow, Sub, Resub, Gift subs, Kicks) has its own icon, message, sound, and GIF
in the Alert Box properties — toggle any of them on/off. Messages support the variables
{user}, {amount}, and {months}.
Use the Test on live overlay buttons in the Alert Box properties to fire a sample Follow / Sub / Gift / Kicks alert (with its sound + GIF) onto your overlay any time.
One-time setup
Real events need two things wired in your Kick developer app:
- Check "Subscribe to events (read chat feed, follows, subscribes, gifts)" — and, for Kicks-donation alerts, also "Read KICKs related information". (ModDeck requests these at sign-in.)
- Set the app's Webhook URL to
https://moddeck-worker.sevendwarfs.workers.dev/kick/webhook.
Then sign in to ModDeck once — that subscribes your channel to the alert events. From then on, alerts fire on their own while you're live.
Media Share
Let viewers request videos with their Kicks donations. When a viewer sends Kicks with a YouTube link in the message, it lands in your Media Queue as a request.
- Add the Media Share widget to your canvas (that's where approved videos play).
- Open 📺 Media Queue (right panel). Each request shows the video, who sent it, and how many Kicks.
- ✓ Approve, ✕ Reject, or ▶ Play a request — Play puts it on the overlay immediately. ⏹ Stop clears the player.
- Leave Auto-advance on (default) and approved videos play back-to-back automatically — when one ends, the next approved request starts. Turn it off to play each one manually.
Chatbot
Open 🤖 Chatbot (right panel) to set up two things, posted by the ModDeck bot in your chat:
- Commands — a
!triggerand the reply the bot posts, with a per-command cooldown. - Timed messages — text the bot posts every N minutes (great for socials/Discord reminders).
Both run 24/7 — !commands are answered and timed messages post automatically (timed messages while your channel is live), even with the dashboard closed. All config is saved to the cloud, shared with your mods across devices.
One-time setup
- On your Kick app, check "Write to Chat feed" (and, if you haven't, click Create a BOT for this App).
- Sign out and back in to ModDeck so your login grants the new posting permission.
- Click 📣 Send test message in the Chatbot panel — it posts to your chat and reports success or the exact error, so you can confirm posting works without waiting for a real trigger.
Posts appear as (in the Chatbot panel): ModDeck bot (default) posts as the bot and works even in subscribers-only / follower-only chat — no moderator setup needed. Your channel is the alternative, posting from your own account instead.
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 load a saved layout into staging (edit before going live). Scenes are full overlay setups — clicking one loads it and pushes it Live instantly, like an OBS scene switch.
Canvas & keyboard shortcuts
| Action | How |
|---|---|
| Pan | Hold Space + drag, or middle-mouse drag |
| Zoom | Scroll (toward cursor) · toolbar +/− |
| Recenter | Frame button |
| Select | Click · Shift+click multi · drag a box on empty space |
| Move / resize | Drag the element · drag a corner handle |
| Nudge | Arrow keys (Shift = 10px) |
| Edit text | Double-click a text element (Enter save, Esc cancel) |
| Duplicate / Delete | Ctrl/Cmd+D · Delete |
| Undo / Redo | Ctrl/Cmd+Z · add Shift to redo |
| Align / Distribute | Select 2+ elements → the Properties panel shows Align (left/center/right/top/middle/bottom) and, for 3+, Distribute (horizontally/vertically) |
Widget reference
17 widgets, each with its own properties (position, size, opacity, rotation, FX filters, and an optional auto-scheduler):
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.)