BotServ

From freenode wiki
Jump to: navigation, search

ACT

Syntax:

ACT channel text

Makes the bot do the equivalent of a "/me" command on the specified channel using the specified text.


ASSIGN

Syntax:

ASSIGN channel nick

Assigns the specified bot to a channel. You can then configure the bot for the channel so it fits your needs.


BADWORDS

Syntax:

BADWORDS #channel ADD word [SINGLE | START | END]
BADWORDS #channel DEL {word | entry-num | list}
BADWORDS #channel LIST [mask | list]
BADWORDS #channel CLEAR

Maintains the bad words list for a channel. The bad words list determines which words are to be kicked when the bad words kicker is enabled. For more information, type /msg BotServ HELP KICK BADWORDS.

The ADD command adds the given word to the bad words list. If SINGLE is specified, a kick will be done only if a user says the entire word. If START is specified, a kick will be done if a user says a word that starts with word. If END is specified, a kick will be done if a user says a word that ends with word. If you don't specify anything, a kick will be issued every time word is said by a user.

The DEL command removes the given word from the bad words list. If a list of entry numbers is given, those entries are deleted. (See the example for LIST below.)

The LIST command displays the bad words list. If a wildcard mask is given, only those entries matching the mask are displayed. If a list of entry numbers is given, only those entries are shown; for example:

#channel LIST 2-5,7-9

Lists bad words entries numbered 2 through 5 and 7 through 9.

The CLEAR command clears all entries from the bad words list.


BOTLIST

Syntax:

BOTLIST

Lists all available bots on this network. Bots prefixed by a * are reserved for IRC Operators.


INFO

Syntax:

INFO {#channel | nickname}

Allows you to see BotServ information about a channel or a bot. If the parameter is a channel, then you'll get information such as enabled kickers. If the parameter is a nick, you'll get information about a bot, such as creation time or number of channels it is on.


KICK

Syntax:

KICK option #channel {ON|OFF} [settings]

Configures bot kickers. option can be one of:

   KICK AMSG      Configures AMSG kicker
   KICK BADWORDS  Configures badwords kicker
   KICK BOLDS     Configures bolds kicker
   KICK CAPS      Configures caps kicker
   KICK COLORS    Configures color kicker
   KICK FLOOD     Configures flood kicker
   KICK ITALICS   Configures italics kicker
   KICK REPEAT    Configures repeat kicker
   KICK REVERSES  Configures reverses kicker
   KICK UNDERLINES Configures underlines kicker

Type /msg BotServ HELP KICK option for more information on a specific option.

Note: Access to this command is controlled by the level SET.


KICK AMSG

Syntax:

KICK AMSG #channel {ON|OFF} [ttb]

Sets the AMSG kicker on or off. When enabled, the bot will kick users who send the same message to multiple channels where BotServ bots are.

ttb is the number of times a user can be kicked before they get banned. Don't give ttb to disable the ban system once activated.


KICK BADWORDS

Syntax:

KICK BADWORDS #channel {ON|OFF} [ttb]

Sets the bad words kicker on or off. When enabled, this option tells the bot to kick users who say certain words on the channels. You can define bad words for your channel using the BADWORDS command. Type /msg BotServ HELP BADWORDS for more information.

ttb is the number of times a user can be kicked before it gets banned. Don't give ttb to disable the ban system once activated.


KICK BOLDS

Syntax:

KICK BOLDS #channel {ON|OFF} [ttb]

Sets the bolds kicker on or off. When enabled, this option tells the bot to kick users who use bolds.

ttb is the number of times a user can be kicked before it gets banned. Don't give ttb to disable the ban system once activated.


KICK CAPS

Syntax:

KICK CAPS #channel {ON|OFF} [ttb][min] [percent]

Sets the caps kicker on or off. When enabled, this option tells the bot to kick users who are talking in CAPS. The bot kicks only if there are at least min caps and they constitute at least percent% of the total text line (if not given, it defaults to 10 characters and 25%).

ttb is the number of times a user can be kicked before it gets banned. Don't give ttb to disable the ban system once activated.


KICK COLORS

Syntax:

KICK COLORS #channel {ON|OFF} [ttb]

Sets the colors kicker on or off. When enabled, this option tells the bot to kick users who use colors.

ttb is the number of times a user can be kicked before it gets banned. Don't give ttb to disable the ban system once activated.


KICK FLOOD

Syntax:

KICK FLOOD #channel {ON|OFF} [ttb] [ln] [secs]

Sets the flood kicker on or off. When enabled, this option tells the bot to kick users who are flooding the channel using at least ln lines in secs seconds (if not given, it defaults to 6 lines in 10 seconds).

ttb is the number of times a user can be kicked before it gets banned. Don't give ttb to disable the ban system once activated.


KICK ITALICS

Syntax:

KICK ITALICS #channel {ON|OFF} [ttb]

Sets the italics kicker on or off. When enabled, this option tells the bot to kick users who use italics.

ttb is the number of times a user can be kicked before it gets banned. Don't give ttb to disable the ban system once activated.


KICK REPEAT

Syntax:

KICK REPEAT #channel {ON|OFF} [ttb] [num]

Sets the repeat kicker on or off. When enabled, this option tells the bot to kick users who are repeating themselves num times (if num is not given, it defaults to 3).

ttb is the number of times a user can be kicked before it gets banned. Don't give ttb to disable the ban system once activated.


KICK REVERSES

Syntax:

KICK REVERSES #channel {ON|OFF} [ttb]

Sets the reverses kicker on or off. When enabled, this option tells the bot to kick users who use reverses.

ttb is the number of times a user can be kicked before it gets banned. Don't give ttb to disable the ban system once activated.


KICK UNDERLINES

Syntax:

KICK UNDERLINES #channel {ON|OFF} [ttb]

Sets the underlines kicker on or off. When enabled, this option tells the bot to kick users who use underlines.

ttb is the number of times a user can be kicked before it gets banned. Don't give ttb to disable the ban system once activated.


SAY

Syntax:

SAY #channel text

Makes the bot say the specified text on the specified channel.


SET

Syntax:

SET option (#channel | bot) settings

Configures bot options.

Available options:

   SET BANEXPIRE  Configures the time bot bans expire in
   SET DONTKICKOPS To protect ops against bot kicks
   SET DONTKICKVOICES To protect voices against bot kicks
   SET FANTASY    Enable fantaisist commands
   SET GREET      Enable greet messages
   SET NOBOT      Prevent a bot from being assigned to a channel
   SET PRIVATE    Prevent a bot from being assigned by non IRC operators

Type /msg BotServ HELP SET option for more information on a particular option.


SET BANEXPIRE

Syntax:

SET BANEXPIRE #channel time

Sets the time bot bans expire in. If enabled, any bans placed by bots, such as flood kicker, badwords kicker, etc. will automatically be removed after the given time. Set to 0 to disable bans from automatically expiring.


SET DONTKICKOPS

Syntax:

SET DONTKICKOPS #channel {ON | OFF}

Enables or disables ops protection mode on a channel. When it is enabled, ops won't be kicked by the bot even if they don't match the NOKICK level.


SET DONTKICKVOICES

Syntax:

SET DONTKICKVOICES #channel {ON | OFF}

Enables or disables voices protection mode on a channel. When it is enabled, voices won't be kicked by the bot even if they don't match the NOKICK level.


SET FANTASY

Syntax:

SET FANTASY #channel {ON|OFF}

Enables or disables fantasy mode on a channel. When it is enabled, users will be able to use fantasy commands on a channel when prefixed with one of the following fantasy characters: .

Note: that users wanting to use fantasy commands MUST have enough access for both the FANTASIA and the command they are executing.


SET GREET

Syntax:

SET GREET #channel {ON|OFF}

Enables or disables greet mode on a channel. When it is enabled, the bot will display greet messages of users joining the channel, provided they have enough access to the channel.


SET NOBOT

Syntax:

SET NOBOT channel {ON|OFF}

This option makes a channel unassignable. If a bot is already assigned to the channel, it is unassigned automatically when you enable it.

Access to this command requires the permission botserv/set/nobot to be present in your opertype.


SET PRIVATE

Syntax:

SET PRIVATE botname {ON|OFF}

This option prevents a bot from being assigned to a channel by users that aren't IRC Operators.

Access to this command requires the permission botserv/set/private to be present in your opertype.


UNASSIGN

Syntax:

UNASSIGN #channel

Unassign's a bot from a channel. When you use this command, the bot won't join the channel anymore. However, bot configuration for the channel is kept, so you will always be able to reassign a bot later without having to reconfigure it entirely.