Docs

Everything you need to run Toybox LiveBot in your server.

Add to Discord

1Getting started

You need the Manage Server permission in the server you want to set up.

  1. Add the bot. Click Add to Discord, or log in and pick your server from Your servers. Discord asks you to confirm the server and the permissions.
  2. Pick an announcement channel. After adding the bot you land on the server's setup page. Choose a channel under Where to post. Choosing a role to ping is optional.
  3. Add streamers. Type a Twitch username (the part after twitch.tv/) and press Add. The bot checks that the account exists.
  4. Send a test. Press Test next to a streamer to post a sample announcement so you can see exactly how it looks.

Done! When anyone on the list goes live, the bot posts within about 1.5 minutes.

The dashboard

Log in with Discord at livebot.cigaming.dev/dashboard. You'll see two lists: servers that already have the bot (Configure), and servers you manage that don't have it yet (Add to server).

SectionWhat it does
Where to postThe default channel and default ping role. These save as soon as you change them.
StreamersAdd, edit or remove streamers. Each one can have a custom display name, their own channel, and their own ping role. Leave those on “Default” to use the server-wide settings.
Message & styleThe message text, embed colour, the “was live” edit, and a pause switch. Click Save message to apply.
Live previewShows roughly how the post will look in Discord, using your first streamer.
Recent posts / ChangesThe last announcements (click to jump to them in Discord), and who changed what — from the dashboard or /live.

Anyone with Manage Server can use the dashboard for that server. Access is checked live with Discord every time, so if someone loses the permission they lose dashboard access too.

Slash commands

Everything can also be done inside Discord with /live. These commands are only visible to members with Manage Server (server admins can change that under Server Settings → Integrations). Changes show up on the dashboard straight away, and the other way round.

CommandWhat it does
/live dashboardGet a link to this server's dashboard.
/live add login [display] [ping_role] [channel]Watch a streamer, or update one you already watch. Options you leave out stay as they were.
/live remove loginStop watching a streamer.
/live listShow the settings and everyone being watched.
/live test loginPost a test announcement for that streamer.
/live setchannel channelSet the default announcement channel.
/live setdefaultping [role]Set the default ping role. Leave the role empty to clear it.
/live setstreamchannel login [channel]Give one streamer their own channel. Leave the channel empty to go back to the default.

Message templates

The message text is the line above the embed. You can use these placeholders:

PlaceholderBecomes
{ping}The role mention (the streamer's role, or the default). Empty if there's no role.
{streamer}The display name (your override, otherwise their Twitch name).
{login}Their Twitch username, e.g. cigaming.
{title}The stream title.
{game}The category, e.g. Minecraft.
{url}The link to their channel.

The default is {ping} **{streamer}** is live now!. Normal Discord formatting works (**bold**, *italic*, emoji).

Heads up: if you take {ping} out of the template, nobody gets pinged, even if a role is set.

Examples:

  • {ping} 🎮 **{streamer}** is playing {game}! {url}
  • Hey {ping}, {streamer} just went live: *{title}*

Role pings

A role ping only notifies people if either of these is true:

  • the role has “Allow anyone to @mention this role” turned on (Server Settings → Roles → the role), or
  • the bot has the “Mention @everyone, @here and All Roles” permission. The invite link asks for it, but you can turn it off.

The dashboard warns you when a chosen role won't actually ping.

The bot only ever pings the role you picked. Even if someone types @everyone into the template, it won't ping everyone.

Permissions

PermissionWhy
View ChannelTo see the announcement channel.
Send MessagesTo post announcements.
Embed LinksThe announcement is an embed with the stream title and preview.
Mention @everyone, @here and All RolesOptional. Lets the bot ping roles that aren't set as mentionable. It never pings @everyone or @here.

If a channel has its own permission overrides, make sure the bot (or its role) can see and post there. In the channel dropdowns, channels the bot can't post in are marked with ⚠.

How it works

  • Every 90 seconds or so, the bot asks Twitch which of the watched streamers are live. It's one request for everyone in every server, so it's quick and gentle on Twitch.
  • Each stream is announced once per server. If the bot restarts mid-stream, it won't post again.
  • If a streamer goes offline and comes back with a new stream, that counts as a new stream and gets a new post.
  • With “was live” turned on, the post is edited when the stream ends: it turns grey and shows how long they streamed.
  • If a post fails (say, missing permissions), the error shows at the top of the dashboard. The bot tries again about every 10 minutes while the stream is still live.

Troubleshooting

Someone went live and nothing was posted

Open the dashboard and check for a red notice at the top — it says what failed. Usually it's channel permissions. Then press Test next to the streamer. Also make sure announcements aren't paused, and that the username is spelled exactly like their Twitch URL.

The post appears but nobody got pinged

See Role pings: the role must be mentionable, or the bot needs the mention permission. Also check that {ping} is still in your template.

My server isn't in the dashboard list

You need Manage Server (or Administrator) in that server. If you just got it, click Refresh list.

/live doesn't show up

New commands can take a few minutes to appear. Restarting Discord (Ctrl+R on desktop) helps. If you still don't see it, a server admin may have hidden it under Server Settings → Integrations.

Can I post to an announcement channel?

Yes. Announcement (news) channels work the same as text channels. Members following the channel from other servers get the post once it's published.

FAQ

How many streamers can one server watch?

Up to 50 per server.

Does it cost anything?

No.

What happens to my settings if I kick the bot?

They're kept for 30 days in case you add it back, then deleted. See Privacy.

Who can see my server's settings?

Only people with Manage Server in your server (plus the bot's operator, for support).

Need help?

Email admin@snugglesmp.com.