Documentation

Part of the App Guide: This page picks up where the main App Guide leaves off. If you haven't connected Twitch and set up Channel Points yet, start there first.

Contents

Use the links below to jump directly to the section you need.

1. Community Tab Overview

What this is: the Community page in the SnapShield desktop app groups the tools that make your stream interactive: giveaways, a subathon timer, counters, mini games and two overlay games that your viewers play from Twitch chat. Each tool shows its results on an OBS overlay.

The Community Tabs

Tab What it does
Giveaway Run viewer giveaways from chat commands, with an on-stream overlay and a spinning winner animation.
Games Twitch chat mini games with virtual coins. Covered in the Games section of the App Guide.
Subathon A stream timer that grows when viewers follow, subscribe, gift subs, cheer, raid or redeem rewards.
Counters Counters, timers and countdowns (for example a death counter) controlled by chat commands.
Snake Invaders An overlay game where chat joins a snake that must reach the bottom of the screen while guns shoot at it.
SnapDungeon An overlay dungeon raid where viewers become heroes, fight monsters and collect items.

Before You Start

  1. Connect your Twitch streamer account in the Accounts section (see Accounts: Connect Your Twitch).
  2. Connect the Twitch bot so SnapShield can read chat commands and post messages.
  3. Add a SnapShield overlay to OBS as a Browser Source (1920×1080 is recommended). See Overlay: Show Alerts in OBS.
  4. On each Community tab, choose which overlay that tool should display on.
  5. Keep SnapShield running while you stream. These tools only work while the app is open.
Features that use Twitch Channel Points rewards (giveaway entries, subathon time rewards, counter countdown rewards and SnapDungeon start rewards) need a Twitch channel that can use Channel Points. SnapShield can only create rewards on channels where Twitch allows it, which normally means Affiliate or Partner status.

Tips

  • Use the test options on each page to preview the overlay before going live.
  • Use a separate overlay for each busy tool if you want to position them independently in OBS.
  • Give moderators the mod commands for each tool so you can stay focused on the stream.

Troubleshooting

Problem What to check
Nothing appears on stream Confirm the OBS Browser Source is using the overlay address you selected for that tool, SnapShield is running, and the source is visible in the scene.
Chat commands do nothing Confirm the Twitch bot is connected and the command is allowed for the chatter's permission level.
A reward can't be created or doesn't appear Check that Channel Points are available on your channel and that the streamer account is connected. Reward icons cannot be set by SnapShield; upload one in the Twitch dashboard if you want one.

2. Giveaways

What this is: run a giveaway for your viewers. Viewers enter by typing a command in chat (or by redeeming a channel point reward), SnapShield picks a random winner, and a giveaway panel shows on your stream through an overlay. You can run it from the app's buttons or entirely from chat with mod commands.

2.1 Set up the overlay (once)

  1. Open Community, then the Giveaway tab (the first tab), and scroll to Overlay.
  2. Choose which overlay it appears on under Show on overlay. If you already use an overlay for alerts in OBS, you can use the same one. Otherwise add a new one on the Overlay page first (see section 9).
  3. Pick a Theme. There are eight (Midnight, Neon, Sunset, Forest, Clean light, Retro pixel, Gold and Twitch purple).
  4. Change anything you like: the Title text, the Font and Title font, and each colour (panel, border, text, secondary text, accent, entries box, entries text). Click a colour box to pick a new colour. Reset colours and fonts to the theme puts the theme's own look back.
  5. Set where it sits with X and Y (pixels from the top-left of a 1920×1080 canvas), its Size (percent), and how many Names shown in the list at once.
  6. Scroll speed controls how fast the names scroll when more people have joined than fit in the list (set 0 to stop scrolling). Winner spin is how many seconds the names spin before landing on the winner (set 0 to skip the spin).
  7. Click Preview on overlay (10 seconds) to see the list, or Preview winner draw to watch the spin and the winner reveal, without starting a giveaway.
  8. Click Copy overlay address, and in OBS add a Browser Source with that address (1920×1080). The panel stays hidden until a giveaway starts.
  9. Click Save Giveaway Settings.

2.2 Start a giveaway from the app

  1. Connect Twitch on the Accounts page. The giveaway runs inside the bot.
  2. In Run a giveaway, type the Prize.
  3. Optionally type a Time limit such as 5m, 30s or 1h. Leave it empty for a giveaway with no time limit.
  4. Choose how viewers enter:
    • Viewers type the join command in chat – the default is !join.
    • Viewers redeem a channel point reward – set the Reward cost. SnapShield creates the reward for you and removes it when entries close. This needs a channel with channel points (Affiliate or Partner).
  5. Click Start giveaway. The overlay appears and the bot announces it in chat.
  6. Use the other buttons while it runs:
    • Pick winner – close entries and pick someone now.
    • Pause timer / Resume timer – stop and restart the countdown.
    • Set time left – change how long is left, for example 1m.
    • Reopen – let new people join without starting over.
    • Reset – end the giveaway and hide the panel.
  7. In Entries, select a name and click Ignore selected (blocks them from this giveaway) or Ban selected (blocks them from every giveaway until SnapShield is restarted).

2.3 Chat commands

For moderators (the word !giv can be changed under Chat commands; by default moderators and the streamer can use it):

CommandWhat it does
!giv start 5m Super Awesome PrizeStarts a 5-minute giveaway.
!giv start 30s Quick Everyone Enter!Starts a 30-second giveaway.
!giv start Long GiveawayStarts a giveaway with no time limit.
!giv startredeem 500 5m Super Awesome PrizeStarts a 5-minute channel point giveaway where entering costs 500 points.
!giv startredeem 500 Long GiveawayThe same with no time limit.
!giv pickPicks a winner now. Use it again to pick another winner.
!giv time 1mChanges the time left to 1 minute.
!giv pause / !giv resumePauses or resumes the timer.
!giv resetResets and hides the giveaway.
!giv reopenReopens entries. Add a time to restart the timer, for example !giv reopen 2m.
!giv ignore name / !giv unignore nameStops or allows a viewer entering this giveaway.
!giv ban name / !giv unban nameStops or allows a viewer entering any giveaway until SnapShield restarts.

For viewers (you can change each word under Chat commands):

CommandWhat it does
!joinEnter the giveaway.
!unjoinLeave the giveaway.
!winThe chosen winner claims the prize.
!skipmeThe chosen winner skips the prize, and SnapShield picks someone else.

2.4 What happens at the end

  1. When the timer reaches zero, entries close. If Pick a winner automatically when the timer ends is ticked, SnapShield picks one at random. The overlay spins through the names like a slot machine, slows down and lands on the winner, then the bot announces them in chat. Otherwise it tells chat that entries are closed and waits for you to pick.
  2. The winner has the number of seconds you set under Winner has … seconds to claim to type !win. The overlay shows a countdown.
  3. If they type !skipme or run out of time, and Pick someone else if the winner skips or doesn't claim in time is ticked, SnapShield picks another entrant. Anyone already picked can't be picked again in the same giveaway.
  4. When the winner types !win, the overlay shows the prize as claimed. Click Reset to hide it, or pick another winner for a second prize.

2.5 Behaviour and chat messages

  • Giveaways enabled turns the whole feature on or off.
  • Announce giveaway events in chat turns the bot's chat messages off if you want a silent giveaway.
  • Reply in chat whenever someone joins is off by default because it is noisy in a big giveaway.
  • Who can join can be limited to subscribers or VIPs.
  • Followers: tick Must be following the channel for at least and choose a number of days (0 means any follower). SnapShield checks with Twitch when someone joins, using your connected streamer account. Viewers who don't qualify get a chat reply (at most one every 30 seconds each), and channel point redemptions from them are refunded. You can reword both replies under Chat messages.
  • Under Chat messages you can reword everything the bot says. Use tokens such as {winner}, {prize}, {count}, {time}, {cost}, {join_command} and {claim_seconds}. Leave a message empty to send nothing. Restore default messages undoes your changes.
  • Always click Save Giveaway Settings after changing anything.

Good to know

  • If you press Start giveaway and a red message appears under the buttons saying Twitch isn't connected, go to Accounts and click Connect, then try again. Any other problem is shown in the same place.
  • The giveaway is held by the running bot. If SnapShield is closed or Twitch is disconnected mid-giveaway, it ends.
  • Bans last until SnapShield is restarted.
  • In a channel point giveaway, a second redeem by the same person, or a redeem by an ignored or banned person, is refunded automatically.

3. Subathon

A subathon is a countdown clock that your viewers extend. Follows, subs, gifted subs, bits, raids and channel point rewards each add time, and the clock shows on your stream through an overlay. Open Community and click the Subathon tab.

3.1 Choose what adds time

  1. In What adds time, type how many seconds each one adds. 0 turns it off. The defaults are 10 seconds for a follow and 30, 60 and 90 seconds for Tier 1, 2 and 3 subs. Change them to anything you like.
  2. Bits: "Every 100 bits adds 10 seconds" is the default. Change both numbers.
  3. Raid: a flat amount, plus optional extra seconds per raiding viewer, with a minimum raid size.
  4. A person's follow only counts once stops people unfollowing and refollowing to add time again.
  5. Gifted subs add time for every sub gifted. A viewer who gifts 5 Tier 1 subs adds 5 × the Tier 1 time.

Subs, gifts, follows and raids come from Twitch events, so the Streamer account must be connected on the Accounts page. Bits are read from chat.

3.2 Channel point rewards

  1. Under Channel point rewards each row is one reward: its name, its cost and how many seconds it adds. The default is "Add time to the Subathon", 5000 points, adds 10 seconds.
  2. Click Add a reward for more (for example 20000 points for 1 minute). Untick a row to skip it, or click Remove.
  3. SnapShield creates these rewards on your channel when the subathon starts and removes them when it ends or is reset. This needs Twitch Affiliate or Partner.
  4. Reward changes apply the next time you start a subathon.

3.3 Set up the overlay

  1. Under Overlay choose which overlay it shows on (the one you use for alerts works), pick a Theme, and change the title, finished text, fonts and colours. Besides the usual colours you can change the Time bar, Bar background and the Pop-up colours.
  2. Set X, Y, Size and Width. Tick or untick the time bar, the totals, the top supporter and the pop-ups ("Sam followed +10s").
  3. Click Preview on overlay (10 seconds) to see it. Then Copy overlay address, add it to OBS as a Browser Source (1920×1080), and click Save Subathon Settings.

3.4 Run it

  1. Connect Twitch on the Accounts page.
  2. In Run the subathon type the Starting time, such as 3h, 90m or 1h30m, and click Start subathon.
  3. Pause / Resume, End and Reset do what they say. Type a time and use Add time, Remove time or Set time left to correct the clock by hand.
  4. Time bonus multiplies everything viewers add. Set it to x2 for a "double time" hour and click Apply to running subathon.
  5. Recent activity lists everything that added time.
  6. The clock keeps counting while SnapShield is closed, and a running subathon carries on when you reopen it.

3.5 Chat commands

Mod command (default !subathon): start <time>, pause, resume, add <time>, remove <time>, set <time>, multiplier <x>, end, reset, status. For example !subathon start 3h, !subathon add 5m, !subathon multiplier 2.

Viewers can type !subtime to see the time left. You can rename both commands, choose who may use them and reword every chat message on the page.

Limits and options under Behaviour

  • Longest the clock can be stops the clock going above a limit (0 means no limit).
  • Finish automatically at zero ends the subathon and shows your finished text.
  • Still add time while paused is on by default.
  • Post a chat line for every follow, sub, bits... is off by default because it is noisy.

4. Counters, Timers and Countdowns

Make as many as you like on the Counters tab of Community. There are three types:

  • Counter – a number chat can raise, like !deaths or !wins.
  • Timer (counts up) – a stopwatch, like time on this boss or time in this run.
  • Countdown (counts down) – a clock that counts down to zero, like "next break in 20 minutes". Viewers can add more time with channel points.

4.1 Make one

  1. Pick a type next to Add new, click Add new, then change the settings below the list and click Save Counters.
  2. Name is what chat and the banner call it. Chat command is the word viewers type, such as !deaths. Every item needs its own command.
  3. Who can change it can be everyone, followers, subscribers, VIPs, moderators or only the streamer. Anyone can always ask for the current value by typing just the command.
  4. Set a Cooldown if you want a gap between changes from chat (moderators skip it). Reply in chat when it changes can be turned off for a quiet counter. Every chat message can be reworded.

4.2 Counters

  • Typing just the command (for example !deaths) adds one if you are allowed to change it. Everyone else sees the current number. Untick "Typing just the command adds one" if you only want the commands below.
  • !deaths + 3 adds 3, !deaths - takes one away, !deaths set 10 and !deaths reset set it. Taking away, setting and resetting are for moderators and the streamer.
  • Add this much each time changes how much one add is, and Reset goes back to is the number a reset returns to.
  • For example, a death counter with "Who can change it" set to Moderators means your mods type !deaths each time you die.

4.3 Timers and countdowns

  • Everyone sees the time by typing the command (!timer). Start, pause, resume, stop and add or remove time follow Who can change it. For example !countdown start 5m, !countdown add 1m, !countdown pause. Set and reset are for moderators.
  • A countdown has a Default countdown time that Start uses when you don't type one, tells chat when it reaches zero, and the banner shows your Finished text.
  • You can also use the buttons under Live: start, pause, resume, stop, add or remove time, set the time, or reset.

4.4 Channel points (off by default)

  1. Tick Let viewers add to it with channel points, then choose the reward name, its cost and how much it adds (a number for a counter, seconds for a timer or countdown).
  2. Click Save Counters. SnapShield creates the reward while it is connected to Twitch and switches it off when it closes. This needs Twitch Affiliate or Partner.
  3. If a countdown or timer isn't running when someone redeems, the redemption is refunded.
  4. For example: a countdown where 5000 points adds 30 seconds, so viewers keep a stream break going.

4.5 Banner on the overlay

  1. Tick Use banner to show it on the overlay. With it off, the item works in chat only.
  2. Choose which overlay it shows on, pick a Theme and change the banner text, fonts and colours (including the bar colours). Set X, Y, Size and Width. Several items can show at once, each in its own place.
  3. A countdown can show a bar with the time left. When something is added, a small "+1" or "+30s" pops up above the banner.
  4. Click Preview on overlay (10 seconds), then Copy overlay address and add it to OBS as a Browser Source (1920×1080).

Values and clocks are saved, so they survive closing SnapShield. Timers and countdowns keep their time while the app is closed.

5. Snake Invaders

A chat game on the overlay. Chat joins to build a snake; cannons at the bottom shoot it while it crawls from the top of the screen to the bottom. If the head reaches the bottom, chat wins. If every section is shot, the cannons win.

5.1 How big is the snake?

The snake always has a head and 4 free sections, plus one section for every viewer who joins (with their name on it). More joiners means a longer snake that is harder to wipe out. Every hit removes a section. Even one person on their own has a small chance (a few percent); with about 10 joiners it is roughly 50/50 on Normal, and 20+ joiners will nearly always win.

5.2 Run a game

First click the red OFF button to the left of Open lobby so it turns green (ON). Snake Invaders is OFF by default; switching it off closes any game in progress.

Channel point reward: like SnapDungeon, SnapShield creates a reward (default Start Snake Invaders, 1000 points; needs Affiliate or Partner) that opens the lobby. You can change its name, cost and colour on the page. It is switched off while a game is on, and removed from Twitch when SnapShield closes (it comes back on the next start). If a game is already running when someone redeems it, their points are refunded.

  1. Open Community > Snake Invaders. Click Open lobby (or a mod types !snake start, or !snake start 90s for a 90 second lobby).
  2. Chat types !joinsnake. Names appear on the overlay as they join.
  3. When the lobby timer ends (or you click Start now / a mod types !snake go) a short countdown runs and the snake sets off.
  4. A win or lose screen shows for a few seconds. SnapShield keeps a record of snake wins vs cannon wins.

5.3 Settings

  • Cannons (4 to 6) and Difficulty (Easy, Normal, Hard) decide how hard the cannons are to beat.
  • Lobby time, countdown, most players, who can join and who can control it.
  • Let people join late lets viewers join while the snake is moving; they become new sections.
  • Chat announcements can be switched off, and all the messages can be edited.

Avatars on the snake

Each section shows the joiner's Twitch profile picture. In the Overlay card, "Snake sections show" lets you choose Avatar, Name or both. If Twitch can't supply a picture (or you're not connected) the section shows the name instead.

5.4 Overlay

Pick which overlay to show it on, a theme and colours, and the position and size. You can upload your own background picture (a space scene works nicely). Click Preview on overlay to see a sample, then Copy overlay address for OBS (Browser Source, 1920×1080).

6. SnapDungeon

A role-playing raid for your chat. A viewer redeems a channel point reward to open the dungeon, everyone has 60 seconds to join, then the heroes go in and take turns, one at a time: fighting monsters, opening chests and finding gear and pets. Every viewer has their own hero that keeps its level, gear and pets between dungeons.

6.1 How a dungeon runs

First, switch it on. The red OFF button to the left of Open dungeon now turns green (ON) when you click it. SnapDungeon is OFF by default, and while it is off the reward does not exist and commands are ignored.

  1. Start. A viewer redeems the reward (SnapShield creates it for you, default name Start the SnapDungeon, 1000 points; this needs Twitch Affiliate or Partner). You can also click Open dungeon now on the page, or a mod types !sd start (or !sd start 90s for a longer lobby). The person who redeems it joins the party automatically.
  2. Waiting (60 seconds). Chat types !sdjoin. Their heroes appear on the overlay and wait around at the entrance, with a countdown on screen. A mod can use !sd go (or the Start now button) to start early.
  3. The dungeon. The doors close and the heroes go one at a time. On each turn a hero fights a monster, opens a chest, finds gold, trips a trap or prays at a shrine. Every hero gets a set number of turns (5 by default). The message feed shows what happens ("X slew a Cave Troll!", "Y found a lvl 2 golden helmet!").
  4. Dying. A hero who loses a fight dies, loses a small amount of XP (15% of what they need for the next level, never a whole level) and is out for the rest of that dungeon. They can join the next one.
  5. The boss. When all turns are done the survivors fight a boss together. If they win, everyone gets XP and a rare-or-better item.
  6. The end. The survivors return to the waiting area for 20 seconds (a summary shows: "7 of 9 heroes made it out alive!") and then the overlay closes. While a dungeon is open or running the channel point reward switches itself off, and comes back when it is over.

6.2 Chat commands

CommandWhat it does
!sdjoinJoin the open dungeon (the older !joinsd also works).
!sdleaveLeave the party while the lobby is still open.
!sdbagLists your level, what you are wearing, your pets and spare items. Works any time.
!sdequip <item or pet>Wear an item or take a pet, e.g. !sdequip golden helmet, !sdequip lvl 3 iron axe, !sdequip cat.
!sdstatsLevel, experience, power, kills, chests, bosses, gold.
!sdtopThe top 5 heroes.
!sd start [time], !sd go, !sd stop, !sd reset <user> (mods)Open the dungeon, start early, close it, or start one hero again.

All the command words and who may use them can be changed on the page.

6.3 Heroes, gear and pets

  • 60 enemies across 10 areas (Sewers, Crypts, Troll Caves ... The Void), each with its own boss. A hero fights in the area that matches their level.
  • Gear: 7 slots (weapon, helmet, armour, boots, shield, ring, amulet), levels 1 to 10 from lvl 1 rusty to lvl 10 celestial, five rarities, plus 12 legendary uniques. Each piece changes attack, defence and luck. The best piece for each slot is worn automatically. Use !sdequip to wear a different one.
  • Luck gives more loot, better rarity and a better chance of pets.
  • Pets are rare: Loyal Dog (helps win fights), Lucky Cat (finds more items), Sly Fox (extra gold), Wise Owl (extra XP), Shadow Wolf, Mini Unicorn, Baby Phoenix, Dragon Whelp and more. Your first pet is taken along automatically; switch with !sdequip.
  • Levels come steadily: around level 10 after about 20 dungeons, with level 50 as a long-term goal.

6.4 Settings

  • How a dungeon starts: switch the reward on or off, its name, cost and description.
  • The dungeon run: time to join, time between turns, turns per hero, how long survivors wait at the end, fewest and most heroes, XP lost on death, the final boss and how long it lasts.
  • Chat messages: Highlights only, Every adventure or Nothing. Events are grouped into one chat message every few seconds so chat isn't flooded. The overlay always shows everything. The lobby opening and the final result are always announced (unless chat is set to Nothing).
  • Erase ALL saved heroes starts everyone from scratch (it asks first).

6.5 Overlay and your own dungeon picture

  1. Click Upload dungeon image and choose a dungeon, castle or cave picture (16:9 works best). Your heroes stand in front of it.
  2. Tick Make the background transparent to remove the picture and box, so only the heroes and messages float over your scene.
  3. Pick a theme and colours for the message feed, which side it is on and how many lines show.
  4. Set the position and size, then Preview on overlay and Copy overlay address for OBS (Browser Source, 1920×1080). The overlay is only visible while a dungeon is open or running.

Heroes are drawn wearing their gear: the colour of the helmet, armour and weapon shows what material they found. The hero whose turn it is has a glowing ring under their feet.