diff options
Diffstat (limited to 'data/botserv.example.conf')
| -rw-r--r-- | data/botserv.example.conf | 227 |
1 files changed, 227 insertions, 0 deletions
diff --git a/data/botserv.example.conf b/data/botserv.example.conf new file mode 100644 index 000000000..81b08d66d --- /dev/null +++ b/data/botserv.example.conf @@ -0,0 +1,227 @@ +/* + * Example configuration file for BotServ. + */ + +/* + * First, create the service. + */ +service +{ + /* + * The name of the BotServ client + */ + nick = "BotServ" + + /* + * The username of the BotServ client. + */ + user = "services" + + /* + * The hostname of the BotServ client. + */ + host = "localhost.net" + + /* + * The realname of the BotServ client. + */ + gecos = "Bot Service" +} + +/* + * Core BotServ module. + * + * Provides essential functionality for BotServ. + */ +module { name = "bs_main" } + +/* + * Configuration for BotServ provided by bs_main. + */ +botserv +{ + /* + * The name of the client that should be BotServ. + */ + name = "BotServ" + + /* + * The default bot options for newly registered channels. Note that changing these options + * will have no effect on channels which are already registered. The list must be separated + * by spaces. + * + * The options are: + * - dontkickops: Channel operators will be protected against BotServ kicks + * - dontkickvoices: Voiced users will be protected against BotServ kicks + * - greet: The channel's BotServ bot will greet incoming users that have set a greet + * in their NickServ settings + * - fantasy: Enables the use of BotServ fantasy commands in the channel + * + * This directive is optional, if left blank, there will be no defaults. + */ + defaults="greet fantasy" + + /* + * The minimum number of users there must be in a channel before the bot joins it. The best + * value for this setting is 1 or 2. This can be 0, the service bots will not part unless + * specifically unassigned, and will keep the channel open. + */ + minusers = 1 + + /* + * The maximum number of entries a single bad words list can have. Setting it too high can + * reduce performance slightly. + */ + badwordsmax = 32 + + /* + * The amount of time that data for a user is valid in BotServ. If the data exceeds this time, + * it is reset or deleted depending on the case. Do not set it too high, otherwise your + * resources will be slightly affected. + */ + keepdata = 10m + + /* + * The bots are currently not affected by any modes or bans when they try to join a channel. + * But some people may want to make it act like a real bot, that is, for example, remove all + * the bans affecting the bot before joining the channel, remove a ban that affects the bot + * set by a user when it is in the channel, and so on. Since it consumes a bit more CPU + * time, you should not enable this on larger networks. + * + * This directive is optional. + */ + #smartjoin = yes + + /* + * If set, the bots will use a kick reason that does not state the word when it is kicking. + * This is especially useful if you have young people on your network. + * + * This directive is optional. + */ + gentlebadwordreason = yes + + /* + * If set, BotServ will use case sensitive checking for badwords. + * + * This directive is optional. + */ + #casesensitive = yes + + /* + * Defines the prefix for fantasy commands in channels. This character will have to be prepended + * to all fantasy commands. If you choose "!", for example, fantasy commands will be "!kick", + * "!op", etc. This directive is optional, if left out, the default fantasy character is "!". + */ + #fantasycharacter = "!" +} + +/* + * Core BotServ commands. + * + * In Anope modules can provide (multiple) commands, each of which has a unique command name. Once these modules + * are loaded you can then configure the commands to be added to any client you like with any name you like. + * + * Additionally, you may provide a permission name that must be in the opertype of users executing the command. + * + * Sane defaults are provided below that do not need to be edited unless you wish to change the default behavior. + */ + +/* Give it a help command */ +command { service = "BotServ"; name = "HELP"; command = "generic/help"; } + +/* + * bs_assign + * + * Provides the commands botserv/assign and botserv/unassign. + * + * Used for assigning and unassigning bots to channels. + */ +module { name = "bs_assign" } +command { service = "BotServ"; name = "ASSIGN"; command = "botserv/assign"; } +command { service = "BotServ"; name = "UNASSIGN"; command = "botserv/unassign"; } + +/* + * bs_autoassign + * + * Allows service bots to be automatically assigned to channels upon registration. + */ +#module { name = "bs_autoassign" } +bs_autoassign +{ + /* + * Automatically assign ChanServ to channels upon registration. + */ + bot = "ChanServ" +} + +/* + * bs_badwords + * + * Provides the command botserv/badwords. + * + * Used for controlling the channel badword list. + */ +module { name = "bs_badwords" } +command { service = "BotServ"; name = "BADWORDS"; command = "botserv/badwords"; } + +/* + * bs_bot + * + * Provides the command botserv/bot. + * + * Used for administrating BotServ bots. + */ +module { name = "bs_bot" } +command { service = "BotServ"; name = "BOT"; command = "botserv/bot"; } + +/* + * bs_botlist + * + * Provides the command botserv/botlist. + * + * Used for listing all available bots. + */ +module { name = "bs_botlist" } +command { service = "BotServ"; name = "BOTLIST"; command = "botserv/botlist"; } + +/* + * bs_control + * + * Provides the commands botserv/act and botserv/say. + * + * Used for making the bot message a channel. + */ +module { name = "bs_control" } +command { service = "BotServ"; name = "ACT"; command = "botserv/act"; } +command { service = "BotServ"; name = "SAY"; command = "botserv/say"; } + +/* + * bs_info + * + * Provides the command botserv/info. + * + * Used for getting information on bots or channels. + */ +module { name = "bs_info" } +command { service = "BotServ"; name = "INFO"; command = "botserv/info"; } + +/* + * bs_kick + * + * Provides the command botserv/kick. + * + * Used for configuring what bots should kick for. + */ +module { name = "bs_kick" } +command { service = "BotServ"; name = "KICK"; command = "botserv/kick"; } + +/* + * bs_set + * + * Provides the command botserv/set. + * + * Used for setting options such as kickers and fantasy replies. + */ +module { name = "bs_set" } +command { service = "BotServ"; name = "SET"; command = "botserv/set"; } + |