Special terms and definitions

Documentation homepage

Here is a list of internal terms used in the rest of the documentation.

Admins

Admins are defined by the streamer and can use special administrative commands on the bot. Admins don't need to have moderator status in the channel. The chatterbot and streamer always have admin status and cannot be stripped of admin powers. Only the streamer and chatterbot have the power to add and remove admins. Admins have the power to destroy the item economy. Be very careful with admin powers. Admins can be added and removed using the addadmin and removeadmin commands.

Invulns

Invulns, or invulnerable chatters cannot be shot with items and cannot get hit by explosives. When an invuln uses an item or a lootbox they lose their invuln status. The intended use for invulns is for when a chatter doesn't want to participate in pvp or for when you need to talk to someone. Invulns don't need moderator or vip status in the channel. The chatterbot and streamer always are invuln and cannot be stripped of this status. Moderators can add and remove invulns. On your first message in chat you will recieve 10 minutes of invuln status. When a moderator adds you as invuln you will lose all items and qbucks. Invulns can be added and removed using the addinvuln and removeinvuln commands.

Moderators

Moderators are those with either Lead moderator or Moderator roles on the twitch channel. Moderators have access over quite a few commands used to change the immediate state of the bot. Item generation, qbucks generation, bot status manipulation are some of the things moderators can't perform. Moderators can be added and removed by the streamer with the built in twitch commands /mod and /unmod, via the UI or the API.

Moderators can be timed out with items/cheer events/commands. As twitch doesn't allow moderators to be timed out, the bot first removes moderator status, then performs the timeout. After the timeout is over, the bot will remod the freed chatter. No need for !modme.

Bots

Bots are ignored by the program. Bots cannot be timed out. Bots don't need moderator or vip status. Bots can be added and removed using the addbot and removebot commands.

Chatterbot/streamerbot

This depends on if the CHATTER_IS_STREAMER environment variable is set. If it's true, the chatterbot and streamerbot are the same account.

The chatterbot is the user that types in chat. They have very minimal required scopes as interacting with the stream is always done by the streamerbot. Only things the chatterbot does is relay whispers and send chat messages. In this case: eponirewq

The streamerbot (not that streamerbot) is the broadcaster. This bot needs them to authenticate as well. This account will be used to perform moderation and watch the chat. In this case: qwerinope

Using one account as both chatterbot and streamerbot hasn't been tested in a long time. There may be broken features.

Itemlock

When using/giving an item or qbucks the itemlock will be set at the start of the transaction and cleared when it ends. This is to prevent items being duplicated. Admins can toggle the itemlock on chatters with the itemlock command. This will stop a chatter from giving, receiving and using items and qweribucks. It will NOT stop them from using items by cheering, but if that cheer item usage fails, they will not be given an equivalent item as compensation.

Commands

Commands are functions that are triggered by typing an instruction in the chat.

All commands need a prefix. By default this is !.

Arguments like [this] are optional.
Arguments like <this> are required.

Commands and items can be disabled and enabled by moderators with the enablecommand and disablecommand commands.

Commands can have special aliases, these don't require the prefix. Special aliases have curly brackets around them in this document. For example: {blastin} on silver bullets.

A full list of commands can be found here