qweribot/README.md

qweribot

Concepts

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.

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 admins with the enable and disable commands. Not all Commands can be disabled, the DISABLEABLE field below shows if they can or can't. Items can always be disabled.

A full list of Commands can be found here

Items and Itemlock

Items are commands that can only be used when the chatter has them in their inventory.

Every user has a wallet with qweribucks, and an inventory. There is no limit to how many items each chatter can have.

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.

Items can be used with the alias as a command (example: blast qwerinope) or with the use command.

When an Item is used it is removed from the inventory of the chatter.

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 sending chat messages is done by the chatterbot.

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.

Commands

Fun commands

COMMAND	FUNCTION	USER	ALIASES	DISABLEABLE
ping	Testing command	anyone	ping	✅
yabai	Random number	anyone	yabai goon	✅
seiso	Random number	anyone	seiso	✅

Qweribucks commands

COMMAND	FUNCTION	USER	ALIASES	DISABLEABLE
getbalance [target]	Get balance of target or self	anyone	getbalance balance qbucks qweribucks wallet getwallet	✅
donate {target} {amount}	Give the targeted user some or all of your qweribucks	anyone	donate	✅
admindonate {target} {amount}	Gives the targeted user amount of qweribucks	admins	admindonate	✅

Item commands

COMMAND	FUNCTION	USER	ALIASES	DISABLEABLE
iteminfo {item}	Get item function and aliases	anyone	iteminfo itemhelp info	✅
inventory [target]	Get inventory contents of target or self	anyone	inventory inv	✅
give {target} {item} {amount}	Give targeted user amount of items	anyone	give	✅
use {item} ...	Use item. More info at The items section	anyone	use	❌
admingive {target} {item} {amount}	Give targeted user amount of new items	admins	admingive	✅

Administrative commands

COMMAND	FUNCTION	USER	ALIASES	DISABLEABLE
getcommands [enabled/disabled]	Get a list of all, enabled or disabled commands	anyone	getcommands getc	❌
getcheers [enabled/disabled]	Get a list of all, enabled or disabled commands	anyone	getcheers getcheer	❌
gettimeout {target}	Get the remaining timeout duration of targeted user	anyone	gettimeout gett	✅
vulnchatters	Get amount of chatters vulnerable to explosives	anyone	vulnchatters vulnc	✅
disablecommand {command/item}	Disable a specific command/item	admins	disablecommand	❌
enablecommand {command/item}	Re-enable a specific command/item	admins	enablecommand	❌
disablecheer {cheer}	Disable a specific cheer event	admins	disablecheer	❌
enablecheer {cheer}	Re-enable a specific cheer event	admins	enablecheer	❌
getadmins	Get a list of every admin in the channel	anyone	getadmins	❌
itemlock {target}	Toggle the itemlock on the specified target	admins	itemlock	❌
testcheer {amount} [args]	Create a fake cheering event	streamer/chatterbot	testcheer	❌
addadmin {target}	Adds an admin	streamer/chatterbot	addadmin	❌
removeadmin {target}	Removes an admin	streamer/chatterbot	removeadmin	❌

Items

NAME	COMMAND	FUNCTION	ALIASES
Blaster	blaster {target}	Times targeted user out for 60 seconds	blaster blast
Silver Bullet	silverbullet {target}	Times targeted user out for 24 hours	silverbullet execute
Grenade	grenade	Times a random vulnerable chatter out for 60 seconds	grenade
TNT	tnt	Give 5-10 random chatters 60 second timeouts	tnt

Cheers

NAME	AMOUNT	USAGE	FUNCTION
timeout	100	cheer100 {target}	Times specified user out for 1 minute