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)
Width × Height1920 × 1080
AudioCheck “Control audio via OBS” so alert sounds, Media Share videos & the soundboard are heard on stream (and volume-controllable in the OBS mixer)
Local fileLeave unchecked
Custom CSSLeave the OBS default — it keeps the background transparent
PerformanceLeave “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.

  1. Sign in with Kick. In the right panel under Mods with Access, type your mod's Kick username and click ADD.
  2. Click Copy mod invite link and send it to them (DM, Discord, wherever).
  3. 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.

Only the exact Kick usernames you add can edit your overlay. Anyone else who opens the link is asked to have you add them first — they can't touch your channel.

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:

  1. 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.)
  2. 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.

Kick has no "raid/host" webhook yet, so those aren't included. Verified-app limits apply to chat-message events, not to follows/subs/gifts.

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.

  1. Add the Media Share widget to your canvas (that's where approved videos play).
  2. Open 📺 Media Queue (right panel). Each request shows the video, who sent it, and how many Kicks.
  3. ✓ Approve, ✕ Reject, or ▶ Play a request — Play puts it on the overlay immediately. ⏹ Stop clears the player.
  4. 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.
Requires the same Kicks setup as alerts (the "Read KICKs" scope + webhook). A custom paid submit form (Stripe) is planned. Re-publish your Realtime Database rules so the queue can be managed.

Chatbot

Open 🤖 Chatbot (right panel) to set up two things, posted by the ModDeck bot in your chat:

  • Commands — a !trigger and 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

  1. On your Kick app, check "Write to Chat feed" (and, if you haven't, click Create a BOT for this App).
  2. Sign out and back in to ModDeck so your login grants the new posting permission.
  3. 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.

Timed messages only fire while you're live (never to an offline chat). Commands are delivered to ModDeck via Kick's chat webhook — unverified Kick apps have a chat-event limit, so very busy channels may want to apply for app verification.

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

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
Align / DistributeSelect 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):

💬 Kick ChatLive Kick + Twitch chat merged on one widget — name colors, real emotes, platform dots. Add your Twitch channel in Settings. YouTube soon.
🔔 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