Fixed NetHack plugin crashing on first load.
[zzz-dywypi.git] / dywypi.conf
1 ###
2 # Determines the bot's default nick.
3 #
4 # Default value: supybot
5 ###
6 supybot.nick: dywypi
7
8 ###
9 # Determines what alternative nicks will be used if the primary nick
10 # (supybot.nick) isn't available. A %s in this nick is replaced by the
11 # value of supybot.nick when used. If no alternates are given, or if all
12 # are used, the supybot.nick will be perturbed appropriately until an
13 # unused nick is found.
14 #
15 # Default value: %s` %s_
16 ###
17 supybot.nick.alternates: %s` %s_
18
19 ###
20 # Determines the bot's ident string, if the server doesn't provide one
21 # by default.
22 #
23 # Default value: supybot
24 ###
25 supybot.ident: supybot
26
27 ###
28 # Determines the user the bot sends to the server. A standard user using
29 # the current version of the bot will be generated if this is left
30 # empty.
31 #
32 # Default value: 
33 ###
34 supybot.user: 
35
36 ###
37 # Determines what networks the bot will connect to.
38 #
39 # Default value:  
40 ###
41 supybot.networks: veekun
42
43 ###
44 # Determines what password will be used on veekun. Yes, we know that
45 # technically passwords are server-specific and not network-specific,
46 # but this is the best we can do right now.
47 #
48 # Default value: 
49 ###
50 supybot.networks.veekun.password: 
51
52 ###
53 # Determines what servers the bot will connect to for veekun. Each will
54 # be tried in order, wrapping back to the first when the cycle is
55 # completed.
56 #
57 # Default value: 
58 ###
59 supybot.networks.veekun.servers: irc.veekun.com:6667
60
61 ###
62 # Determines what channels the bot will join only on veekun.
63 #
64 # Default value:  
65 ###
66 supybot.networks.veekun.channels: #bot #cafe #tcod #veekun
67
68 ###
69 # Determines what key (if any) will be used to join the channel.
70 #
71 # Default value: 
72 ###
73 supybot.networks.veekun.channels.key: 
74
75 ###
76 # Determines whether the bot will attempt to connect with SSL sockets to
77 # veekun.
78 #
79 # Default value: False
80 ###
81 supybot.networks.veekun.ssl: False
82
83 ###
84 # Determines how timestamps printed for human reading should be
85 # formatted. Refer to the Python documentation for the time module to
86 # see valid formatting characters for time formats.
87 #
88 # Default value: %I:%M %p, %B %d, %Y
89 ###
90 supybot.reply.format.time: %I:%M %p, %B %d, %Y
91
92 ###
93 # Determines whether elapsed times will be given as "1 day, 2 hours, 3
94 # minutes, and 15 seconds" or as "1d 2h 3m 15s".
95 #
96 # Default value: False
97 ###
98 supybot.reply.format.time.elapsed.short: True
99
100 ###
101 # Determines the absolute maximum length of the bot's reply -- no reply
102 # will be passed through the bot with a length greater than this.
103 #
104 # Default value: 131072
105 ###
106 supybot.reply.maximumLength: 131072
107
108 ###
109 # Determines whether the bot will break up long messages into chunks and
110 # allow users to use the 'more' command to get the remaining chunks.
111 #
112 # Default value: True
113 ###
114 supybot.reply.mores: True
115
116 ###
117 # Determines what the maximum number of chunks (for use with the 'more'
118 # command) will be.
119 #
120 # Default value: 50
121 ###
122 supybot.reply.mores.maximum: 50
123
124 ###
125 # Determines how long individual chunks will be. If set to 0, uses our
126 # super-tweaked, get-the-most-out-of-an-individual-message default.
127 #
128 # Default value: 0
129 ###
130 supybot.reply.mores.length: 0
131
132 ###
133 # Determines how many mores will be sent instantly (i.e., without the
134 # use of the more command, immediately when they are formed). Defaults
135 # to 1, which means that a more command will be required for all but the
136 # first chunk.
137 #
138 # Default value: 1
139 ###
140 supybot.reply.mores.instant: 1
141
142 ###
143 # Determines whether the bot will send multi-message replies in a single
144 # message or in multiple messages. For safety purposes (so the bot is
145 # less likely to flood) it will normally send everything in a single
146 # message, using mores if necessary.
147 #
148 # Default value: True
149 ###
150 supybot.reply.oneToOne: True
151
152 ###
153 # Determines whether the bot will reply with an error message when it is
154 # addressed but not given a valid command. If this value is False, the
155 # bot will remain silent, as long as no other plugins override the
156 # normal behavior.
157 #
158 # Default value: True
159 ###
160 supybot.reply.whenNotCommand: True
161
162 ###
163 # Determines whether error messages that result from bugs in the bot
164 # will show a detailed error message (the uncaught exception) or a
165 # generic error message.
166 #
167 # Default value: False
168 ###
169 supybot.reply.error.detailed: False
170
171 ###
172 # Determines whether the bot will send error messages to users in
173 # private. You might want to do this in order to keep channel traffic to
174 # minimum. This can be used in combination with
175 # supybot.reply.error.withNotice.
176 #
177 # Default value: False
178 ###
179 supybot.reply.error.inPrivate: False
180
181 ###
182 # Determines whether the bot will send error messages to users via
183 # NOTICE instead of PRIVMSG. You might want to do this so users can
184 # ignore NOTICEs from the bot and not have to see error messages; or you
185 # might want to use it in combination with supybot.reply.errorInPrivate
186 # so private errors don't open a query window in most IRC clients.
187 #
188 # Default value: False
189 ###
190 supybot.reply.error.withNotice: False
191
192 ###
193 # Determines whether the bot will send an error message to users who
194 # attempt to call a command for which they do not have the necessary
195 # capability. You may wish to make this True if you don't want users to
196 # understand the underlying security system preventing them from running
197 # certain commands.
198 #
199 # Default value: False
200 ###
201 supybot.reply.error.noCapability: False
202
203 ###
204 # Determines whether the bot will reply privately when replying in a
205 # channel, rather than replying to the whole channel.
206 #
207 # Default value: False
208 ###
209 supybot.reply.inPrivate: False
210
211 ###
212 # Determines whether the bot will reply with a notice when replying in a
213 # channel, rather than replying with a privmsg as normal.
214 #
215 # Default value: False
216 ###
217 supybot.reply.withNotice: False
218
219 ###
220 # Determines whether the bot will reply with a notice when it is sending
221 # a private message, in order not to open a /query window in clients.
222 # This can be overridden by individual users via the user configuration
223 # variable reply.withNoticeWhenPrivate.
224 #
225 # Default value: False
226 ###
227 supybot.reply.withNoticeWhenPrivate: False
228
229 ###
230 # Determines whether the bot will always prefix the user's nick to its
231 # reply to that user's command.
232 #
233 # Default value: True
234 ###
235 supybot.reply.withNickPrefix: True
236
237 ###
238 # Determines whether the bot should attempt to reply to all messages
239 # even if they don't address it (either via its nick or a prefix
240 # character). If you set this to True, you almost certainly want to set
241 # supybot.reply.whenNotCommand to False.
242 #
243 # Default value: False
244 ###
245 supybot.reply.whenNotAddressed: False
246
247 ###
248 # Determines whether the bot will allow you to send channel-related
249 # commands outside of that channel. Sometimes people find it confusing
250 # if a channel-related command (like Filter.outfilter) changes the
251 # behavior of the channel but was sent outside the channel itself.
252 #
253 # Default value: False
254 ###
255 supybot.reply.requireChannelCommandsToBeSentInChannel: True
256
257 ###
258 # Supybot normally replies with the full help whenever a user misuses a
259 # command. If this value is set to True, the bot will only reply with
260 # the syntax of the command (the first line of the help) rather than the
261 # full help.
262 #
263 # Default value: False
264 ###
265 supybot.reply.showSimpleSyntax: False
266
267 ###
268 # Determines what prefix characters the bot will reply to. A prefix
269 # character is a single character that the bot will use to determine
270 # what messages are addressed to it; when there are no prefix characters
271 # set, it just uses its nick. Each character in this string is
272 # interpreted individually; you can have multiple prefix chars
273 # simultaneously, and if any one of them is used as a prefix the bot
274 # will assume it is being addressed.
275 #
276 # Default value: 
277 ###
278 supybot.reply.whenAddressedBy.chars: 
279
280 ###
281 # Determines what strings the bot will reply to when they are at the
282 # beginning of the message. Whereas prefix.chars can only be one
283 # character (although there can be many of them), this variable is a
284 # space-separated list of strings, so you can set something like '@@ ??'
285 # and the bot will reply when a message is prefixed by either @@ or ??.
286 #
287 # Default value:  
288 ###
289 supybot.reply.whenAddressedBy.strings: ยป
290
291 ###
292 # Determines whether the bot will reply when people address it by its
293 # nick, rather than with a prefix character.
294 #
295 # Default value: True
296 ###
297 supybot.reply.whenAddressedBy.nick: True
298
299 ###
300 # Determines whether the bot will reply when people address it by its
301 # nick at the end of the message, rather than at the beginning.
302 #
303 # Default value: False
304 ###
305 supybot.reply.whenAddressedBy.nick.atEnd: False
306
307 ###
308 # Determines what extra nicks the bot will always respond to when
309 # addressed by, even if its current nick is something else.
310 #
311 # Default value:  
312 ###
313 supybot.reply.whenAddressedBy.nicks: dywypi
314
315 ###
316 # Determines whether the bot will unidentify someone when that person
317 # changes his or her nick. Setting this to True will cause the bot to
318 # track such changes. It defaults to False for a little greater
319 # security.
320 #
321 # Default value: False
322 ###
323 supybot.followIdentificationThroughNickChanges: True
324
325 ###
326 # Determines whether the bot will always join a channel when it's
327 # invited. If this value is False, the bot will only join a channel if
328 # the user inviting it has the 'admin' capability (or if it's explicitly
329 # told to join the channel using the Admin.join command)
330 #
331 # Default value: False
332 ###
333 supybot.alwaysJoinOnInvite: False
334
335 ###
336 # Determines what message the bot replies with when a command succeeded.
337 # If this configuration variable is empty, no success message will be
338 # sent.
339 ###
340 supybot.replies.success: Okay.
341
342 ###
343 # Determines what error message the bot gives when it wants to be
344 # ambiguous.
345 ###
346 supybot.replies.error: I AM ERROR
347
348 ###
349 # Determines what message the bot replies with when someone tries to use
350 # a command that requires being identified or having a password and
351 # neither credential is correct.
352 ###
353 supybot.replies.incorrectAuthentication: I'm afraid I can't let you do that,\
354                                          Dave.
355
356 ###
357 # Determines what error message the bot replies with when someone tries
358 # to accessing some information on a user the bot doesn't know about.
359 ###
360 supybot.replies.noUser: I don't know who %s is.
361
362 ###
363 # Determines what error message the bot replies with when someone tries
364 # to do something that requires them to be registered but they're not
365 # currently recognized.
366 ###
367 supybot.replies.notRegistered: I'm afraid I can't let you do that, Dave.
368
369 ###
370 # Determines what error message is given when the bot is telling someone
371 # they aren't cool enough to use the command they tried to use.
372 ###
373 supybot.replies.noCapability: Only cool kids can use %s.
374
375 ###
376 # Determines what generic error message is given when the bot is telling
377 # someone that they aren't cool enough to use the command they tried to
378 # use, and the author of the code calling errorNoCapability didn't
379 # provide an explicit capability for whatever reason.
380 ###
381 supybot.replies.genericNoCapability: Only cool kids can do that.
382
383 ###
384 # Determines what error messages the bot sends to people who try to do
385 # things in a channel that really should be done in private.
386 ###
387 supybot.replies.requiresPrivacy: Shh! Not in public!
388
389 ###
390 # Determines what message the bot sends when it thinks you've
391 # encountered a bug that the developers don't know about.
392 ###
393 supybot.replies.possibleBug: I'm broken. :( Please harass developers.
394
395 ###
396 # A floating point number of seconds to throttle snarfed URLs, in order
397 # to prevent loops between two bots snarfing the same URLs and having
398 # the snarfed URL in the output of the snarf message.
399 #
400 # Default value: 10.0
401 ###
402 supybot.snarfThrottle: 10.0
403
404 ###
405 # Determines the number of seconds between running the upkeep function
406 # that flushes (commits) open databases, collects garbage, and records
407 # some useful statistics at the debugging level.
408 #
409 # Default value: 3600
410 ###
411 supybot.upkeepInterval: 3600
412
413 ###
414 # Determines whether the bot will periodically flush data and
415 # configuration files to disk. Generally, the only time you'll want to
416 # set this to False is when you want to modify those configuration files
417 # by hand and don't want the bot to flush its current version over your
418 # modifications. Do note that if you change this to False inside the
419 # bot, your changes won't be flushed. To make this change permanent, you
420 # must edit the registry yourself.
421 #
422 # Default value: True
423 ###
424 supybot.flush: True
425
426 ###
427 # Determines what characters are valid for quoting arguments to commands
428 # in order to prevent them from being tokenized.
429 #
430 # Default value: "
431 ###
432 supybot.commands.quotes: "
433
434 ###
435 # Determines whether the bot will allow nested commands, which rule. You
436 # definitely should keep this on.
437 #
438 # Default value: True
439 ###
440 supybot.commands.nested: True
441
442 ###
443 # Determines what the maximum number of nested commands will be; users
444 # will receive an error if they attempt commands more nested than this.
445 #
446 # Default value: 10
447 ###
448 supybot.commands.nested.maximum: 10
449
450 ###
451 # Supybot allows you to specify what brackets are used for your nested
452 # commands. Valid sets of brackets include [], <>, and {} (). [] has
453 # strong historical motivation, as well as being the brackets that don't
454 # require shift. <> or () might be slightly superior because they cannot
455 # occur in a nick. If this string is empty, nested commands will not be
456 # allowed in this channel.
457 #
458 # Default value: []
459 ###
460 supybot.commands.nested.brackets: []
461
462 ###
463 # Supybot allows nested commands. Enabling this option will allow nested
464 # commands with a syntax similar to UNIX pipes, for example: 'bot: foo |
465 # bar'.
466 #
467 # Default value: False
468 ###
469 supybot.commands.nested.pipeSyntax: True
470
471 ###
472 # Determines what commands have default plugins set, and which plugins
473 # are set to be the default for each of those commands.
474 ###
475 supybot.commands.defaultPlugins.addcapability: Admin
476 supybot.commands.defaultPlugins.capabilities: User
477 supybot.commands.defaultPlugins.disable: Owner
478 supybot.commands.defaultPlugins.enable: Owner
479 supybot.commands.defaultPlugins.help: Misc
480 supybot.commands.defaultPlugins.ignore: Admin
481
482 ###
483 # Determines what plugins automatically get precedence over all other
484 # plugins when selecting a default plugin for a command. By default,
485 # this includes the standard loaded plugins. You probably shouldn't
486 # change this if you don't know what you're doing; if you do know what
487 # you're doing, then also know that this set is case-sensitive.
488 #
489 # Default value: Plugin Admin Misc User Owner Config Channel
490 ###
491 supybot.commands.defaultPlugins.importantPlugins: Plugin Admin Misc User Owner Config Channel
492 supybot.commands.defaultPlugins.list: Misc
493 supybot.commands.defaultPlugins.reload: Owner
494 supybot.commands.defaultPlugins.removecapability: Admin
495 supybot.commands.defaultPlugins.unignore: Admin
496
497 ###
498 # Determines what commands are currently disabled. Such commands will
499 # not appear in command lists, etc. They will appear not even to exist.
500 #
501 # Default value:  
502 ###
503 supybot.commands.disabled:  
504
505 ###
506 # Determines whether the bot will defend itself against command-
507 # flooding.
508 #
509 # Default value: True
510 ###
511 supybot.abuse.flood.command: True
512
513 ###
514 # Determines how many commands users are allowed per minute. If a user
515 # sends more than this many commands in any 60 second period, he or she
516 # will be ignored for supybot.abuse.flood.command.punishment seconds.
517 #
518 # Default value: 12
519 ###
520 supybot.abuse.flood.command.maximum: 12
521
522 ###
523 # Determines how many seconds the bot will ignore users who flood it
524 # with commands.
525 #
526 # Default value: 300
527 ###
528 supybot.abuse.flood.command.punishment: 300
529
530 ###
531 # Determines whether the bot will defend itself against invalid command-
532 # flooding.
533 #
534 # Default value: True
535 ###
536 supybot.abuse.flood.command.invalid: True
537
538 ###
539 # Determines how many invalid commands users are allowed per minute. If
540 # a user sends more than this many invalid commands in any 60 second
541 # period, he or she will be ignored for
542 # supybot.abuse.flood.command.invalid.punishment seconds. Typically,
543 # this value is lower than supybot.abuse.flood.command.maximum, since
544 # it's far less likely (and far more annoying) for users to flood with
545 # invalid commands than for them to flood with valid commands.
546 #
547 # Default value: 5
548 ###
549 supybot.abuse.flood.command.invalid.maximum: 5
550
551 ###
552 # Determines how many seconds the bot will ignore users who flood it
553 # with invalid commands. Typically, this value is higher than
554 # supybot.abuse.flood.command.punishment, since it's far less likely
555 # (and far more annoying) for users to flood witih invalid commands than
556 # for them to flood with valid commands.
557 #
558 # Default value: 600
559 ###
560 supybot.abuse.flood.command.invalid.punishment: 600
561
562 ###
563 # Determines the default length of time a driver should block waiting
564 # for input.
565 #
566 # Default value: 1.0
567 ###
568 supybot.drivers.poll: 1.0
569
570 ###
571 # Determines what driver module the bot will use. Socket, a simple
572 # driver based on timeout sockets, is used by default because it's
573 # simple and stable. Twisted is very stable and simple, and if you've
574 # got Twisted installed, is probably your best bet.
575 #
576 # Default value: default
577 ###
578 supybot.drivers.module: default
579
580 ###
581 # Determines the maximum time the bot will wait before attempting to
582 # reconnect to an IRC server. The bot may, of course, reconnect earlier
583 # if possible.
584 #
585 # Default value: 300.0
586 ###
587 supybot.drivers.maxReconnectWait: 300.0
588
589 ###
590 # Determines what directory configuration data is put into.
591 #
592 # Default value: conf
593 ###
594 supybot.directories.conf: ./conf
595
596 ###
597 # Determines what directory data is put into.
598 #
599 # Default value: data
600 ###
601 supybot.directories.data: ./data
602
603 ###
604 # Determines what directory temporary files are put into.
605 #
606 # Default value: tmp
607 ###
608 supybot.directories.data.tmp: ./data/tmp
609
610 ###
611 # Determines what directory backup data is put into.
612 #
613 # Default value: backup
614 ###
615 supybot.directories.backup: ./backup
616
617 ###
618 # Determines what directories the bot will look for plugins in. Accepts
619 # a comma-separated list of strings. This means that to add another
620 # directory, you can nest the former value and add a new one. E.g. you
621 # can say: bot: 'config supybot.directories.plugins [config
622 # supybot.directories.plugins], newPluginDirectory'.
623 #
624 # Default value:  
625 ###
626 supybot.directories.plugins: ./plugins
627
628 ###
629 # Determines what directory the bot will store its logfiles in.
630 #
631 # Default value: logs
632 ###
633 supybot.directories.log: ./logs
634
635 ###
636 # Determines what plugins will be loaded.
637 #
638 # Default value:  
639 ###
640 supybot.plugins: Admin Math Misc User Owner Config Pokedex Channel Karma
641
642 ###
643 # Determines whether this plugin is loaded by default.
644 ###
645 supybot.plugins.Admin: True
646
647 ###
648 # Determines whether this plugin is publicly visible.
649 #
650 # Default value: True
651 ###
652 supybot.plugins.Admin.public: True
653
654 ###
655 # Determines whether this plugin is loaded by default.
656 ###
657 supybot.plugins.Channel: True
658
659 ###
660 # Determines whether this plugin is publicly visible.
661 #
662 # Default value: True
663 ###
664 supybot.plugins.Channel.public: True
665
666 ###
667 # Determines whether the bot will always try to rejoin a channel
668 # whenever it's kicked from the channel.
669 #
670 # Default value: True
671 ###
672 supybot.plugins.Channel.alwaysRejoin: True
673
674 ###
675 # Determines whether this plugin is loaded by default.
676 ###
677 supybot.plugins.Config: True
678
679 ###
680 # Determines whether this plugin is publicly visible.
681 #
682 # Default value: True
683 ###
684 supybot.plugins.Config.public: True
685
686 ###
687 # Determines whether this plugin is loaded by default.
688 ###
689 supybot.plugins.Karma: True
690
691 ###
692 # Determines whether this plugin is publicly visible.
693 #
694 # Default value: True
695 ###
696 supybot.plugins.Karma.public: True
697
698 ###
699 # Determines whether the bot will output shorter versions of the karma
700 # output when requesting a single thing's karma.
701 #
702 # Default value: False
703 ###
704 supybot.plugins.Karma.simpleOutput: True
705
706 ###
707 # Determines whether the bot will reply with a success message when
708 # something's karma is increased or decreased.
709 #
710 # Default value: False
711 ###
712 supybot.plugins.Karma.response: False
713
714 ###
715 # Determines how many highest/lowest karma things are shown when karma
716 # is called with no arguments.
717 #
718 # Default value: 3
719 ###
720 supybot.plugins.Karma.rankingDisplay: 3
721
722 ###
723 # Determines how many karma things are shown when the most command is
724 # called.'
725 #
726 # Default value: 25
727 ###
728 supybot.plugins.Karma.mostDisplay: 20
729
730 ###
731 # Determines whether users can adjust the karma of their nick.
732 #
733 # Default value: False
734 ###
735 supybot.plugins.Karma.allowSelfRating: False
736
737 ###
738 # Determines whether the bot will increase/decrease karma without being
739 # addressed.
740 #
741 # Default value: False
742 ###
743 supybot.plugins.Karma.allowUnaddressedKarma: True
744
745 ###
746 # Determines whether this plugin is loaded by default.
747 ###
748 supybot.plugins.Math: True
749
750 ###
751 # Determines whether this plugin is publicly visible.
752 #
753 # Default value: True
754 ###
755 supybot.plugins.Math.public: True
756
757 ###
758 # Determines whether this plugin is loaded by default.
759 ###
760 supybot.plugins.Misc: True
761
762 ###
763 # Determines whether this plugin is publicly visible.
764 #
765 # Default value: True
766 ###
767 supybot.plugins.Misc.public: True
768
769 ###
770 # Determines whether the bot will list private plugins with the list
771 # command if given the --private switch. If this is disabled, non-owner
772 # users should be unable to see what private plugins are loaded.
773 #
774 # Default value: True
775 ###
776 supybot.plugins.Misc.listPrivatePlugins: True
777
778 ###
779 # Determines the format string for timestamps in the Misc.last command.
780 # Refer to the Python documentation for the time module to see what
781 # formats are accepted. If you set this variable to the empty string,
782 # the timestamp will not be shown.
783 #
784 # Default value: [%H:%M:%S]
785 ###
786 supybot.plugins.Misc.timestampFormat: [%H:%M:%S]
787
788 ###
789 # Determines whether or not the timestamp will be included in the output
790 # of last when it is part of a nested command
791 #
792 # Default value: False
793 ###
794 supybot.plugins.Misc.last.nested.includeTimestamp: False
795
796 ###
797 # Determines whether or not the nick will be included in the output of
798 # last when it is part of a nested command
799 #
800 # Default value: False
801 ###
802 supybot.plugins.Misc.last.nested.includeNick: False
803
804 ###
805 # Determines whether this plugin is loaded by default.
806 ###
807 supybot.plugins.Owner: True
808
809 ###
810 # Determines whether this plugin is publicly visible.
811 #
812 # Default value: True
813 ###
814 supybot.plugins.Owner.public: True
815
816 ###
817 # Determines what quit message will be used by default. If the quit
818 # command is called without a quit message, this will be used. If this
819 # value is empty, the nick of the person giving the quit command will be
820 # used.
821 #
822 # Default value: 
823 ###
824 supybot.plugins.Owner.quitMsg: 
825
826 ###
827 # Determines whether this plugin is loaded by default.
828 ###
829 supybot.plugins.Pokedex: True
830
831 ###
832 # Determines whether this plugin is publicly visible.
833 #
834 # Default value: True
835 ###
836 supybot.plugins.Pokedex.public: True
837
838 ###
839 # SQLAlchemy-compatible URL to the pokedex database.
840 #
841 # Default value: 
842 ###
843 supybot.plugins.Pokedex.databaseURL: 
844
845 ###
846 # Determines whether this plugin is loaded by default.
847 ###
848 supybot.plugins.User: True
849
850 ###
851 # Determines whether this plugin is publicly visible.
852 #
853 # Default value: True
854 ###
855 supybot.plugins.User.public: True
856
857 ###
858 # Determines whether the bot will always load important plugins (Admin,
859 # Channel, Config, Misc, Owner, and User) regardless of what their
860 # configured state is. Generally, if these plugins are configured not to
861 # load, you didn't do it on purpose, and you still want them to load.
862 # Users who don't want to load these plugins are smart enough to change
863 # the value of this variable appropriately :)
864 #
865 # Default value: True
866 ###
867 supybot.plugins.alwaysLoadImportant: True
868
869 ###
870 # Determines what databases are available for use. If this value is not
871 # configured (that is, if its value is empty) then sane defaults will be
872 # provided.
873 #
874 # Default value: sqlite anydbm cdb flat pickle
875 ###
876 supybot.databases: sqlite
877
878 ###
879 # Determines what filename will be used for the users database. This
880 # file will go into the directory specified by the
881 # supybot.directories.conf variable.
882 #
883 # Default value: users.conf
884 ###
885 supybot.databases.users.filename: users.conf
886
887 ###
888 # Determines how long it takes identification to time out. If the value
889 # is less than or equal to zero, identification never times out.
890 #
891 # Default value: 0
892 ###
893 supybot.databases.users.timeoutIdentification: 0
894
895 ###
896 # Determines whether the bot will allow users to unregister their users.
897 # This can wreak havoc with already-existing databases, so by default we
898 # don't allow it. Enable this at your own risk. (Do also note that this
899 # does not prevent the owner of the bot from using the unregister
900 # command.)
901 #
902 # Default value: False
903 ###
904 supybot.databases.users.allowUnregistration: False
905
906 ###
907 # Determines what filename will be used for the ignores database. This
908 # file will go into the directory specified by the
909 # supybot.directories.conf variable.
910 #
911 # Default value: ignores.conf
912 ###
913 supybot.databases.ignores.filename: ignores.conf
914
915 ###
916 # Determines what filename will be used for the channels database. This
917 # file will go into the directory specified by the
918 # supybot.directories.conf variable.
919 #
920 # Default value: channels.conf
921 ###
922 supybot.databases.channels.filename: channels.conf
923
924 ###
925 # Determines whether database-based plugins that can be channel-specific
926 # will be so. This can be overridden by individual channels. Do note
927 # that the bot needs to be restarted immediately after changing this
928 # variable or your db plugins may not work for your channel; also note
929 # that you may wish to set
930 # supybot.databases.plugins.channelSpecific.link appropriately if you
931 # wish to share a certain channel's databases globally.
932 #
933 # Default value: True
934 ###
935 supybot.databases.plugins.channelSpecific: True
936
937 ###
938 # Determines what channel global (non-channel-specific) databases will
939 # be considered a part of. This is helpful if you've been running
940 # channel-specific for awhile and want to turn the databases for your
941 # primary channel into global databases. If
942 # supybot.databases.plugins.channelSpecific.link.allow prevents linking,
943 # the current channel will be used. Do note that the bot needs to be
944 # restarted immediately after changing this variable or your db plugins
945 # may not work for your channel.
946 #
947 # Default value: #
948 ###
949 supybot.databases.plugins.channelSpecific.link: #
950
951 ###
952 # Determines whether another channel's global (non-channel-specific)
953 # databases will be allowed to link to this channel's databases. Do note
954 # that the bot needs to be restarted immediately after changing this
955 # variable or your db plugins may not work for your channel.
956 #
957 # Default value: True
958 ###
959 supybot.databases.plugins.channelSpecific.link.allow: True
960
961 ###
962 # Determines whether CDB databases will be allowed as a database
963 # implementation.
964 #
965 # Default value: True
966 ###
967 supybot.databases.types.cdb: True
968
969 ###
970 # Determines how often CDB databases will have their modifications
971 # flushed to disk. When the number of modified records is greater than
972 # this part of the number of unmodified records, the database will be
973 # entirely flushed to disk.
974 #
975 # Default value: 0.5
976 ###
977 supybot.databases.types.cdb.maximumModifications: 0.5
978
979 ###
980 # Determines what will be used as the default banmask style.
981 #
982 # Default value: host user
983 ###
984 supybot.protocols.irc.banmask: host user
985
986 ###
987 # Determines whether the bot will strictly follow the RFC; currently
988 # this only affects what strings are considered to be nicks. If you're
989 # using a server or a network that requires you to message a nick such
990 # as services@this.network.server then you you should set this to False.
991 #
992 # Default value: False
993 ###
994 supybot.protocols.irc.strictRfc: False
995
996 ###
997 # Determines what user modes the bot will request from the server when
998 # it first connects. Many people might choose +i; some networks allow
999 # +x, which indicates to the auth services on those networks that you
1000 # should be given a fake host.
1001 #
1002 # Default value: 
1003 ###
1004 supybot.protocols.irc.umodes: 
1005
1006 ###
1007 # Determines what vhost the bot will bind to before connecting to the
1008 # IRC server.
1009 #
1010 # Default value: 
1011 ###
1012 supybot.protocols.irc.vhost: 
1013
1014 ###
1015 # Determines how many old messages the bot will keep around in its
1016 # history. Changing this variable will not take effect until the bot is
1017 # restarted.
1018 #
1019 # Default value: 1000
1020 ###
1021 supybot.protocols.irc.maxHistoryLength: 1000
1022
1023 ###
1024 # A floating point number of seconds to throttle queued messages -- that
1025 # is, messages will not be sent faster than once per throttleTime
1026 # seconds.
1027 #
1028 # Default value: 1.0
1029 ###
1030 supybot.protocols.irc.throttleTime: 1.0
1031
1032 ###
1033 # Determines whether the bot will send PINGs to the server it's
1034 # connected to in order to keep the connection alive and discover
1035 # earlier when it breaks. Really, this option only exists for debugging
1036 # purposes: you always should make it True unless you're testing some
1037 # strange server issues.
1038 #
1039 # Default value: True
1040 ###
1041 supybot.protocols.irc.ping: True
1042
1043 ###
1044 # Determines the number of seconds between sending pings to the server,
1045 # if pings are being sent to the server.
1046 #
1047 # Default value: 120
1048 ###
1049 supybot.protocols.irc.ping.interval: 120
1050
1051 ###
1052 # Determines whether the bot will refuse duplicate messages to be queued
1053 # for delivery to the server. This is a safety mechanism put in place to
1054 # prevent plugins from sending the same message multiple times; most of
1055 # the time it doesn't matter, unless you're doing certain kinds of
1056 # plugin hacking.
1057 #
1058 # Default value: False
1059 ###
1060 supybot.protocols.irc.queuing.duplicates: False
1061
1062 ###
1063 # Determines how many seconds must elapse between JOINs sent to the
1064 # server.
1065 #
1066 # Default value: 0.0
1067 ###
1068 supybot.protocols.irc.queuing.rateLimit.join: 0.0
1069
1070 ###
1071 # Determines how many bytes the bot will 'peek' at when looking through
1072 # a URL for a doctype or title or something similar. It'll give up after
1073 # it reads this many bytes, even if it hasn't found what it was looking
1074 # for.
1075 #
1076 # Default value: 4096
1077 ###
1078 supybot.protocols.http.peekSize: 4096
1079
1080 ###
1081 # Determines what proxy all HTTP requests should go through. The value
1082 # should be of the form 'host:port'.
1083 #
1084 # Default value: 
1085 ###
1086 supybot.protocols.http.proxy: 
1087
1088 ###
1089 # Determines whether the bot will ignore unregistered users by default.
1090 # Of course, that'll make it particularly hard for those users to
1091 # register or identify with the bot, but that's your problem to solve.
1092 #
1093 # Default value: False
1094 ###
1095 supybot.defaultIgnore: False
1096
1097 ###
1098 # A string that is the external IP of the bot. If this is the empty
1099 # string, the bot will attempt to find out its IP dynamically (though
1100 # sometimes that doesn't work, hence this variable).
1101 #
1102 # Default value: 
1103 ###
1104 supybot.externalIP: 
1105
1106 ###
1107 # Determines what the default timeout for socket objects will be. This
1108 # means that *all* sockets will timeout when this many seconds has gone
1109 # by (unless otherwise modified by the author of the code that uses the
1110 # sockets).
1111 #
1112 # Default value: 10
1113 ###
1114 supybot.defaultSocketTimeout: 10
1115
1116 ###
1117 # Determines what file the bot should write its PID (Process ID) to, so
1118 # you can kill it more easily. If it's left unset (as is the default)
1119 # then no PID file will be written. A restart is required for changes to
1120 # this variable to take effect.
1121 #
1122 # Default value: 
1123 ###
1124 supybot.pidFile: ./dywypi.pid
1125
1126 ###
1127 # Determines whether the bot will automatically thread all commands.
1128 #
1129 # Default value: False
1130 ###
1131 supybot.debug.threadAllCommands: False
1132
1133 ###
1134 # Determines whether the bot will automatically flush all flushers
1135 # *very* often. Useful for debugging when you don't know what's breaking
1136 # or when, but think that it might be logged.
1137 #
1138 # Default value: False
1139 ###
1140 supybot.debug.flushVeryOften: False
1141
1142 ###
1143 # Determines what the bot's logging format will be. The relevant
1144 # documentation on the available formattings is Python's documentation
1145 # on its logging module.
1146 #
1147 # Default value: %(levelname)s %(asctime)s %(name)s %(message)s
1148 ###
1149 supybot.log.format: %(levelname)s %(asctime)s %(name)s %(message)s
1150
1151 ###
1152 # Determines what the minimum priority level logged to file will be. Do
1153 # note that this value does not affect the level logged to stdout; for
1154 # that, you should set the value of supybot.log.stdout.level. Valid
1155 # values are DEBUG, INFO, WARNING, ERROR, and CRITICAL, in order of
1156 # increasing priority.
1157 #
1158 # Default value: INFO
1159 ###
1160 supybot.log.level: INFO
1161
1162 ###
1163 # Determines the format string for timestamps in logfiles. Refer to the
1164 # Python documentation for the time module to see what formats are
1165 # accepted. If you set this variable to the empty string, times will be
1166 # logged in a simple seconds-since-epoch format.
1167 #
1168 # Default value: %Y-%m-%dT%H:%M:%S
1169 ###
1170 supybot.log.timestampFormat: %Y-%m-%dT%H:%M:%S
1171
1172 ###
1173 # Determines whether the bot will log to stdout.
1174 #
1175 # Default value: True
1176 ###
1177 supybot.log.stdout: True
1178
1179 ###
1180 # Determines whether the bot's logs to stdout (if enabled) will be
1181 # colorized with ANSI color.
1182 #
1183 # Default value: False
1184 ###
1185 supybot.log.stdout.colorized: False
1186
1187 ###
1188 # Determines whether the bot will wrap its logs when they're output to
1189 # stdout.
1190 #
1191 # Default value: True
1192 ###
1193 supybot.log.stdout.wrap: True
1194
1195 ###
1196 # Determines what the bot's logging format will be. The relevant
1197 # documentation on the available formattings is Python's documentation
1198 # on its logging module.
1199 #
1200 # Default value: %(levelname)s %(asctime)s %(message)s
1201 ###
1202 supybot.log.stdout.format: %(levelname)s %(asctime)s %(message)s
1203
1204 ###
1205 # Determines what the minimum priority level logged will be. Valid
1206 # values are DEBUG, INFO, WARNING, ERROR, and CRITICAL, in order of
1207 # increasing priority.
1208 #
1209 # Default value: INFO
1210 ###
1211 supybot.log.stdout.level: INFO
1212
1213 ###
1214 # Determines whether the bot will separate plugin logs into their own
1215 # individual logfiles.
1216 #
1217 # Default value: False
1218 ###
1219 supybot.log.plugins.individualLogfiles: False
1220
1221 ###
1222 # Determines what the bot's logging format will be. The relevant
1223 # documentation on the available formattings is Python's documentation
1224 # on its logging module.
1225 #
1226 # Default value: %(levelname)s %(asctime)s %(message)s
1227 ###
1228 supybot.log.plugins.format: %(levelname)s %(asctime)s %(message)s
1229
1230 ###
1231 # These are the capabilities that are given to everyone by default. If
1232 # they are normal capabilities, then the user will have to have the
1233 # appropriate anti-capability if you want to override these
1234 # capabilities; if they are anti-capabilities, then the user will have
1235 # to have the actual capability to override these capabilities. See
1236 # docs/CAPABILITIES if you don't understand why these default to what
1237 # they do.
1238 #
1239 # Default value: -owner -admin -trusted
1240 ###
1241 supybot.capabilities: -owner -admin -trusted
1242
1243 ###
1244 # Determines whether the bot by default will allow users to have a
1245 # capability. If this is disabled, a user must explicitly have the
1246 # capability for whatever command he wishes to run.
1247 #
1248 # Default value: True
1249 ###
1250 supybot.capabilities.default: True