Getting started
What it is
Stream UI is a collection of overlay widgets for streamers using Streamer.Bot: chat, chatter greetings, chat activity rewards, a stream scoreboard and viewer score cards with achievements, shoutouts and clips, alerts, goals and subathon, counters, polls, timers, end credits, an emote and gifs wall, and screenshots and messages posted to Discord. You configure everything in your browser, then paste one URL per overlay into a browser source of your streaming software — OBS Studio, Streamlabs Desktop, Meld Studio, XSplit or any other app with browser sources.
The one thing to understand before anything else:
The four steps
Keep the tab open while you set things up, then let the browser source do the rest.
Connect Streamer.Bot
Start Streamer.Bot's WebSocket server, then connect from the Connection page. Everything stays on your PC. → Connecting Streamer.Bot
Pick your widgets
Switch off what you don't need and fine-tune each widget: the Streamer.Bot triggers it reacts to, its texts, goals, durations… → The widgets
Make it yours
Bring your look to the whole overlay, pick your canvas size and place each widget. → Appearance
Paste the URL in a browser source
Copy the overlay URL into a browser source in your streaming software. It works on its own: you can close the tab. → Layout and browser source
The seventeen widgets
Each widget has its own settings and, except Chat Activity Rewards and Discord Webhooks, which draw nothing, its own style and a live preview. They are grouped as in the tabs of Stream UI's Widgets page.
Chat
| Widget | What it does | Platforms |
|---|---|---|
| Chat Overlay | Multi-platform chat with emotes, badges, Twitch announcements, channel point redemptions, Bits, Kicks, YouTube Super Chats and Jewels, and an optional chat relay between your platforms | Twitch, YouTube, Kick |
| Chat First | The first chatter of each stream on every platform, with their picture and how many times they were first, as cards or a podium | Twitch, YouTube, Kick |
| Chatter Greeting | A welcome bubble with each viewer's picture at their first message, lurkers included if you want, with a sound, a chat message and custom greetings for newcomers, groups and returning viewers | Twitch, YouTube, Kick |
| Chat Activity Rewards | Runs your own Streamer.Bot actions and posts chat messages when chat reaches the message counts you set, for the whole chat and for each viewer | Twitch, YouTube, Kick |
| Emote and Gifs Wall | Chat emotes and gifs float across the screen with random animations | Twitch, YouTube, Kick |
Stream Scores — free in one overlay; Stream Scores Licence lifts their limits
| Widget | What it does | Platforms |
|---|---|---|
| Scoreboard | Your stream's stats per platform, counted by the triggers you pick, beside their all-time record, with a chat message when a record falls | Twitch, YouTube, Kick |
| Viewer Cards | Each viewer's own stats and the achievements they unlocked, on a card shown when they ask, or every viewer's in turn | Twitch, YouTube, Kick, integrations |
Stream events
| Widget | What it does | Platforms |
|---|---|---|
| Alerts | Follows, subs, cheers, raids, Super Chats and Streamer.Bot integrations like Ko-fi, one at a time with the viewer's picture, and optionally posted to Discord | Twitch, YouTube, Kick, integrations |
| Goals & Subathon | Goals per platform and integration, fed by the triggers you pick, and a subathon timer that grows with every event | Twitch, YouTube, Kick, integrations |
| Viewer Counter | Live viewers per platform or in total, plus unique chatters, on one line | Twitch, YouTube, Kick |
| Polls & Predictions | Live Twitch polls and predictions, and YouTube polls, with vote bars and a highlighted winner | Twitch, YouTube |
| End Credits | Full-screen scrolling credits: followers, subs, gifts, raids, moderators and chatters, kept in Streamer.Bot groups | Twitch, YouTube, Kick |
Twitch clips
| Widget | What it does | Platforms |
|---|---|---|
| Shoutout | A streamer's picture and one of their clips on your shoutout command, a raid or their first message | Twitch |
| Clip Autoplayer | Your Twitch clips shuffled and played back to back while your break scene is on | Twitch |
Utilities
| Widget | What it does | Platforms |
|---|---|---|
| Stream Counter | Counters for anything (deaths, wins…), raised, lowered, shown and hidden by your triggers, your own actions or by hand, and kept in Streamer.Bot | Twitch, YouTube, Kick, integrations |
| Timers | Countdowns with their picture, text and time bar, shown and hidden by your triggers or by hand | Twitch, YouTube, Kick, integrations |
| Discord Webhooks | Posts to your Discord channels when the Streamer.Bot triggers you pick fire — going live, every new screenshot of a folder… — one webhook for as many triggers as you like, even as the viewer who set it off | Twitch, YouTube, Kick |
Integrations are the services connected to Streamer.Bot: Ko-fi, Streamlabs, StreamElements, Fourthwall, Patreon and fifteen more. They stay off until you switch them on, on the Connection page.
Alerts, goals, counters and end credits react to the Streamer.Bot triggers you pick, with optional conditions — and in alerts and goals, a chat message and a sound. → Triggers and conditions
What to know
Your settings live in your browser. They are saved locally, not on a server. Switching machine or clearing the site's data wipes them — hence the export on the Connection page's Backup tab.
The browser source cannot read the website's storage. The whole configuration is therefore compressed into the hash of the overlay URL. Which explains the rule that is easiest to forget: after every settings change, you have to copy the URL into your browser source again. The Overlay builder warns you when the copied URL is out of date.
Several overlays, one that acts. You can make several overlays — landscape and vertical, say — each with its own URL. One of them runs the actions (chat messages, sounds, counts), so nothing is ever done twice; the others only display. → Several overlays
Positions and bars. Each widget sits in one of nine positions of the canvas, whose alignment and size you set; the chat and the goals can also run as a full-width bar along the top or the bottom. → Positions
Controls at hand. Skip an alert, clear the chat, add 1 to a counter, start the subathon: each widget's Controls tab has its buttons, and the controls window gathers them all in a dock of your streaming software. → The controls window
Your Streamer.Bot password never leaves your PC. A URL hash is never sent to the web server, and the URL fields of the site keep your settings hidden until you reveal them.
Free, thanks to ads. Ads on the website — never in your overlay — cover the hosting. An ad-free licence (from €2.99 a month, before VAT) removes them from the website: see the Support this project box on Stream UI's home page, or the Connection page's Licence tab. Stream Scores Licence (€4.99 a month or €99.99 once) lifts the limits of the Scoreboard and the Viewer Cards, and removes the ads too. With an adblocker on, or cookies declined, the website opens with a reminder from la_Syl and Ginny, their cat: switch the blocker off for the site, get a licence, or carry on anyway.