Welcome

From Botdom Documentation

This documentation is for the 0.9 version of the welcome module not Dante 0.8's version

The welcome module for Dante is one of the more complex ones. It's commands can be confusing at first. But compared to the welcome command of Noodlebot it's far more flexable. The welcome module of Dante can handle multipule rooms and even allow multipule welcomes for the same user.

1 Basics
- 1.1 wt
2 Admin Commands
- 2.1 wtroom
- 2.2 wtglobal

Basics

The advanced commands are wtroom and wtglobal. They allow for all options with welcomes to be set but they are not easy to use. I recommend that most users use the wt command.

wt

Easy command for managing the welcome list. This command affects welcomes for only the current room. Unlike noodlebot, Dante has a seperate list for each room.

wt all [message] - sets the welcome message for the entire room.
wt priv [privclass name] [message] - sets the welcome message for a priv class.
wt indv - Let each user make their own welcome.
wt status - Get the current setup for the room
wt [on/off] - Turn welcomes on and off.

Example Usage: !wt priv Guests Hi, you may want to read the rules. [link]

Admin Commands

These commands below are not the easiest way to do things but they do work. Most of it you will need to figure out through trial and error. To use these you need to know several things. First, each room has it's own list of welcomes. (As you have seen above.) But Dante does have a master list just like Noodlebot had. That's called the "global" or "all rooms" list. You can choose which list is processed first. (The combine option) There is more. The !wt command automates everything. When you use !wt all Welcome to my room it calls the equivlents of the following commands

!wtroom on - Turns on welcomes for the room
!wtroom order 0,0,1 - Disables all welcomes except the all user welcome
!wtroom combine off - Disables multipule welcomes
!wtroom order rooms - The rooms list is processed before the welcomes list.
!wtroom all Welcome to my room - Sets the welcome message

With the wtroom and wtglobal commands you need to manually setup all the options. (They are usually set to their defaults.) You can use the status option to get the current setting for your bot.

Okay, now for the options. The most difficult one is probably order. Order is the order in which welcome messages are parsed. It's pretty straight forward. Order excepts a comma seperated list of 3 numbers. Like this !wtroom order 1,2,0 The numbers can between 0 and 3, including both 0 and 3. The numbers give the different types of welcome their priority. Welcome types are mentioned above just before the wt command. The first number is for Individual welcomes, second is Per Privclass and the third is for All User welcomes. You can set any of these to 0 to disable them. The 1 is highest priority, which means it will be processed first, and 3 has the lowest so it will be processed last. If you set any of three types to the same number (except 0) the bot will act unpredicately when a person joins. It is recommended that you don't do that.

Examples:

Disable All User welcomes but have Per Priv then Indiviual welcomes.

!wtroom order 2,1,0

Individual welcomes, then, Per Priv, then All User

!wtroom order 1,2,3

Next up is the combine option. This is an option to show all welcomes that are set for a user to recieve. (There are 3 types of welcomes and 2 lists for 6 possible welcomes.) You can either have the bot show all welcomes that apply to the user that joins or just the first one.

The first option tells the bot which list to look at first when doing welcomes. You can have the bot look at the room for the current room first (the "room" setting) or have it look at the global list first. (The global option) That's all for indepth explaining, the others should explain themselves

wtroom

Manage the welcomes for the current room.

wtroom (#room) order [0/1/2/3],[0/1/2/3],[0/1/2/3] -
wtroom (#room) combine [yes/no] - Do you want to combine room welcomes?
wtroom (#room) first [rooms/global] - Room messages first or Global message first.
wtroom (#room) all ([message]/clear) - Set the message for all users
- use !wtroom all clear to erase the message.
- use !wtroom all to view the current message
wtroom (#room) priv [privclass] [message] - Set the message for [privclass]
- syntax is the same as the all option with the addition of [privclass]
wtroom (#room) status - Display the setup of the room

Example Usage: !