Listed reply.* configuration items.
[supybook.git] / index.txt
blob8fc1996232858e5e6d9ead9394424be25e20cd6e
1 Supybook
2 ========
3 Heikki Hokkanen <hoxu@users.sf.net>
4 {date}
5 {revision}
7 == Preface ==
9 NOTE: At the time of this writing, Supybot version is 0.83.3. If you are using a newer (or even older) version, keep that in mind.
11 NOTE: This document is very much a work in process. It covers nowhere near everything there is to Supybot. However, it hopefully allows a good start into learning Supybot.
13 === What is this document? ===
15 This document is a handbook for http://supybot.com/[Supybot], the IRC (http://en.wikipedia.org/wiki/Internet_Relay_Chat[Internet Relay Chat]) bot written in Python.
17 === Motivation behind this document ===
19 Some time ago I started needing a bot for various purposes. The bot would have to be able to take care of auto-opping and similar "traditional" channel duties. This made me think of http://oer.equnet.org/[Oer], an old but very nice bot. However, I also wanted to have factoid functionality similar to blootbot/infobot, without having to run multiple bots. That was when I arrived at Supybot once again. This time I decided to give it a closer look.
21 My experience of the documentation was lacking though. I longed for something similar to http://oer.equnet.org/um.php[Oer's User Manual] that provides a quick references for basic administrator tasks and so forth. Alas, I could not find such document.
23 I figured I could as well wrap up such a handbook while learning to use the bot myself. Hopefully someone finds reading this document as useful as writing it was.
25 === Conventions used in this document ===
27 `command <name> [value]`::
28         A command that takes `name` as a required parameter and `value` as an optional parameter.
30 `command <nick...>`::
31         A command that takes one or more parameters.
33 [green]#Plugin#::
34         A plugin name
36 === This document is Free ===
38 This document is Free (TM) as defined by the http://www.fsf.org/[Free Software Foundation], more specifically, this document is available under the terms of http://www.gnu.org/licenses/gpl-3.0.txt[GNU General Public License version 3 (GPLv3)].
40 === How to give feedback ===
42 If you spot an error, have suggestions or just want to tell me how much you love/hate the document, send e-mail to mailto:hoxu@users.sf.net[]. Prefix the Subject with `[supybook]`.
44 == Getting started ==
46 === Initial configuration ===
48 Create a new directory (eg. `mkdir ~/supybot`) and run `supybot-wizard` in it. Follow the directions to get the bot initially configured and connected to a network.
50 === Identifying to the bot ===
52 After running supybot-wizard and starting the bot, connect to the same IRC network it is on, and /query it. You can identify with the `identify <name> <password>` command. You can check the bot's idea of who you are with the `whoami` command.
54 === Accessing the online help ===
56 Most commands on the bot have a short online help available. You can use `list` to list loaded plugins, and `list <plugin>` to list commands in those plugins. `help [plugin] <command>` can be used to access the command help. Use `more` to read long messages from the bot.
58 Help for configuration items can be accessed with the `config help <key>` command.
60 == Understanding supybot's peculiarities ==
62 Supybot has a couple of features that sets it apart from more traditional bots. More specifically, nested commands, plugin framework (even the basic functionality is implemented using plugins), and capabilities. This section covers some basic information about Supybot. Feel free to skip it, but come back later if you run into something you don't understand.
64 === Nested commands ===
66 Supybot allows nested commands, in other words, you can pass the result of a command to another command as a parameter. What does this allow then, though, apart from the obvious bragging rights? For example, if you want to restore a configuration entry to the default value, you can type:
68 `config reply.withNickPrefix [config default reply.withNickPrefix]`
70 Obviously, that wasn't very neat. They could've included a `config reset <key>` command instead, for example. But I'm sure you can figure out *something* useful to do with this.
72 === Plugins ===
74 Pretty much everything in Supybot is a plugin. Most commands you use belong to a plugin. If two plugins provide the same command, then you need to prefix the command with the plugin name. For example, the `ignore list` command yields the following output:
76 .output
77 ----
78 Error: The command "ignore list" is available in the Admin and Channel plugins.
79 Please specify the plugin whose command you wish to call by using its name as a command before "ignore list".
80 ----
82 Thus, you need to either use `admin ignore list` or `channel ignore list` command. That is, unless you define which plugin is the default one using the `defaultplugin [\--remove] <command> [plugin]` command provided in the [green]#Owner# plugin.
84 The `list` command ([green]#Plugin#) can be used to list loaded plugins. You can prevent some plugins from showing in the list with the command:
86 `config plugins.<plugin>.public False`
88 `list`::
89         List currently loaded plugins, excluding the ones set non-public.
91 `list \--private`::
92         List loaded plugins that are set to non-public.
94 `list <plugin>`::
95         List commands provided by the given plugin.
97 `load [\--deprecated] <plugin>`::
98         Load a plugin. Supybot looks for plugins in directories listed in `config conf.supybot.directories.plugins`.
100 `unload <plugin>`::
101         Unloads a plugin. The [green]#Owner# plugin cannot be unloaded.
103 === Configuration ===
105 Most of Supybot configuration is done online using the [green]#Config# plugin. This excludes things such as granting the owner capability (must be done by modifying the files).
107 There are two types of configuration items: global and channel-specific. The latter are actually no different from the global ones, except that they can be set for channels as well. This means you can have a global default which is overridden for specific channels.
109 Configuration items are hierarchical. The "root" item is `supybot`, which can be omitted. Configs for plugins live under their own key, `supybot.plugins`, or shortly, `plugins`.
111 `config <name> [value]`::
112         Get the current value of `name`, or set it to `value` if provided.
114 `config channel [channel] <name> [value]`::
115         Ditto, but for channel configs.
117 `config default <name>`::
118         Get the default value of `name`. This does not change the value. No, there is no command to reset an item to default value. You need to use `config <name> [config default <name>]` for that.
120 `config export <filename>`::
121         Export non-confidential parts of configuration to a file for debugging purposes.
123 `config help <name>`::
124         Show help for a configuration item.
126 `config list <group>`::
127         List configuration items in `group`. Subgroups are prefixed with '@', channel-specific items with '#'.
129 `config reload`::
130         Reloads configuration. Mostly useful if you've had to modify the files by hand.
132 `config search <word>`::
133         Show configuration items matching `word`.
135 [[capabilities]]
136 === Capabilities ===
138 Many traditional IRC bots manage permissions of users using flags. Some network services in fact, do, too. Each user can have various flags on each channel. The flags can mean auto-op, op, use of !ban command and so forth. On side of those, there are often global user flags that entitle the user to full access, global auto-op, etc. Some bots also support channel flags that determine what bot functionality is available on the channel.
140 Supybot does not have any flags. Instead, the permissions are managed using 'capabilities'. There are two kinds of capabilities: `user capabilities` and `channel capabilities`.
142 'User capabilities' are checked first when a user tries to run a command. If the user has an 'anticapability' for the command (eg. `-command`, `-Plugin.command`) or the Plugin (`-Plugin`), it won't be run.
144 Next, if the command was run on the channel, the 'channel capabilities' are checked. The logic is same as above, but the checked capabilities are prefixed with `#channel,`, for example `#channel,-Plugin.command`.
146 There are some special capabilities recognized by Supybot:
148 `owner`::
149         For bot owners: the people who have "physical" access to the bot and its files. This cannot be granted online; the 'conf/users.conf' file must be edited by hand followed by `reload`. Owners are exempt from `#channel,op` capability checks and channel anticapabilities.
151 `admin`::
152         For bot administrators. Users with this capability can manage global bot properties, make the bot join new channels and so forth. However, they can't do channel administration which is reserved for ops.
154 `#channel,op`::
155         Channel ops can execute channel-related commands.
157 `trusted`::
158         Allow user to run commands that can potentially crash the bot, or cause denial of service on the system it's running on.
160 Commands used to manipulate capabilities are covered in the <<channel-capabilities,Manipulating channel capabilities>> and <<user-capabilities,Manipulating user capabilities>> sections.
162 == Administrative tasks ==
164 === Networks ===
166 Related plugins: [green]#Network, Services#.
168 ==== Adding a network ====
170 `network connect [--ssl] <network> [<host[:port]>] [password]`::
171         Connect to `network`. `host` must be provided if the network is new or has no servers defined.
173 ==== Reconnecting ====
175 `reconnect [network] [message]`::
176         Disconnects and connects `network`, or current if not specified. `message`, if given, is shown as the quit message, otherwise `config plugins.Owner.quitMsg` is used, or your nickname.
178 ==== Disconnecting ====
180 `network disconnect [network] [message]`::
181         Disconnect `network`, or current if not specified. `message` as above.
183 ==== Listing networks ====
185 `networks`::
186         List of networks & servers currently connected to.
188 .output
189 ----
190 freenode: wolfe.freenode.net and ircnet: irc.elisa.fi
191 ----
193 `config list networks`::
194         List all networks.
196 ==== Adding more servers ====
198 Once you've added a network with the initial server, you can add more servers:
200 `config networks.<network>.servers [config networks.<network>.servers] server:6667`
202 ==== Listing network servers ====
204 `config networks.<network>.servers`
206 .output
207 ----
208 chat.freenode.net:6667
209 ----
211 ==== Services: NickServ ====
213 WARNING: My pratical experience with [green]#Services# plugin on Freenode is... not-so-good. It definitely does not work all the time as expected.
215 You can make Supybot identify itself to the network NickServ after it has connected.
217 `config plugins.Services.noJoinsUntilIdentified True`::
218         Settings this is useful on Freenode and other networks who change the user mask after identifying to NickServ. In my experience this seems to be a tad buggy, so I don't recommend enabling it unless really needed.
220 `config plugins.Services.NickServ NickServ`::
221         Tell the bot what name NickServ can be found under.
223 `services password <nick> [password]`::
224         Can be used to set or remove NickServ password.
226         NOTE: Password removal did not work for me on Supybot 0.83.3
227         
228 `services identify`::
229         Identifies the bot to NickServ with the current nick. You don't need to give this command after the bot has been set up; it will identify when connecting to the network automatically.
231 ==== Services: ChanServ ====
233 You can make Supybot request op after joining a channel on a network with ChanServ.
235 `config plugins.Services.ChanServ ChanServ`::
236         Tell the bot what name ChanServ can be found under.
238 `config plugins.Services.ChanServ.op <on|off>`::
239         Set the default for all channels. This will be used unless a channel-specific config overrides it.
241 `config channel [channel] plugins.services.ChanServ.op <on|off>`::
242         Set to request op on the given `channel`.
244 Voice and half-op (on networks supporting it) can be used similarly.
246 === Channels ===
248 Related plugins: [green]#Channel#.
250 NOTE: Commands in this section (such as adding/removing channels) work in the current network, eg. the one you are messaging the bot in. The commands also accept a `[channel]` parameter which is needed only when the command is written in private.
252 NOTE: If you want to /msg the bot in one network, while having the command apply in another network, you can use the `network command <network> <command> [params]` command. The reply comes in the other network if you are there as well.
254 ==== Adding a new channel ====
256 A new channel is added by messaging the bot in the same network with `join <channel> [key]` command.
258 ==== Listing channels ====
260 `channels`
262 NOTE: This only works in private, to prevent knowledge of top secret channels from falling to wrong hands.
264 You can list channels in another network with `config networks.<network>.channels`.
266 ==== Removing a channel ====
268 `part [channel] [reason]`
270 ==== Modifying channel config ====
272 `config channel [channel] <name> <value>`
274 ==== Setting the key ====
276 `channel key [channel] [key]` can be used to set or clear the channel key.
278 ==== Setting the limit ====
280 `channel limit [channel] [limit]` sets or clears the channel limit.
282 ==== Channel commands ====
284 Channel ops can use the following commands to control the channel via the bot, assuming it is opped.
286 `op [channel] [nick...]`::
287         Ops the given nicks (or you if none) on the channel.
289 `deop [channel] [nick...]`::
290         Ditto, but deops.
292 `voice [channel] [nick...]`::
293         Voices the given nicks (or you if none) on the channel.
295 `devoice [channel] [nick...]`::
296         Ditto, but devoices.
298 `kban [channel] [\--{exact,nick,user,host}] <nick> [seconds] [reason]`::
299         Bans and kicks the given nick from the channel. If `seconds` is specified and is not 0, the ban will expire after that time.
301 `mode [channel] <mode> [params]`::
302         Set channel mode. This can be used to change any channel modes, making the commands below redundant aliases.
304 `moderate [channel]`::
305         Set +m. This is not enforced by the bot, so any channel op can remove it.
307 `unmoderate [channel]`::
308         Set -m.
310 `topic lock [channel]`::
311         Set +t. Not enforced, so any channel op can remove it.
313 `topic unlock [channel]`::
314         Set -t.
316 `alert [channel] <text>`::
317         Sends `text` to all users on the channel with op capability.
319 `cycle [channel]`::
320         Make the bot part and join the channel. Mostly useful to test whether auto-ops from other bots/users work for the bot.
322 ==== Maintaining the ban list ====
324 `ban add [channel] <nick|hostmask> [expires]`::
325         Add ban for given nick or hostmask on the channel. If nick is given, the full hostmask is banned. `expires` when gives, expires the ban after so many seconds.
327 `ban list [channel]`::
328         List bans with their expire times.
330 `ban remove [channel] <hostmask>`::
331         Removes the ban on given `hostmask`.
333 NOTE: Users matching the ban list are not automatically kicked off the channel. See the `kban` command in the previous section to kick and ban a user.
335 ==== Maintaining the ignore list ====
337 `channel ignore add [channel] <nick|hostmask> [expires]`
339 `channel ignore list [channel]`
341 `channel ignore remove [channel] <hostmask>`
343 NOTE: There is also a global ignore list.
345 ==== Listing channel nicks ====
347 `channel nicks [channel]`
349 ==== Topic operations ====
351 Related plugins: [green]#Topic#.
353 Supybot allows elaborate manipulation of the channel topic.
355 http://supybot.com/documentation/plugins/topic
357 ==== Logging ====
359 Logging of channels is provided by the [green]#ChannelLogger# plugin. Various channel-specific configuration items are provided, see `config list plugins.ChannelLogger`.
361 By default logs will go into logs/ChannelLogger/<network>/<channel>/<channel>.log and will be rotated when the default "%d-%a-%Y" (eg. 06-Sat-2008) timestamp rotates. See http://docs.python.org/lib/module-time.html[the python documentation for strftime] for the formatting characters.
363 NOTE: The logs of [green]#ChannelLogger# cannot be searched online. However, other plugins provide some searching functionality. See <<searching-history,Searching the history>>.
365 ==== Auto-ops & voices ====
367 Auto-opping is provided by the [green]#AutoMode# plugin.
369 ==== Seen ====
371 The [green]#Seen# plugin keeps track of last channel/nick/user activity. Most typical use is asking the bot when a given user was last seen chatting on a channel.
373 `seen any [channel] [\--user <user>] [nick]`::
374         Lists any activity given `nick` or `user` was doing on the channel. If no `nick` or `user` is given, returns the last activity on the channel, regardless of who it was from.
376 `seen last [channel]`:
377         Last line said on the channel.
379 `seen [channel] <nick>`::
380         Last time a `nick` was seen on a channel and what it said.
382 `seen user [channel] <user>`:
383         Ditto, except use a user name, disregarding what nick the said user had.
385 [[channel-capabilities]]
386 ==== Manipulating channel capabilities ====
388 `capability list [channel]`::
389         List capabilities on `channel`.
391 `capability set [channel] <capability..>`::
392         Adds the given `capability` to `channel`.
394 `capability unset [channel] <capability..>`::
395         Removes the given `capability` from `channel`.
397 `capability setdefault [channel] <True|False>`::
398         Whether to allow users on `channel` by default to access non-maintenance related commands. Default is True.
399         +
400         Note that this concerns unregistered users as well. So if you want to disallow use of commands by unregistered users, set default user capabilities to allow them, and set this to False.
402 See also <<capabilities,Capabilities>>.
404 === Users ===
406 Related plugins: [green]#Users#.
408 Supybot users are global: they are visible across networks. This means the same username/password and hostmasks will work in all networks the bot is on.
410 Users are recognized either by matching hostmasks, or after manually identifying to the bot. In secure mode, the user must both match a hostmask and identify to the bot (`uset set secure [password] <True|False>`).
412 NOTE: If users knowing each others' nicks is an issue, they could come up with different aliases when registering to the bot. The bot username does not have to match the nick of the user.
414 ==== Adding a new user ====
416 `user register <name> <password>`
418 ==== Manipulating hostmasks ====
420 `user hostmask add` - add your current hostmask. Obviously this makes only sense after identify.
422 `user hostmask add [name] [hostmask] [password]` - add hostmask for another user. If not owner, password must be given.
424 `user hostmask remove <name> <hostmask> [password]`
426 NOTE: There is no way to add network-specific hostmasks.
428 ==== Listing users ====
430 `user list [glob]` - list registered users. Note that the list of users is global across networks.
432 ==== Deleting users ====
434 `user unregister <name> [password]`
436 ==== Changing password ====
438 `user set password <user> <old password> <new password>`.
440 ==== Renaming a user ====
442 `user changename <name> <new name> [password]`
444 Users can change their name themselves.
446 [[user-capabilities]]
447 ==== Manipulating user capabilities ====
449 `capabilities [user]`::
450         List capabilities of the `user`, or the calling user.
452 `admin capability add <user|hostmask> <capability>`::
453         Add `capability` to `user` or a user that matches the `hostmask`.
455 `admin capability remove <user|hostmask> <capability>`::
456         Ditto, but remove the capability.
458 `channel capability add [channel] <nick|user> <capability..>`::
459         Add capability `capability` on `channel` to `nick`/`user`.
461 `channel capability remove [channel] <nick|user> <capability..>`::
462         Remove capability `capability` on `channel` from `nick`/`user`.
464 `defaultcapability <add|remove> <capability>`::
465         Add or remove `capability` from list of capabilities given to new users.
467 `config capabilities`::
468         List default capabilities given to new users.
470 .output
471 ----
472 -owner -admin -trusted
473 ----
475 See also <<capabilities,Capabilities>>.
477 === General bot maintenance ===
479 Related plugins: [green]#Admin, Config#.
481 ==== Setting nickname & alternative nick ====
483 `admin nick <newnick>`::
484         Change nick to `newnick`.
486 `config nick`::
487         Default nick.
489 `config nick.alternates`::
490         Space-separated list of alternate nicks, %s refers to nick.
492 NOTE: It is not possible to have a different nick in different networks.
494 ==== Setting ident ====
496 `config ident <newident>`::
497         Sets the bot's ident (`nick!ident@host`).
499 ==== Setting ircname ====
501 `config user [ircname]`::
502         Sets the bot's ircname/realname to `ircname`. If left empty, defaults to 'Supybot 0.83.3' for example.
504 ==== Setting command prefix / controlling when the bot replies ====
506 Like most other bots, the bot can be addressed by its nickname, or a command prefix character (any or many of `~!@#$%^&*()_-+=[{}]\|'";:,<.>/?`). For special (braindead?) purposes the bot can also be made assume that all lines are addressed to it.
508 `config reply.whenAddressedBy.chars`::
509         List of characters the bot will recognize as addressing, besides the nick of the bot.
511 `config channel [channel] reply.whenAddressedBy.chars`::
512         Ditto, but for a specific channel.
514 `config reply.whenNotAddressed`::
515         Assume everyone wants to talk to the bot, eg. treat all messages as if addressed to the bot. This does not imply `reply.WhenNotCommand False` which you should set as well.
517 `config reply.whenNotCommand`::
518         Whether to reply when addressed with an invalid command.
520 ==== Listing and searching settings ====
522 `config search <word>` - list config items containing word.
524 `config <name>` - show config value for name.
526 `config <name> <value>` - set config value for name.
528 === Owner commands ===
530 `owner announce <text>` - send `text` to all channels the bot is on.
532 `owner ircquote <raw>` - send `raw` as-is to the server. You need to know your way around http://www.faqs.org/rfcs/rfc1459.html[RFC1459] pretty well to use this.
534 == User commands ==
536 [[searching-history]]
537 === Searching the history ===
539 `url last [channel] [\--{from,with,without,near,proto} value] [\--nolimit]`::
540         Find last URL (or all with `\--nolimit`) matching given criteria. From matches nick, with(out) part of the URL, near rest of the line where the URL was, and proto matches the protocol (https, ftp, etc). In case of multiple URLs, the newest is listed first. Multiple criterias can be given.
542         NOTE: This command lists only the URLs, not nick or what message the URLs were part of. No date is shown either.
544 `last [\--from,in,on,with,without,regexp} value] [\--nolimit]`::
545         Find messages matching given criteria. From matches nick, in matches channel, on matches network, with(out) matches part of the message, regexp matches messages that are included by the regular expression. Also see `config protocols.irc.maxHistoryLength`.
547 === Useful plugins ===
549 ==== Dict ====
551 [green]#Dict# provides dictionary functionality using dict.org. You can also use a local dictd server.
553 `dict [dictionary] <word>`::
554         Show dictionary entry for `word`, from `dictionary` if provided. If `plugins.Dict.default` is set, use the specified dictionary instead of all.
556 `dictionaries`::
557         List dictionaries available on the used server.
559 `dict random`::
560         Show a random dictionary from available dictionaries.
562 `config plugins.Dict.server [server]`::
563         The dictd server to be used, default is dict.org.
565 `config plugins.Dict.default [dictionary]`::
566         Channel-specific default dictionary for `dict` command. `*` means to use all dictionaries. `wn` is a good default if english words are mostly looked up.
568 ==== Later ====
570 This is a nick-based replacement for NoteServ and the likes. Simply put, you give the bot a note to deliver to a nick (or wildcard) the next time it sees a matching nick. In other words, this can be used to deliver messages to people who are not registered to the bot. Naturally that is not a very safe method of communicating.
572 `notes [nick]`::
573         List nicks that have notes queued, or the notes queued for `nick` if given.
575 `later tell <nick> <text>`::
576         Queues `text` to be sent to first matching `nick` when seen. Nick can contain wildcards, eg. `foo*`.
578 `config plugins.Later.maximum`::
579         How many messages can be queued per nick at maximum, default is 0 = no limit.
581 `config plugins.Later.private`::
582         Whether to send notes in private or on the channel where the recipient is seen.
584 === Games ===
586 Plugins: [green]#Games, Nickometer, Quote, QuoteGrabs#.
588 == Caveats ==
590 This is a list of issues I have not yet figured out how to do, or there simply isn't a way.
592 - How to enforce channel modes (eg. force +ns-t for example)
593 - How to delete config items
594 - How to delete channels / networks
595 - Ban add does not seem to work on Freenode
596 - No global ban list
597 - No way to delete a network
598 - Incomplete multi-network support
599         * Capabilities are not network/channel -specific, but channel-specific. If channel by same name exists in two networks, the users have same capabilities on both
600         * No way to add network-specific hostmasks
601         * Not possible for the bot to have different nick in different networks
602 - There is no command to reboot the bot; it must be done from the shell
604 == Tips ==
606 === How to emulate blootbot CMDs using MoobotFactoids ===
608 [,yellow]#Thanks to Tobias Rosenqvist for the tip!#
610 We try to make a command factoid, like we are used to with blootbot:
612 ----
613 <user> cmdtest is <action> gives $1 "(an apple|a pear)"
614 <bot> Ok.
615 ----
617 Then we test it:
619 ----
620 <user> cmdtest someone
621 ----
623 But it doesn't work.
624 However, the factoid works:
626 ----
627 <user> cmdtest
628   * bot gives $1 an apple
629 ----
631 The Moobotfactoids plugin in supybot doesn't handle arguments, (yet)
632 unfortunately, so you need to do it another way.
633 Use the Moobotfactoids to do the random part(s):
635 ----
636 <user> fruits is <reply> "(an apple|an orange|a banana|a pear)"
637 <bot> Ok.
638 ----
640 Then use an alias to do the command, with arguments (the "action" command
641 is found in the Reply plugin), here you also see a use of a nested command:
643 ----
644 <user> alias add givefruit action gives [fruits] to $1
645 <bot> Ok.
646 <user> givefruit someone
647  * bot gives a pear to someone
648 ----
650 === Tidier bot replies ===
652 I don't personally like the default Supybot replies: I hate the nick prefix and the way too verbose 'The operation succeeded.'.
654 Fortunately there are plenty of settings to configure how Supybot replies. These can be listed with `config reply` and `config replies`.
656 The `reply` items determine how Supybot acts, and `replies` contains some messages it uses. I prefer:
658 `config reply.withNickPrefix False`
660 `config replies.success OK`
662 `config reply.error.inPrivate True`.
664 What follows is a list of configuration items regarding replying.
666 .reply
667 *#inPrivate*:: Whether to reply in private to commands given on channel.
669 *#requireChannelCommandsToBeSentInChannel*:: -
671 *#showSimpleSyntax*:: Whether to be extra helpful when a user fails syntax of a command.
673 *#whenNotAddressed*:: Assume everyone wants to talk to the bot, eg. treat all messages as if addressed to the bot. This does not imply `reply.WhenNotCommand False` which you should set as well.
675 *#whenNotCommand*:: Whether to reply when addressed with an invalid command.
677 *#withNickPrefix*:: Whether to prefix the reply with the nick of the user who gave the command.
679 *#withNotice*:: Whether to use notices instead of regular messages.
681 *#mores.instant*:: How many messages to send initially before prompting for `more`. Default is 1.
683 *#mores.length*:: How long messages can be. Default is 0, which uses rocket science to determine the maximum number of characters that can be fit into a message without it collapsing into a black hole.
685 *#mores.maximum*:: Maximum number of messages to queue, default is 50.
687 *#error.inPrivate*:: Whether to send errors in private instead of replying on channel.
689 *#error.noCapability*:: If True, don't tell users why they can not run a command because of missing capabilities.
691 *#error.withNotice*:: Whether to send errors as notices instead of regular messages.
693 *error.detailed*:: Whether to show an exception or a generic error when something breaks. Mostly useful for developers.
695 *#format.time*:: Format string for timestamps (`%I:%M %p, %B %d, %Y`, eg. '08:41 PM, September 11, 2008').
697 *#whenAddressedBy.chars*:: List of characters the bot will recognize as addressing (when a command is prefixed with one of them), besides the nick of the bot.
699 *#whenAddressedBy.nicks*:: List of extra nicks to consider as addressing the bot, despite the current nick.
701 *#whenAddressedBy.strings*:: Like the chars key, except a space-separated list of strings to accept as command prefix. This allows multicharacter command prefixes.
703 *#whenAddressedBy.nick.atEnd*:: Whether to consider messages that end in the bot's nick to be addressed to the bot.
705 *maximumLength*:: Maximum length of a reply message from the bot. This does not mean the length of a single message (prompting for `more`), but the whole message.
707 *oneToOne*:: Whether to send replies consisting of multiple messages in a single message.
709 *withNoticeWhenPrivate*: Whether to use notices instead of private messages.