Mascot

People ask this as

Installed separately: this module does not come with the app installer. Open Module Catalog → Add-ons and press Install on its card; until then the app does not have it.

What this page is

Widgets → Mascot is a list of animated companions for OBS. Pirozhok the cat lives in a browser source: he has a fundraising goal of his own, food drops into his bowl when a donation arrives, he grows rounder as the goal fills, and he answers petting commands, subscriptions and follows.

The list

Every mascot is a row: a switch, its name, its goal amount in your base currency, and the buttons Copy link, Duplicate, Delete and Configure.

How to set it up

  1. Press Configure. The editor has three columns: the sections on the left, a live preview in the middle, the properties of the chosen section on the right. The name in the header belongs to the list alone, and viewers never see it.
  2. Character opens first. Cat size, %, Character horizontal offset, px and Character vertical offset, px place him in the frame; Blink, Breathing, Tail movement and Show ground shadow are the small movements you can switch off one by one. Fullness thresholds are three numbers: the percentage of the goal at which the cat takes the next shape. Out of the box they are 20, 55 and 100, which gives four shapes from slim to perfectly round. Character colors at the top of the section paint the cat: Pirozhok has Base fur, Markings 1, Markings 2 · tail and Eyes, Patata has Base fur, Markings 1, Markings 2, Eyes and Bow.
  3. Speech bubble holds what the cat says. Bubble shape offers Rounded card, Speech bubble, Thought bubble and Text only. Under Text are the phrases themselves: Idle messages, Sad messages, Message on donation, Message on petting, Message on subscription, Message on follow and Message on goal completion. The character's own lines are already written into these fields when you open the widget for the first time: add yours next to them and delete the ones you do not want. An empty field means the mascot stays silent on that event. Under each field are the placeholders that event can use, and clicking one inserts it where the cursor is: {user} only where the event brings a person, {amount} only on a donation, and {total}, {target}, {currency} and {percent} everywhere. Amounts are printed with a thousands separator, the same way the goal bar shows them, and the currency code appears only where you put {currency}. In the idle and sad fields one phrase per line gives you several, and Phrase order plays them In order or Random, no immediate repeats. Idle message display keeps the bubble Always visible or shows it Periodically, with Message display duration, seconds and Pause between messages, seconds.
  4. Bowl and food is the bowl in front of the cat: Show bowl, its two offsets, Bowl size, % and Progress on the bowl, which prints how far the goal has come across the rim. Below that are the food thresholds. The first card is Before the first threshold, what the cat gets for a small donation, and every card after it has a From amount. Nine treats are available: Kibble, Fish, Lobster, Burger, Chicken drumstick, Kebab, Steak, Shrimp and Broccoli. Add food threshold adds one, up to twenty. The highest amount a donation reaches decides what lands in the bowl, and Food stays, seconds is how long it stays there.
  5. Goal is the fundraising bar under the cat. Show the goal draws it; the money is counted either way. Pause fundraising stops the counting, and so does switching the mascot off in the list. Goal amount is the target, Minimum donation ignores anything smaller, and Donation sources is the list of services that count towards it. Set collected amount on save corrects the figure by hand, for a goal carried over from a previous stream or for money that came in outside the app, and Reset the collected amount next to it puts it back to zero; both apply when you press Save. With the bar shown you also get Goal title, Show goal title, Show collected and target amounts, Show progress bar and the look of each, plus Goal celebration, seconds for the little party when the target is reached.
  6. Reactions is who the cat answers and for how long.
    • Mood: Sad after minutes without donations, where 0 means he never goes sad, and Good mood after attention, seconds, which is how long petting cheers him up.
    • Donation: Donation reaction, seconds and Show hearts and sparks.
    • Petting: Chat petting command turns it on, Petting command is the word viewers type (!pet out of the box), Petting cooldown per viewer, seconds is how often one and the same viewer may do it, Petting duration, seconds is how long the reaction lasts, and Show petting hand draws the hand that strokes him.
    • Subscriptions and follows: React to subscriptions covers Twitch and YouTube, React to follows covers Twitch only. Each has its own duration and its own cooldown, and those two cooldowns count for the whole chat rather than per viewer, because their job is to survive a wave of bots. Reactions are shown one after another. A donation goes ahead of anything waiting, then subscriptions and follows, then chat commands, and nothing ever cuts off the reaction already on screen. When many are waiting, each one is shown faster so the queue does not fall a minute behind. A donation is the exception: it always keeps its full length.
  7. Petting caption is the line that appears across the bottom of the frame while the cat is being petted. The switch in the section header hides the line and its settings together.
  8. Meowing is off until you turn it on, because viewers see it. Meowing enabled opens three triggers, and each one works as soon as it is filled in: Chat command (!meow out of the box) with Meow command cooldown per viewer, seconds, Twitch reward and Kick reward, both chosen from the rewards of the connected channel. The two rewards are separate settings because the platforms number their rewards differently. Delay before opening mouth, seconds and Mouth open duration, seconds line the mouth up with whatever plays the sound in your setup, and Test meow shows the result in the preview.
  9. Backdrop is the panel behind the cat. Turn Backdrop behind the mascot off and the overlay stays transparent, which is what a scene in OBS usually wants.
  10. Test Mode above the preview opens a panel with Feed and an amount, Pet, Subscription, Sadness and Try weight, %. None of it touches the real money. The same panel shows Real collected amount, a reminder of the source size for OBS (600 × 600) and the Copy OBS link button.
  11. Press Save in the header. Reset Customization next to it drops the look you built and leaves the numbers alone. Colours, fonts, borders, shadows and templates work the same way as in every other overlay: see Styling an Overlay.
  12. In OBS add a Browser source of 600 × 600 and paste the link into it. Each mascot has its own link, and that link carries access to your widget, so do not publish it. Where the source sits on the screen is decided in OBS: see Overlays in OBS.

What it cannot do