Password Distribution Bot

Short Description:

This bot can be used to have users request and receive a password for a game or show

Full Description

Welcome to the Password Distribution Bot.
Written by: butter_my_toast

This bot can be used for different purposes, most often such as passing out passwords to a group of users for a game or private show. You can choose your mode of distribution (what people have to do to get the password), and whether only the preferred users (mods, fans, defined list) get the password, or everyone can, or only the preferred list until a time period is up, or a max number of requests is fulfilled from the preferred list.

Password Request Mode (setting "2"):
- Type the word "pass" in the chat
- Type the number "1" in the chat
- Tip X tokens (then define the amount to be tipped in setting "3"). Anonymous tipping is supported, the actual user is shown the password, but the onscreen message will only show "Anonymous User"

When non-preferred users can get a password (setting "6"):
- Anytime (Everyone can request) - Once the password is set, anyone can request it through text or tipping. If using the "tipping" mode, this should ideally be the selection so that anyone who tips gets the password. The other methods will still work, but you could end up with people tipping and not getting the password if they are not in the preferred list.
- Never (Only "Preferred" List) - Only moderators, CB Fanclub, and the preferred list from the launch page can request or tip for the password.
- After the Time Limit - Until the time limit expires, only moderators, CB Fanclub, and the preferred list from the launch page can request or tip for the password. The password will be shown to the rest of the room once the time limit expires.
- After max users - Until the max user request limit is hit, only moderators, CB Fanclub, and the preferred list from the launch page can request or tip for the password. The password will be shown to the rest of the room 30 seconds after the max limit is reached.

The preferred list will by default include moderators and CB Fanclub members, and you can add other users to the list using setting "8" on the launch page.

If doing multiple cycles of passwords (such as playing a series of games), you can restart the bot each time you want to distribute a new password, or you can use the /newpass command to reset the bot between each one, which will clear the request list and set the new password.

Available Commands

1. /newpass [password]: (mods/bc only) Clear the current user list and set a new password. The new password is the parameter, such as "/newpass pass123" (no quotes).


2. /pwsettings: (mods/bc only) See the current settings from the launch page


3. /seepass: (mods/bc only) Display the current password only to the user entering the command.


4. /passlist: (mods/bc only) Display the list of current password holders.


5. /mypass: (all users) A user who has already requested or tipped for the password can have it displayed again.

Latest enhancements and fixes:

Version 1.0 - November 18, 2020 (Current Version):
- Created Bot, initial release