Fam bot PatjePimp1 version 0.1

Short Description:

Creat by and for PatjePimp1

Full Description

This bot is for use by PatjePimp 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 Patje deems worthy.

The levels are as follows:
Tip 500 to become a member of the Loyal Family.
Tip 1000 to become Patje's Lover.
Tip 1500 to become Patje's Fiance.
Tip 2000 to become Patje'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 Patje and her mods (when mod commands are enabled) may use.
You send a command to the bot by first using the trigger /patbot.
For example, if you wanted to see information on using the bot you would type: /patbot 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: /patbot mods on and /patbot 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: /patbot greets on and /patbot 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: /patbot view lover and /patbot 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: /patbot useradd family someuser that command will add the user "someuser" to the Family level. Another
example would be /patbot add husbands sexyman which would add the user "sexyman" to the Husbands level.
Timeout option: /patbot 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. /patbot 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: /patbot 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: /patbot 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: /patbot status
Aliases: (none)
Change Log