DEEN
← Home

Docs & Help

Everything about setting up and using SubWaveBot – step by step.

🚀 Getting started

Sign in to the dashboard with your admin e-mail. Under Platforms, connect Twitch, Kick and/or YouTube. Afterwards you will find ready-made overlay links with your personal token all over the dashboard – copy these into OBS.

🖥️ Overlays in OBS

Every overlay is a browser source. Copy the link from the dashboard and add it in OBS as a new browser source (width/height as stated, the background stays transparent).

With the overlay manager you arrange several widgets freely inside ONE single source (view "layout") – that saves space and keeps OBS tidy.

⏱️ Subathon timer

Define the time values (how much time a sub, gift, bits, kicks, follow or donation adds). Start/pause the timer in the dashboard or from your phone.

Add milestones, a happy hour (time multiplier) and the final sprint for the last minutes. For the finale there is a recap crawl featuring your top supporters.

🏆 Points, ranks & shop

Viewers automatically earn points for watching and participating. With !punkte they check their balance, with !rang their Fortnite-style rank.

In the shop they spend points on sound alerts or actions. An anti-fake activity score makes sure spam & emote-only messages are not rewarded – ideal for fairly rewarding your most active viewers at the end of a subathon.

🎮 Minigames

Playable right in chat: quiz (!quiz), wheel, coin flip, battle royale, heist and the ghost hunt. Each can be enabled individually, with its own costs, cooldowns and texts.

🤖 Chatbot & commands

Create custom commands, timed announcements, counters, quotes and social actions (!hug, !slap …) in the dashboard. Moderation filters banned words, links, caps & spam and can escalate via 3 strikes.

A public command overview is available at befehle.php – great for linking in your panels.

💬 Multichat & alerts

The chat overlay combines Twitch and Kick chat in one window – with the real platform badges and native as well as 7TV/BTTV/FFZ emotes. Ready-made design templates are one click away.

For alerts there are many built-in presets (Standard, Fortnite, Synthwave, Gold, Neon …). You can also save your current alert design as a custom layout and re-apply it any time.

For reading along on a second screen/prompter there are a stripped-down multichat viewer and an event overview as dedicated links.

📅 Stream schedule

Plan your streams as a weekly calendar with real dates, series (weekly/bi-weekly) and cancellations. Game covers are fetched from Twitch automatically.

Export the schedule as a finished graphic – story 9:16, post, landscape or Twitch panel – with templates (Neon, Ocean, Retro, Fortnite …), background image, avatar & header texts. Via the iCal link you can subscribe to the schedule in Google/Apple Calendar.

📱 Mobile & IRL control

The mobile control (control.php) installs like an app (PWA): timer, pause, skip song, wheel, coin flip and panic mode.

With IRL control you switch between 3 freely editable OBS scenes on the go. There are also lean prompter views for events and chat – perfect for an Elgato Prompter or a second monitor.

✨ AI assistant

Connect an AI provider (e.g. Google Gemini – free tier available). The bot will then answer !aski questions in chat, and inside the admin area an assistant helps you set up and understand every feature.

🔑 API keys

Most integrations (ElevenLabs voices, TikTok, Tiltify, Discord) are provided by the platform – the operator maintains the required keys, there is nothing for you to obtain.

The only key you enter yourself is your AI key: Google Gemini (free) at aistudio.google.com/apikey → "Create API key" → copy it and enter it in the AI section (Chatbot → AI). Alternative: Groq at console.groq.com/keys. The key is stored encrypted and never shown in plain text again. Never share keys in chat/Discord!

Twitch permissions (no key): for auto-VIP & native polls simply reconnect Twitch in the Platforms tab – nothing to copy.

🔌 API & webhooks

Under 🔌 API & Webhooks in the dashboard you connect your own tools to your channel. Outgoing webhooks report booked events (subs, gifts, bits, donations, follows, raids, hype train) via HTTP POST to up to 5 of your own targets.

In the same card you can create multiple REST API v2 keys for new integrations, each with only the scopes it needs. Every key is shown in plain text only once and can be revoked individually.

Verifying a delivery: every delivery carries the header X-SubWave-Signature: sha256=…. Compute HMAC-SHA256 over the raw request body with the target's secret and compare in constant time – discard on mismatch.

REST API v2 can read timer, stats, events, goals, queue, clip markers and the latest stream report. Safe POSTs are intentionally limited to timer, queue and new markers and always require Idempotency-Key. The machine-readable contract is available through the OpenAPI link in the dashboard. Legacy v1 stays read-only compatible.

Discord tip: paste your Discord webhook URL, pick the "Discord" format – done. SubWaveBot then posts ready-made embed messages straight into your channel.

🛠️ Troubleshooting

Overlay shows nothing / "not available": re-copy the link from the dashboard (the token may have changed).

Commands do not respond on one platform: check that the platform is connected and the bot is allowed to send chat there. You can see the connection status in the Platforms tab; the Events tab shows live what is coming in.