BOT

Usage: BOT <botname> <command>

Bots are simulated clients that act as your agent in a room. Bots have three functions. The first is to keep a room open so that it will show in the list. The second use for the server bot is to send a welcome message to users who enter the room. The third is to invite people into the room or op them if they are trusted with a password. 

Used by itself, the command will return all the bots configured to run on the server.

ADD - Add a server bot

CHANLIST - List the rooms/channels a server bot is controlling.

COMMANDS - What people can send to a bot: IDENTIFY, INVITE, OP and QUEUE.

DEL - Delete a server bot

LIST - List the settings for a bot

SET - Set additional configurations for your server bot

Examples:

/as help bot <command>

Bots are useful for important rooms. They keep them open and they protect them. Since bots cannot be kicked from a room, they are always there to let you back in regardless of what is done to the room. If you have services, you do not need a bot, but you may want one anyway. 
In order to create a useful bot you will need to add it and then use the chan commands to have the bot start watching rooms. If you do not enter a password for the bot or the rooms, then the bot can only be accessed by people with configuration access or the ability set bot passwords. You need a bot in a room in order to log the room.

Usage: BOT <botname> ADD

This adds a profile for a bot. You will then need to set which room(s) the bot watches. See BOT SET and CHAN BOT for more information.

Example:

/as bot SupportBot add

This creates a profile for a bot of whatever name you selected. You won't see the bot until you set it up to join a room.

Usage: BOT <botname> CHANLIST

This command will list which rooms the specified bot is controlling.

Example:

/as bot SupportBot chanlist

This command is designed to help you keep track of what each bot is doing.

Usage: MSG <botname> <command> <value>

These are the commands a server bot understands. People send them to the bot in a private message. The bot can invite you into a room it looks after and give you operator status there. You must first identify to the bot with a password. There are two ways: identify to the bot itself, which gives you every room the bot looks after, or identify for one room, which only gives you that room.

IDENTIFY - Identify to a server bot so it recognizes you.

INVITE - Have the server bot invite you into a room it is in.

OP - Have the server bot give you operator status in a room it is in.

QUEUE - Message queues for moderated events: questions wait in a queue until a moderator approves them.

Examples:

/as help bot commands <command>

If you identify to the bot you do not need the password in later invite or op commands. If you do not identify, put the password at the end of those commands. If you identified for one room but want to be opped or invited into another room, give the password or identify for that room too.

Usage: MSG <botname> IDENTIFY [#<room>] <password>

You can identify to a bot to get everything that bot looks after, or for a single room it controls.

Examples:

/msg SupportBot identify mypa55

/msg SupportBot identify #lobby roompa55

With two kinds of password a bot can look after many rooms and each person gets only the password for the rooms they may enter. Give the bot password only to people you trust completely. Set them with BOT SET PASSWORD and CHAN SET PASSWORD.

Usage: MSG <botname> INVITE #<room> [<password>]

This asks the bot to invite you into the room. Identify first (see BOT COMMANDS IDENTIFY) or put the password at the end.

Example:

/msg SupportBot invite #lobby

Invite is useful when the room is invite only and you are outside it. ChanServ has an INVITE command too, for rooms registered with it.

Usage: MSG <botname> OP #<room> [<password>]

This asks the bot to give you operator status in the room. You must be in the room. The password is only needed if you have not identified to the bot.

Example:

/msg SupportBot op #lobby

This lets trusted people take operator status in a room even when nobody else is there to give it to them.

Usage: MSG <botname> QUEUE [<name> <command> ...]

Queues run moderated events. Questions wait in a queue, a moderator reads them, fixes them, and approves the good ones, which the bot then says in the event room. Queues belong to a bot. Sent alone, QUEUE lists the bot's queues (you must be identified to the bot).

ADD - Create a queue.

APPROVE - Send selected messages to the queue's destination.

DEL - Delete a queue.

EDIT - Change the text of a message.

IDENTIFY - Get access to one queue.

LIST - Show the messages in a queue.

REMOVE - Delete selected messages.

SET - Set the password, destination or source of a queue.

SHOW - Show selected messages.

SUBMIT - Add a message to a queue (anyone can do this).

Examples:

/as help bot commands queue <command>

A selector picks one or more messages. It can be 1, or 1,2,3, or 1-3,5. Typical setup: give the bot a password (BOT SET PASSWORD), put it in the event room (CHAN BOT ADD), then identify to it and create the queue:

/msg SupportBot identify mypa55

/msg SupportBot queue Questions add

/msg SupportBot queue Questions set destination #event

/msg SupportBot queue Questions set source #ask

From then on whatever people who are not operators say in #ask is added to Questions, and approved ones are said in #event by the bot.

Usage: MSG <botname> QUEUE <name> ADD

Creates a queue. You must be identified to the bot. A bot can have up to 20 queues, each holding up to 500 messages.

Example:

/msg SupportBot queue Questions add

Usage: MSG <botname> QUEUE <name> APPROVE <selector>

Sends the selected messages to the queue's destination and takes them out of this queue. The destination is a room the bot is in, or another queue of the same bot (for several levels of moderation). Set it with QUEUE <name> SET DESTINATION.

Example:

/msg SupportBot queue Questions approve 3

A selector can be 1, 1,2,3 or 1-3,5.

Usage: MSG <botname> QUEUE <name> DEL

Deletes the whole queue with every message in it. To remove single messages use QUEUE REMOVE. Only someone identified to the bot can delete a queue.

Example:

/msg SupportBot queue Questions del

Usage: MSG <botname> QUEUE <name> EDIT <number> <new text>

Replaces the text of one message. During an event people misspell words and mangle punctuation, so a moderator can tidy a question before approving it.

Example:

/msg SupportBot queue Questions edit 3 What kind of guitar do you play?

Usage: MSG <botname> QUEUE <name> IDENTIFY <password>

Gets you access to one queue, with the password set by QUEUE SET PASSWORD. Someone identified to the whole bot does not need this.

Example:

/msg SupportBot queue Questions identify mypass

Usage: MSG <botname> QUEUE <name> LIST

Shows the messages in a queue with their numbers and who sent them (the first 100 for a long queue).

Example:

/msg SupportBot queue Questions list

Usage: MSG <botname> QUEUE <name> REMOVE <selector>

Deletes the selected messages. A selector can be 1, 1,2,3 or 1-3,5.

Example:

/msg SupportBot queue Questions remove 3

Usage: MSG <botname> QUEUE <name> SET PASSWORD <password|NONE>
       MSG <botname> QUEUE <name> SET DESTINATION <#room|queue>
       MSG <botname> QUEUE <name> SET SOURCE <#room|NONE>

PASSWORD lets people identify to this one queue. DESTINATION is where approved messages go: a room the bot is in, or another queue of the bot. SOURCE is a room whose chat is collected into the queue: what people who are not operators say there is added.

Examples:

/msg SupportBot queue Questions set password foo

/msg SupportBot queue Questions set destination #event

/msg SupportBot queue Questions set source #ask

Usage: MSG <botname> QUEUE <name> SHOW <selector>

Shows only the selected messages. A selector can be 1, 1,2,3 or 1-3,5.

Example:

/msg SupportBot queue Questions show 3

Usage: MSG <botname> QUEUE <name> SUBMIT <message>

Adds a message to the queue. Anyone can do this, no password needed, so it also works for people who are not in the source room.

Example:

/msg SupportBot queue Questions submit What are your plans for next year?

Usage: BOT <botname> DEL

This deletes the bot and its profile.

Example:

/as bot SupportBot del

If your bot is no longer managing any rooms then there is no reason to keep it and it should be deleted.

Usage: BOT <botname> LIST

This command shows the settings for a bot. It will display the bot's profile.

Example:

/as bot SupportBot list

This is another useful command for checking how things are set up.

Usage: BOT <botname> SET <command> <value>

The set command for bot allows you to configure additional settings for your bot such as the userid, the hostname, the realname, and the password. This information, except for the password, will appear in the /whois botname. Note: the password you set for a bot allows you to identify to this bot and thus gain access to any rooms the bot manages.

ADMINPASS - Sets a Zone Password.

FIELD - Set an optional field for a bot.

HOST - Set the hostname for the bot.

PASSWORD - Set the password for the bot.

REALNAME - Set the real name displayed for the bot.

USER - Set the userid for the bot.

Example:

/as help bot set <command>

Except for the password, these settings are aesthetic. They do not change the way the bot behaves, but they change what the user sees when the bot is whois'd.

Usage: BOT <botname> SET ADMINPASS <password>

If the bot is managing one or more zones then the adminpassword will give you access to all the zones that the bot is managing. If the bot is not managing any zones the adminpassword will give you access to the same functions that the password will.

Examples:
 
/as bot SupportBot set adminpass MyPassword

For more information about zones please see the following file: Zones and Virtual Hosting

Usage: BOT <botname> SET FIELD <FieldName> <Value>

This will let you set a field on a bot such as the avatar field for extra information in a whois, or for display in an avatar.

Example:

/as bot SupportBot set field avatar alien

This is another aesthetic detail you can set to make your bot appear as you wish it to appear. Other commands that customize the bot's /whois are BOT SET HOST and BOT SET REALNAME.

Usage: BOT <botname> SET HOST <hostname>

This command sets the hostname for your bot. The hostname will appear whenever someone does a /whois on the bot.

Example:

/as bot SupportBot set host conferencerooms.org

This command is an aesthetic feature so that your bot can have an appearance appropriate to its use and your network. Other commands that customize the bot's /whois are BOT SET REALNAME and BOT SET USER Other commands that customize the bot's /whois are BOT SET USER and BOT SET USER.

Usage: BOT <botname> SET PASSWORD <password>

This command sets the password for the bot. The password is used when identifying to the bot. See BOT COMMANDS IDENTIFY. To set the password for a specific room see CHAN SET PASSWORD.

Example:

/as bot SupportBot set password support

As with all passwords, it is case sensitive. Try to pick something secure yet memorable.

Usage: BOT <botname> SET REALNAME <name>

This command sets what will appear in the "real name" field of the bot's whois information.

Example:

/as bot SupportBot set realname Mr. Bot

This is another aesthetic detail you can set. The real name field can contain useful information or just something that looks nice. Other commands that customize the bot's /whois are BOT SET HOST and BOT SET USER.

Usage: BOT <botname> SET USER <ident>

This sets the userid or the ident of the bot. This information will show up in a /whois.

Example:

/as bot SupportBot set user Bot

This is another aesthetic detail you can set to make your bot appear as you wish it to appear. Other commands that customize the bot's /whois are BOT SET HOST and BOT SET REALNAME.