Loyal Family Bot

Created for: Missy_Mell

Version v1.7.11 by noiett
Contact: @biosandapps or noiett.cb(at)gmail(dot)com

Original bot by tablesalt90
Contact: @tablesalt90 or tablesalt90(at)gmail(dot)com

Scroll down to the bottom to view the latest changes for each version

This bot is for use by Mellyboo to recognize user of various status levels in
her chat room. Users may tip various amount to earn the label of Family, Lover, Fiance,
and Husband. The bot has an additional status level of Friend which is reserved for
those users that don't tip, but Mel deems worthy.

The levels are as follows:

Tip 500 to become a member of the Loyal Family.

Tip 1000 to become Mel's Lover.

Tip 1500 to become Mel's Fiance.

Tip 2000 to become Mel's Husband.

Level names: Each level has multiple names to make them easier to use and remember. For example, the husband level
can be used as "husband" or "husbands" the bot will recognize both. This is also true for the friend level, you may
use "friend" or "friends". The only level that has a single name is the family level. Below is a list of level names.

Family - family

Friends - friend, friends

Lovers - lover, lovers

Fiances - fiance, fiances

Husbands - husband, husbands

A user may only belong to one status level (Friend through Husband) at a time. If a user is
a Family member and tips 1000 tokens they will be promoted to Lover and no longer be under the
Family label.

The bot has several commands that Mel and her mods (when mod commands are enabled) may use.
You send a command to the bot by first using the trigger /melbot.
For example, if you wanted to see information on using the bot you would type: /melbot help
and you would see the bot help message.

Command aliases: Most commands have aliases you can use that will execute the same command. For example,
the adduser command has the following aliases: useradd and add. You can use the word "add" in place of
"adduser" and get the same result. Aliases make the bot commands easier by allowing you to variations of the command
words instead of having to remember strict commands.

Below are other bot commands that may be used.

mods - This command toggles that ability for mods to issue bot commands.

Usage: /melbot mods on and /melbot mods off

Aliases: modcommands

greets - The greets command toggles greetings messages that are shown when a user in one of the levels
enters the room. These greetings are shown to everyone in the chat room. All users see an announcement about the bot
when they enter the room, this announcement is not seen by everyone.

Usage: /melbot greets on and /melbot greets off

Aliases: greetings

view - Use the view command is used to view users who are members of a level. Each level has it's own list of
users. A user may only be a member of one level at a time.

Useage: /melbot view lover and /melbot view husbands ... etc

Aliases: show, list

useradd - You may add users to level with the useradd command. When using this command the bot will
check to make sure the users isn't already in that level, and that a valid level has been given. If the user is already
in another level they will be removed from that level and added to the new level.

Usage: /melbot useradd family someuser that command will add the user "someuser" to the Family level. Another
example would be /melbot add husbands sexyman which would add the user "sexyman" to the Husbands level.

Timeout option: /melbot useradd timeout someuser that command will add the user "someuser" to the timeout box. You may also provide the number of minutes you want the user to be in timeout after their name. /melbot useradd timeout someuser 5 would put "someuser" in timeout for 5 minutes. If you give a number of minutes the user will be released after that number of minutes has expired. If you don't give a number of minutes the user can only be released by manually removing them using userdel (see below). You may user userdel to release a user was given a timed timeout as well.

Aliases: adduser, add

userdel - There may be a time when you need to delete a user from a level. The userdel command does just that
and function similar to the adduser command (only in reverse).

Usage: /melbot userdel family someuser would remove the user "someuser" from the Family level.

Aliases: deluser, remove, delete

check - The check command lets you see what level a user is in.

Usage: /melbot check username would show the level for the user "username".

Aliases: (none)

status - To see the number of users in each level and which options are on/off use the status command.

Usage: /melbot status

Aliases: (none)

Change Log

12/17/2015 - Birthday edition
12/11/2015 - Added spammer list and username pattern filtering to auto-mute spam bots using similar name structure.
11/12/2015 - Added tipmenu and raffle ticket menus
7/27/2015 - Disabled the private and public notice commands (melnote, notice, modnote) at Mellbell's request.
7/27/2015 - No major changes to bot since 11/14/14, just minor tweaks.
11/14/2014 - Family members can now change color and use basic bot commands.
11/14/2014 - Added new feature announcement for mods
11/14/2014 - Mods can now paint users with colors
11/14/2014 - Added private responses to users if they try to use a command they are not allowed to use.
11/7/2014 - Broadcaster and Mods can now change their text and background colors. Use /melbot text [color] and /melbot bg [color]. You can use HTML color names or #rgbcodes.
11/6/2014 - Tippers log. Bot tracks all tips now (since the time bot starts). can view tippers using /melbot tips (to show all) or /melbot tips # (to show the top # of tippers). This is shown to everyone. Will add private viewing commands later.
11/4/2014 - Changed the way blocked messages are handled. Should be better now.
10/22/14 - Timeout Flood protector stops users in timeout from flooding the room with timeout notices (thanks to runlikeachicken for inspiring this feature)
10/22/14 - Fixed bug that required "no grey emotes" to be on before other blockers worked.
10/22/14 - Added new shortcuts for removing users from groups and timeout
10/22/14 - Added auto timeout for bad grey users that demand and ask to view cam or pm, etc.
10/20/14 - Added bot command shortcuts for putting people in timeout faster and other stuff
10/20/14 - Added listener for web site ads in chat, automatically puts that user in timeout and blocks ad. Currently limited to a few ads for testing. Will ad more later and expand on this listener to block other unwanted things in chat.
10/15/14 - Added note commands to send public room notices, private notes to mel, and private notes to mods.
10/06/14 - Added new emote blocker to block grey users from using emotes unless they are a friend or family.
8/21/14 - Added the ability to put a user in timeout for X minutes, then they are released automatically
8/21/14 - Added Queen crown icon for Mel
8/21/14 - Added King crown icon for Split
8/21/14 - Added user timeout/jail for bad users
5/24/14 - Added gender emotes

5/21/14 - Added noticed displayed to other models and their viewers if they try to run the bot in their room.

5/21/14 - Added built-in notifications. Can now create upto 2 notifications that will automatically display at variables delays. Simply enter a message and select the delay. Leave message fields empty if you don't want to use notifications.

5/17/14 - Added custom user entrances for specific users