Support & Documentation

Go to Dashboard → Collections → Create Collection. Give the collection a name and description, set a cover image, and configure pack settings (cards per pack, price, rarity weights). Once created you can add cards to the collection.

Inside a collection click Add Card. Each card has:

• Name & Description — displayed to viewers
• Rarity — Common, Rare, Epic, Legendary, or Mythic
• Artwork — image or GIF uploaded from your Media Library
• Action — what happens on stream when the card is redeemed (alert, GIF overlay, sound, timer, TTS, etc.)
• Alias — a short name viewers type in chat to redeem via the chat bot (e.g. "!redeem danceemote")

Cards have five rarity tiers. You control the probability each rarity appears when a pack is opened:

You can customise pull rates per collection. Rarer cards typically have more impactful redemption actions.

When configuring a card, choose what happens when it's redeemed on stream. Available action types include:

• Alert — shows the card image with animation and optional sound on the alert overlay
• GIF Overlay — plays a full-screen or positioned GIF from your media library
• Sound Effect — plays a sound file through the overlay
• Card Timer — starts a visible countdown buff-style timer on stream
• TTS (Text-to-Speech) — reads the viewer's message aloud
• Custom message — displays a custom banner message

Actions can be combined and customised per card. Use the test buttons on the card edit form to preview how your card looks on the overlay before publishing.

Dashboard → Redemptions shows all pending and completed redemptions in real time. A badge counter on the sidebar shows the number of items awaiting your action. You can mark items as "Played" once the action is performed on stream, or "Skip" to dismiss them. The queue updates live without refreshing.

Go to Dashboard → Marathon. Create a new marathon by setting:

• Title and starting time amount
• Time added per card purchase, pack purchase, subscription, and HypeCoin donation
• Maximum time cap (optional)
• Goals and milestones with custom messages

Add the Marathon Overlay URL as a Browser Source in OBS to display the countdown on stream. You can start, pause, soft-pause (timer stops but still accepts time additions), resume, or end the marathon from the dashboard at any time.

• Active — timer counts down, all time additions from events apply
• Soft Pause — timer stops counting down but purchases and events still add time to the pool. Use this during IRL breaks while keeping viewers engaged
• Full Pause — timer stops and no time additions are accepted

A collaborative crossword puzzle displayed on the overlay. Viewers compete to fill in answers using !guess [number] [answer]. Points are awarded based on word length. The game ends when the time limit runs out or all words are solved. Categories are AI-generated and rotate automatically. Use !newcrossword in chat to start a fresh game, or !crossword for status.

A word search grid displayed on the overlay. Viewers type !find [word] to claim hidden words. First to find a word scores points (longer words = more points). Use !newwordsearch to start a new game, or !wordsearch for status.

Multiple-choice trivia with a countdown timer on the overlay. Questions are displayed with A/B/C/D options. First viewer to answer correctly via !answer [A/B/C/D] wins the point. Each viewer can only answer once per question. If no one answers in time, the answer is revealed and the next question begins. Use !newtrivia to start, !trivia for status. The dashboard lets you pause/resume/end trivia at any time.

Classic hangman displayed on the overlay. A series of words must be guessed before the man is hanged (6 wrong guesses max per word). Viewers type !letter [A-Z] to guess a letter or !solve [word] to guess the full word (wrong solves count as a penalty). Points are awarded for correct letters and bonus points for solving. Use !newhangman to start a new game, !hangman for status.

Family Feud-style survey game. A question is shown on the overlay and viewers type !feud [answer] to reveal answers on the board. Each correct answer adds time to the round timer. Getting the #1 answer earns a 10-point bonus. 3 strikes ends the round early. Multiple rounds per game. Use !newfeud to start, !feud for status.

A full Battleship grid displayed on the overlay. Ships are hidden, and viewers fire at coordinates via !fire [A-J][1-10] (e.g. !fire B5). Shortcut: !f [coord]. Each viewer has a configurable cooldown between shots. Points are awarded for hits and sinking ships. The game ends when all ships are sunk or the timer runs out. Use !newbattleship or !newbs to start, !battleship or !bs for status.

Scrabble-style word-building game. A set of letter tiles is displayed on the overlay and viewers must form valid English words from those letters via !word [word]. Longer and rarer words score more points. Viewers have a cooldown between guesses. Duplicate words are blocked. Use !newchatwords or !newcw to start, !chatwords or !cw for status.

A slot machine minigame. Viewers type !slots in chat to pull the machine, spending Viewer Points. Three reels spin with weighted symbols — matching symbols pay out points. Features include progressive jackpot (triple [HV] wins the pool), configurable cost/cooldown/payout multiplier, and big win overlay animations. Check balance with !slots balance. Configure in Dashboard → Games → Chat Slots.

A fun chat-only game. Viewers type !8ball <question> and the bot responds with one of 20 classic Magic 8 Ball answers (10 positive, 5 neutral, 5 negative). No overlay needed, always enabled, no configuration required.

Each game type supports an Auto-play setting in Dashboard → Games. When enabled, after one game ends a new game of the same type automatically starts after a configurable delay. This keeps your stream engaging without manual intervention.

Go to Dashboard → Chat Bot. Enable the bot for each platform (Twitch, YouTube, Kick) separately. You must have your streaming platform account connected in Settings → Connections first. Once enabled, the bot joins your channel and responds to commands in your chat.

Per platform you can configure:

• Enable/disable the bot for that platform
• Redemption command — the prefix viewers use to redeem cards (default: !redeem)
• Announce redemptions — whether the bot posts a message when a card is successfully redeemed
• Auto-promo messages — periodic messages the bot posts to remind viewers about your cards

Create custom commands from Dashboard → Chat Bot → Commands or via chat using !addcmd !trigger response (moderator+ only). Each command supports dynamic variables like {user}, {channel}, {count}, {random.pick a|b|c}, and more. Commands have per-command cooldowns, permission levels, optional aliases, and per-platform availability. Up to 200 custom commands per streamer.

• !addcmd !trigger response — create a command (moderator+)
• !editcmd !trigger new response — edit a command (moderator+)
• !delcmd !trigger — delete a command (moderator+)

Create scheduled messages from Dashboard → Chat Bot → Timers. These are messages the bot automatically posts in chat at configurable intervals (3–60 minutes) while you're live. You can set a "Min Chat Lines" requirement to prevent the bot from talking to an empty chat. Timer messages also support {variables}. Up to 25 timers per streamer.

The bot includes built-in informational commands:

• !commands — links to the streamer's profile page
• !uptime — shows how long the stream has been live
• !title — shows the current stream title
• !so <user> — shoutout another streamer (moderator+ only)

Automated chat filters to keep your chat clean. Configure at Dashboard → Chat Bot → Moderation.

• Banned Words — block messages containing specific words or regex patterns
• Link Protection — block unauthorized links; whitelist trusted domains. Mods can use !permit username to temporarily allow a user to post links
• Caps Filter — detect excessive CAPITAL LETTERS (configurable % threshold)
• Symbol Filter — block excessive symbols and ASCII art
• Emote Spam — limit the number of emotes per message
• Repetition Filter — block the same message repeated within a time window
• Paragraph Filter — block excessively long messages

All filters respect an Exempt Level setting — users at or above the chosen level (e.g., moderators) bypass all filters. On Twitch, violations can auto-timeout users. A moderation log tracks all actions.

Save memorable moments from your stream. Manage quotes from Dashboard → Chat Bot → Quotes or via chat commands.

• !quote — recall a random quote
• !quote 5 — recall a specific quote by number
• !addquote text — save a new quote (moderator+ only)
• !delquote 5 — delete a quote by number (moderator+ only)

Up to 1,000 quotes per streamer. Each quote is automatically numbered sequentially.

Named counters (e.g., death counter) that moderators can control via chat. Manage from Dashboard → Chat Bot → Counters.

• !counter name — view the current value
• !counter name + — increment by 1 (moderator+ only)
• !counter name - — decrement by 1 (moderator+ only)
• !counter name set 5 — set to a specific value (moderator+ only)
• !counter name reset — reset to 0 (moderator+ only)

Each counter supports a display template with {name} and {value} placeholders. Counter changes also emit real-time Socket.IO events for use in overlays.

Let viewers request YouTube songs that play through an OBS overlay. Configure at Dashboard → Chat Bot → Songs.

• !sr <YouTube URL> — request a song
• !song — show what's currently playing
• !skip — skip the current song (moderator+ only)
• !voteskip — vote to skip (configurable threshold)
• !wrongsong — remove your last request from the queue
• !volume 0-100 — set playback volume (moderator+ only)
• !srqueue — show upcoming songs

Add the music overlay (/overlay/music?streamer=username) as a Browser Source in OBS. Supports sub-only mode, max queue size, and vote-skip threshold.

A viewer queue for playing games with the streamer (1v1s, viewer games, etc.). Controlled entirely via chat.

• !open queue — open the queue (moderator+ only)
• !close queue — close the queue (moderator+ only)
• !join — join the queue
• !leave — leave the queue
• !queue — show who's in the queue
• !position — show your position
• !next — pick the next person (moderator+ only)
• !clearqueue — clear the entire queue (moderator+ only)

The queue is in-memory and resets when the server restarts. Max 50 viewers.

Quick chat-based giveaways where viewers enter by typing a keyword. Separate from the link-based Giveaways system.

• !giveaway start <keyword> [duration] — start a giveaway (moderator+ only)
• <keyword> — viewers type the keyword to enter (silent, no spam)
• !giveaway — show current giveaway status
• !giveaway draw — randomly pick a winner (moderator+ only)
• !giveaway reroll — pick a different winner (moderator+ only)
• !giveaway close — end the giveaway (moderator+ only)

Optional duration (in seconds) auto-closes entry. One entry per viewer. Winners are announced in chat.

Run polls from chat on any platform (Twitch, YouTube, Kick). Also mirrors Twitch native polls automatically.

• !poll start "Question" Opt1 | Opt2 | Opt3 [seconds] — start a poll (moderator+ only)
• !vote 1, !vote 2, etc. — cast your vote
• !poll — show current poll status and results
• !poll end — end the active poll (moderator+ only)

Polls support 2–6 choices. Optional duration auto-ends the poll. One vote per viewer per platform. Results display on the overlay in real time.

Show a countdown overlay during ad breaks so viewers know when content returns.

• !adbreak — start ad break with default duration (moderator+ only)
• !adbreak 90 — start a 90-second ad break
• !adbreak end — end the ad break early

You can also start/end ad breaks from Dashboard → Widgets → Ad Break. Customize the message, accent color, background style, and toggle the progress bar and time display.

Pin a chat message on the stream overlay for everyone to see. Displays for 15 seconds (configurable) with a countdown bar.

• !highlight Great play! — highlight a message on screen (moderator+ only)

You can also trigger highlights from Dashboard → Widgets → Chat Highlight with custom username and platform.

In addition to basic variables ({user}, {channel}, etc.), custom commands support these advanced variables:

• {time America/New_York} — current time in any timezone
• {countdown 2026-12-25} — time remaining until a date
• {math 2+2*3} — evaluate basic arithmetic (+, -, *, /, parentheses)
• {random.number 1 100} — random number in range
• {random.pick option1|option2|option3} — random choice from list

Viewers type the redemption command followed by the card's alias in your chat. Example: !redeem danceemote. Viewers must have their streaming platform account linked to their HypeVault account for this to work. The bot checks their inventory, deducts the card, creates a redemption record, and fires the overlay effect — all in seconds.

A configurable countdown timer overlay you can add to your stream. Set a target date and time, custom label text, and choose colours (background, text, accent). The overlay URL is /overlay/countdown?streamer=username. Add it as a Browser Source in OBS and crop/position as needed. The timer counts down in real time and displays days, hours, minutes, and seconds remaining.

A real-time hype meter that reacts to stream events — follows, subscriptions, bits/cheers, raids, donations, pack purchases, and card redemptions. Each event type has a configurable weight that adds to the meter. The meter decays over time when activity slows down.

The overlay features a 4-tier colour system (low, mid, high, max) with glassmorphism styling, a combo counter, and animated event text. It also integrates with Twitch Hype Trains — when a Hype Train starts, the overlay switches to a special mode showing train level, progress, countdown, and top contributors.

Configure event weights, decay rate, colours, and toggles in the widget settings. Overlay URL: /overlay/hype-meter?streamer=username. Use the test button to send sample events and preview the overlay. Note: Twitch Hype Train integration requires the channel:read:hype_train OAuth scope — re-connect your Twitch account if you linked it before this feature was added.

A transparent full-screen overlay that displays chat emotes and emoji floating across the screen in real time. When viewers use Twitch emotes or Unicode emoji in chat, they appear as animated elements on the overlay. Twitch native emotes are rendered as images from the CDN; emoji are rendered as text.

Configure max concurrent emotes, emote size, animation duration, speed, float direction (up, down, left, or right), and opacity. Overlay URL: /overlay/emote-wall?streamer=username. Add it as a 1920×1080 Browser Source in OBS — the background is transparent so it layers over your stream content. Use the test button to preview with sample emoji.

A compact horizontal bar showing your latest follow, sub, raid, donation/bits, and gift sub with platform icons (Twitch, YouTube, Kick). Choose Bar mode to display all events side by side, or Rotate mode to cycle through them one at a time.

Configure display mode, rotation speed, which event types to show, accent/text colours, background style (transparent, semi-transparent, or solid), font size, and platform icons. Events are persisted in the database so they survive page reloads. Overlay URL: /overlay/latest-events?streamer=username. Suggested size: 800 × 60 px (bar) or 400 × 80 px (rotate). Use the test button to preview with sample data, or the clear button to reset.

An animated card overlay that pops up when a moderator or broadcaster uses !so <username> in chat, or when someone raids your channel (if auto-shoutout is enabled).

The card displays the user's Twitch avatar, display name, last game played, and a customisable message. For raids, it also shows the viewer count with a special badge.

Customise the display duration, accent colour, background style (glass/solid/minimal), message templates (using {username} and {viewers} placeholders), and toggle avatar/game display.

Overlay URL: /overlay/shoutout?streamer=username. Suggested size: 500 × 200 px. Multiple shoutouts queue automatically.

An animated poll overlay that slides in when a poll starts and displays real-time results as viewers vote. Supports up to 6 choices with colour-coded bars, percentage labels, and a countdown timer.

Three ways to run polls:

• Dashboard: Create a poll from Dashboard → Widgets → Poll / Vote. Set a question, choices, and optional duration, then hit Start Poll.
• Chat command: Mods and broadcasters can type !poll start "Question" Option1 | Option2 | Option3 [seconds]. Viewers vote with !vote 1, !vote 2, etc. End with !poll end.
• Twitch native polls: If you start a poll in your Twitch dashboard, HypeVault automatically mirrors it to the overlay in real time. Requires the channel:read:polls OAuth scope — re-connect your Twitch account if you linked before this feature was added.

Overlay URL: /overlay/poll?streamer=username. Suggested size: 400 × 500 px. The overlay is transparent and anchored to the top-right corner.

Visit a streamer's profile, choose a collection, select how many packs to buy, and complete checkout via Stripe (credit/debit card). After purchase you're taken directly to the pack opening screen where each card is revealed with an animated flip. Cards are then added to your inventory.

After purchase you'll see a card-flipping animation for each card in the pack. Each card reveals its rarity glow and artwork. Duplicate cards are noted. Once all cards are revealed, they appear in your inventory. You can view your full purchase history under Viewer → History.

Viewer → My Inventory shows all cards you own, grouped by collection. Click any card to see its details including the redemption action, rarity, and quantity. Cards remain in your inventory until redeemed or destroyed for crafting resources.

To redeem a card, visit the streamer's profile while they are live (you can also redeem from a direct link on their page). Click "Redeem" on any card in your collection. The card's effect fires on the streamer's overlay in real time. The card is removed from your inventory after redemption. If the streamer is offline, redemption is usually blocked — check the card's settings. You can also redeem via chat bot by typing the redemption command.

On a streamer's profile, click a collection to see which cards exist and which ones you own. Cards you have are highlighted; cards you're missing are shown greyed out — helping you identify what to craft or buy next.

The Crafting Workshop (Viewer → Crafting) lets you exchange unwanted cards for crafting resources, then use those resources to craft specific cards you want. Destroying a card yields resources based on its rarity:

You must be following a streamer before you can craft their cards. Cards from streamers you don't follow appear as locked in the crafting interface with a "Follow to craft" indicator. Visit the streamer's profile, follow them, and return — the card will unlock immediately.