Non-plugin configuration variables for Supybot

  • supybot.nick
    • Default: "supybot"
    • Channel Specific: False
    • Help: Determines the bot's default nick.
    • .alternates
      • Default: %s` %s_
      • Channel Specific: False
      • Help: Determines what alternative nicks will be used if the primary nick (supybot.nick) isn't available. A %s in this nick is replaced by the value of supybot.nick when used. If no alternates are given, or if all are used, the supybot.nick will be perturbed appropriately until an unused nick is found.
  • supybot.ident
    • Default: "supybot"
    • Channel Specific: False
    • Help: Determines the bot's ident string, if the server doesn't provide one by default.
  • supybot.user
    • Default: ""
    • Channel Specific: False
    • Help: Determines the user the bot sends to the server. A standard user using the current version of the bot will be generated if this is left empty.
  • supybot.networks
    • Default:
    • Channel Specific: False
    • Help: Determines what networks the bot will connect to.
  • supybot.reply
    • .format
      • .time
        • Default: "%I:%M %p, %B %d, %Y"
        • Channel Specific: True
        • Help: Determines how timestamps printed for human reading should be formatted. Refer to the Python documentation for the time module to see valid formatting characters for time formats.
        • .elapsed
          • .short
            • Default: False
            • Channel Specific: True
            • Help: Determines whether elapsed times will be given as "1 day, 2 hours, 3 minutes, and 15 seconds" or as "1d 2h 3m 15s".
    • .maximumLength
      • Default: 131072
      • Channel Specific: False
      • Help: Determines the absolute maximum length of the bot's reply -- no reply will be passed through the bot with a length greater than this.
    • .mores
      • Default: True
      • Channel Specific: True
      • Help: Determines whether the bot will break up long messages into chunks and allow users to use the 'more' command to get the remaining chunks.
      • .maximum
        • Default: 50
        • Channel Specific: True
        • Help: Determines what the maximum number of chunks (for use with the 'more' command) will be.
      • .length
        • Default: 0
        • Channel Specific: True
        • Help: Determines how long individual chunks will be. If set to 0, uses our super-tweaked, get-the-most-out-of-an-individual-message default.
      • .instant
        • Default: 1
        • Channel Specific: True
        • Help: Determines how many mores will be sent instantly (i.e., without the use of the more command, immediately when they are formed). Defaults to 1, which means that a more command will be required for all but the first chunk.
    • .oneToOne
      • Default: True
      • Channel Specific: False
      • Help: Determines whether the bot will send multi-message replies in a single message or in multiple messages. For safety purposes (so the bot is less likely to flood) it will normally send everything in a single message, using mores if necessary.
    • .whenNotCommand
      • Default: True
      • Channel Specific: True
      • Help: Determines whether the bot will reply with an error message when it is addressed but not given a valid command. If this value is False, the bot will remain silent, as long as no other plugins override the normal behavior.
    • .error
      • .detailed
        • Default: False
        • Channel Specific: False
        • Help: Determines whether error messages that result from bugs in the bot will show a detailed error message (the uncaught exception) or a generic error message.
      • .inPrivate
        • Default: False
        • Channel Specific: True
        • Help: Determines whether the bot will send error messages to users in private. You might want to do this in order to keep channel traffic to minimum. This can be used in combination with supybot.reply.errorWithNotice.
      • .withNotice
        • Default: False
        • Channel Specific: True
        • Help: Determines whether the bot will send error messages to users via NOTICE instead of PRIVMSG. You might want to do this so users can ignore NOTICEs from the bot and not have to see error messages; or you might want to use it in combination with supybot.reply.errorInPrivate so private errors don't open a query window in most IRC clients.
      • .noCapability
        • Default: False
        • Channel Specific: True
        • Help: Determines whether the bot will send an error message to users who attempt to call a command for which they do not have the necessary capability. You may wish to make this True if you don't want users to understand the underlying security system preventing them from running certain commands.
    • .inPrivate
      • Default: False
      • Channel Specific: True
      • Help: Determines whether the bot will reply privately when replying in a channel, rather than replying to the whole channel.
    • .withNotice
      • Default: False
      • Channel Specific: True
      • Help: Determines whether the bot will reply with a notice when replying in a channel, rather than replying with a privmsg as normal.
    • .withNoticeWhenPrivate
      • Default: False
      • Channel Specific: False
      • Help: Determines whether the bot will reply with a notice when it is sending a private message, in order not to open a /query window in clients. This can be overridden by individual users via the user configuration variable reply.withNoticeWhenPrivate.
    • .withNickPrefix
      • Default: True
      • Channel Specific: True
      • Help: Determines whether the bot will always prefix the user's nick to its reply to that user's command.
    • .whenNotAddressed
      • Default: False
      • Channel Specific: True
      • Help: Determines whether the bot should attempt to reply to all messages even if they don't address it (either via its nick or a prefix character). If you set this to True, you almost certainly want to set supybot.reply.whenNotCommand to False.
    • .requireChannelCommandsToBeSentInChannel
      • Default: False
      • Channel Specific: True
      • Help: Determines whether the bot will allow you to send channel-related commands outside of that channel. Sometimes people find it confusing if a channel-related command (like Filter.outfilter) changes the behavior of the channel but was sent outside the channel itself.
    • .showSimpleSyntax
      • Default: False
      • Channel Specific: True
      • Help: Supybot normally replies with the full help whenever a user misuses a command. If this value is set to True, the bot will only reply with the syntax of the command (the first line of the help) rather than the full help.
    • .whenAddressedBy
      • .chars
        • Default: ""
        • Channel Specific: True
        • Help: Determines what prefix characters the bot will reply to. A prefix character is a single character that the bot will use to determine what messages are addressed to it; when there are no prefix characters set, it just uses its nick. Each character in this string is interpreted individually; you can have multiple prefix chars simultaneously, and if any one of them is used as a prefix the bot will assume it is being addressed.
      • .strings
        • Default:
        • Channel Specific: True
        • Help: Determines what strings the bot will reply to when they are at the beginning of the message. Whereas prefix.chars can only be one character (although there can be many of them), this variable is a space-separated list of strings, so you can set something like '@@ ??' and the bot will reply when a message is prefixed by either @@ or ??.
      • .nick
        • Default: True
        • Channel Specific: True
        • Help: Determines whether the bot will reply when people address it by its nick, rather than with a prefix character.
        • .atEnd
          • Default: False
          • Channel Specific: True
          • Help: Determines whether the bot will reply when people address it by its nick at the end of the message, rather than at the beginning.
      • .nicks
        • Default:
        • Channel Specific: True
        • Help: Determines what extra nicks the bot will always respond to when addressed by, even if its current nick is something else.
  • supybot.followIdentificationThroughNickChanges
    • Default: False
    • Channel Specific: False
    • Help: Determines whether the bot will unidentify someone when that person changes his or her nick. Setting this to True will cause the bot to track such changes. It defaults to False for a little greater security.
  • supybot.alwaysJoinOnInvite
    • Default: False
    • Channel Specific: False
    • Help: Determines whether the bot will always join a channel when it's invited. If this value is False, the bot will only join a channel if the user inviting it has the 'admin' capability (or if it's explicitly told to join the channel using the Admin.join command)
  • supybot.replies
    • .success
      • Default: "The operation succeeded."
      • Channel Specific: True
      • Help: Determines what message the bot replies with when a command succeeded. If this configuration variable is empty, no success message will be sent.
    • .error
      • Default: "An error has occurred and has been logged. Please contact this bot\'s administrator for more information."
      • Channel Specific: True
      • Help: Determines what error message the bot gives when it wants to be ambiguous.
    • .incorrectAuthentication
      • Default: "Your hostmask doesn\'t match or your password is wrong."
      • Channel Specific: True
      • Help: Determines what message the bot replies with when someone tries to use a command that requires being identified or having a password and neither credential is correct.
    • .noUser
      • Default: "I can\'t find %s in my user database. If you didn\'t give a user name, then I might not know what your user is, and you\'ll need to identify before this command might work."
      • Channel Specific: True
      • Help: Determines what error message the bot replies with when someone tries to accessing some information on a user the bot doesn't know about.
    • .notRegistered
      • Default: "You must be registered to use this command. If you are already registered, you must either identify (using the identify command) or add a hostmask matching your current hostmask (using the addhostmask command)."
      • Channel Specific: True
      • Help: Determines what error message the bot replies with when someone tries to do something that requires them to be registered but they're not currently recognized.
    • .noCapability
      • Default: "You don\'t have the %s capability. If you think that you should have this capability, be sure that you are identified before trying again. The \'whoami\' command can tell you if you\'re identified."
      • Channel Specific: True
      • Help: Determines what error message is given when the bot is telling someone they aren't cool enough to use the command they tried to use.
    • .genericNoCapability
      • Default: "You\'re missing some capability you need. This could be because you actually possess the anti-capability for the capability that\'s required of you, or because the channel provides that anti-capability by default, or because the global capabilities include that anti-capability. Or, it could be because the channel or supybot.capabilities.default is set to False, meaning that no commands are allowed unless explicitly in your capabilities. Either way, you can\'t do what you want to do."
      • Channel Specific: True
      • Help: Determines what generic error message is given when the bot is telling someone that they aren't cool enough to use the command they tried to use, and the author of the code calling errorNoCapability didn't provide an explicit capability for whatever reason.
    • .requiresPrivacy
      • Default: "That operation cannot be done in a channel."
      • Channel Specific: True
      • Help: Determines what error messages the bot sends to people who try to do things in a channel that really should be done in private.
    • .possibleBug
      • Default: "This may be a bug. If you think it is, please file a bug report at <http://sourceforge.net/tracker/?func=add&group_id=58965&atid=489447>."
      • Channel Specific: True
      • Help: Determines what message the bot sends when it thinks you've encountered a bug that the developers don't know about.
  • supybot.snarfThrottle
    • Default: 10.0
    • Channel Specific: False
    • Help: A floating point number of seconds to throttle snarfed URLs, in order to prevent loops between two bots snarfing the same URLs and having the snarfed URL in the output of the snarf message.
  • supybot.upkeepInterval
    • Default: 3600
    • Channel Specific: False
    • Help: Determines the number of seconds between running the upkeep function that flushes (commits) open databases, collects garbage, and records some useful statistics at the debugging level.
  • supybot.flush
    • Default: True
    • Channel Specific: False
    • Help: Determines whether the bot will periodically flush data and configuration files to disk. Generally, the only time you'll want to set this to False is when you want to modify those configuration files by hand and don't want the bot to flush its current version over your modifications. Do note that if you change this to False inside the bot, your changes won't be flushed. To make this change permanent, you must edit the registry yourself.
  • supybot.commands
    • .quotes
      • Default: "\""
      • Channel Specific: True
      • Help: Determines what characters are valid for quoting arguments to commands in order to prevent them from being tokenized.
    • .nested
      • Default: True
      • Channel Specific: False
      • Help: Determines whether the bot will allow nested commands, which rule. You definitely should keep this on.
      • .maximum
        • Default: 10
        • Channel Specific: False
        • Help: Determines what the maximum number of nested commands will be; users will receive an error if they attempt commands more nested than this.
      • .brackets
        • Default: "[]"
        • Channel Specific: True
        • Help: Supybot allows you to specify what brackets are used for your nested commands. Valid sets of brackets include [], <>, and {} (). [] has strong historical motivation, as well as being the brackets that don't require shift. <> or () might be slightly superior because they cannot occur in a nick. If this string is empty, nested commands will not be allowed in this channel. Valid strings: [], <>, {}, and ().
      • .pipeSyntax
        • Default: False
        • Channel Specific: True
        • Help: Supybot allows nested commands. Enabling this option will allow nested commands with a syntax similar to UNIX pipes, for example: 'bot: foo | bar'.
    • .defaultPlugins
      • .importantPlugins
        • Default: Admin Misc User Owner Config Channel
        • Channel Specific: False
        • Help: Determines what plugins automatically get precedence over all other plugins when selecting a default plugin for a command. By default, this includes the standard loaded plugins. You probably shouldn't change this if you don't know what you're doing; if you do know what you're doing, then also know that this set is case-sensitive.
    • .disabled
      • Default:
      • Channel Specific: False
      • Help: Determines what commands are currently disabled. Such commands will not appear in command lists, etc. They will appear not even to exist.
  • supybot.abuse
    • .flood
      • .command
        • Default: True
        • Channel Specific: False
        • Help: Determines whether the bot will defend itself against command-flooding.
        • .maximum
          • Default: 12
          • Channel Specific: False
          • Help: Determines how many commands users are allowed per minute. If a user sends more than this many commands in any 60 second period, he or she will be ignored for supybot.abuse.flood.command.punishment seconds.
        • .punishment
          • Default: 300
          • Channel Specific: False
          • Help: Determines how many seconds the bot will ignore users who flood it with commands.
        • .invalid
          • Default: True
          • Channel Specific: False
          • Help: Determines whether the bot will defend itself against invalid command-flooding.
          • .maximum
            • Default: 5
            • Channel Specific: False
            • Help: Determines how many invalid commands users are allowed per minute. If a user sends more than this many invalid commands in any 60 second period, he or she will be ignored for supybot.abuse.flood.command.invalid.punishment seconds. Typically, this value is lower than supybot.abuse.flood.command.maximum, since it's far less likely (and far more annoying) for users to flood with invalid commands than for them to flood with valid commands.
          • .punishment
            • Default: 600
            • Channel Specific: False
            • Help: Determines how many seconds the bot will ignore users who flood it with invalid commands. Typically, this value is higher than supybot.abuse.flood.command.punishment, since it's far less likely (and far more annoying) for users to flood witih invalid commands than for them to flood with valid commands.
  • supybot.drivers
    • .poll
      • Default: 1.0
      • Channel Specific: False
      • Help: Determines the default length of time a driver should block waiting for input.
    • .module
      • Default: "default"
      • Channel Specific: False
      • Help: Determines what driver module the bot will use. socketDrivers, a simple driver based on timeout sockets, is used by default because it's simple and stable. asyncoreDrivers is a bit older (and less well-maintained) but allows you to integrate with asyncore-based applications. twistedDrivers is very stable and simple, and if you've got Twisted installed, is probably your best bet. Valid strings: default, socketDrivers, twistedDrivers, and asyncoreDrivers.
  • supybot.directories
    • .conf
      • Default: "test-conf"
      • Channel Specific: False
      • Help: Determines what directory configuration data is put into.
    • .data
      • Default: "test-data"
      • Channel Specific: False
      • Help: Determines what directory data is put into.
      • .tmp
        • Default: "tmp"
        • Channel Specific: False
        • Help: Determines what directory temporary files are put into.
    • .backup
      • Default: "backup"
      • Channel Specific: False
      • Help: Determines what directory backup data is put into.
    • .plugins
      • Default: /usr/lib/python2.3/site-packages/supybot, /usr/lib/python2.3/site-packages/supybot/plugins
      • Channel Specific: False
      • Help: Determines what directories the bot will look for plugins in. Accepts a comma-separated list of strings. This means that to add another directory, you can nest the former value and add a new one. E.g. you can say: bot: 'config supybot.directories.plugins [config supybot.directories.plugins], newPluginDirectory'.
    • .log
      • Default: "test-logs"
      • Channel Specific: False
      • Help: Determines what directory the bot will store its logfiles in.
  • supybot.plugins
    • Default:
    • Channel Specific: False
    • Help: Determines what plugins will be loaded.
    • .alwaysLoadImportant
      • Default: True
      • Channel Specific: False
      • Help: Determines whether the bot will always load important plugins (Admin, Channel, Config, Misc, Owner, and User) regardless of what their configured state is. Generally, if these plugins are configured not to load, you didn't do it on purpose, and you still want them to load. Users who don't want to load these plugins are smart enough to change the value of this variable appropriately :)
  • supybot.databases
    • Default: anydbm cdb flat pickle
    • Channel Specific: False
    • Help: Determines what databases are available for use. If this value is not configured (that is, if its value is empty) then sane defaults will be provided.
    • .users
      • .filename
        • Default: "users.conf"
        • Channel Specific: False
        • Help: Determines what filename will be used for the users database. This file will go into the directory specified by the supybot.directories.conf variable.
      • .timeoutIdentification
        • Default: 0
        • Channel Specific: False
        • Help: Determines how long it takes identification to time out. If the value is less than or equal to zero, identification never times out.
      • .allowUnregistration
        • Default: False
        • Channel Specific: False
        • Help: Determines whether the bot will allow users to unregister their users. This can wreak havoc with already-existing databases, so by default we don't allow it. Enable this at your own risk. (Do also note that this does not prevent the owner of the bot from using the unregister command.)
    • .ignores
      • .filename
        • Default: "ignores.conf"
        • Channel Specific: False
        • Help: Determines what filename will be used for the ignores database. This file will go into the directory specified by the supybot.directories.conf variable.
    • .channels
      • .filename
        • Default: "channels.conf"
        • Channel Specific: False
        • Help: Determines what filename will be used for the channels database. This file will go into the directory specified by the supybot.directories.conf variable.
    • .plugins
      • .channelSpecific
        • Default: True
        • Channel Specific: True
        • Help: Determines whether database-based plugins that can be channel-specific will be so. This can be overridden by individual channels. Do note that the bot needs to be restarted immediately after changing this variable or your db plugins may not work for your channel; also note that you may wish to set supybot.databases.plugins.channelSpecific.link appropriately if you wish to share a certain channel's databases globally.
    • .types
      • .cdb
        • Default: True
        • Channel Specific: False
        • Help: Determines whether CDB databases will be allowed as a database implementation.
        • .maximumModifications
          • Default: 0.5
          • Channel Specific: False
          • Help: Determines how often CDB databases will have their modifications flushed to disk. When the number of modified records is greater than this part of the number of unmodified records, the database will be entirely flushed to disk.
  • supybot.protocols
    • .irc
      • .strictRfc
        • Default: False
        • Channel Specific: False
        • Help: Determines whether the bot will strictly follow the RFC; currently this only affects what strings are considered to be nicks. If you're using a server or a network that requires you to message a nick such as services@this.network.server then you you should set this to False.
      • .umodes
        • Default: ""
        • Channel Specific: False
        • Help: Determines what user modes the bot will request from the server when it first connects. Many people might choose +i; some networks allow +x, which indicates to the auth services on those networks that you should be given a fake host.
      • .vhost
        • Default: ""
        • Channel Specific: False
        • Help: Determines what vhost the bot will bind to before connecting to the IRC server.
      • .maxHistoryLength
        • Default: 1000
        • Channel Specific: False
        • Help: Determines how many old messages the bot will keep around in its history. Changing this variable will not take effect until the bot is restarted.
      • .throttleTime
        • Default: 1.0
        • Channel Specific: False
        • Help: A floating point number of seconds to throttle queued messages -- that is, messages will not be sent faster than once per throttleTime seconds.
      • .ping
        • Default: True
        • Channel Specific: False
        • Help: Determines whether the bot will send PINGs to the server it's connected to in order to keep the connection alive and discover earlier when it breaks. Really, this option only exists for debugging purposes: you always should make it True unless you're testing some strange server issues.
        • .interval
          • Default: 120
          • Channel Specific: False
          • Help: Determines the number of seconds between sending pings to the server, if pings are being sent to the server.
      • .queueDuplicateMessages
        • Default: False
        • Channel Specific: False
        • Help: Determines whether the bot will allow duplicate messages to be queued for delivery to the server. This is a safety mechanism put in place to prevent plugins from sending the same message multiple times; most of the time it doesn't matter, but when it does, you'll probably want it to disallowed.
    • .http
      • .peekSize
        • Default: 4096
        • Channel Specific: False
        • Help: Determines how many bytes the bot will 'peek' at when looking through a URL for a doctype or title or something similar. It'll give up after it reads this many bytes, even if it hasn't found what it was looking for.
      • .proxy
        • Default: ""
        • Channel Specific: False
        • Help: Determines what proxy all HTTP requests should go through. The value should be of the form 'host:port'.
  • supybot.defaultIgnore
    • Default: False
    • Channel Specific: False
    • Help: Determines whether the bot will ignore unregistered users by default. Of course, that'll make it particularly hard for those users to register or identify with the bot, but that's your problem to solve.
  • supybot.externalIP
    • Default: ""
    • Channel Specific: False
    • Help: A string that is the external IP of the bot. If this is the empty string, the bot will attempt to find out its IP dynamically (though sometimes that doesn't work, hence this variable).
  • supybot.defaultSocketTimeout
    • Default: 10
    • Channel Specific: False
    • Help: Determines what the default timeout for socket objects will be. This means that *all* sockets will timeout when this many seconds has gone by (unless otherwise modified by the author of the code that uses the sockets).
  • supybot.pidFile
    • Default: ""
    • Channel Specific: False
    • Help: Determines what file the bot should write its PID (Process ID) to, so you can kill it more easily. If it's left unset (as is the default) then no PID file will be written. A restart is required for changes to this variable to take effect.
  • supybot.debug
    • .threadAllCommands
      • Default: False
      • Channel Specific: False
      • Help: Determines whether the bot will automatically thread all commands.
    • .flushVeryOften
      • Default: False
      • Channel Specific: False
      • Help: Determines whether the bot will automatically flush all flushers *very* often. Useful for debugging when you don't know what's breaking or when, but think that it might be logged.
    • .generated
      • Default: "$Id: conf.py,v 1.240 2005/01/18 21:08:07 jamessan Exp $; Tue Jan 18 16:10:05 2005"
      • Channel Specific: False
      • Help: Determines when this configuration file was generated; it should be modified by supybot-wizard
  • supybot.log
    • .format
      • Default: "%(levelname)s %(asctime)s %(name)s %(message)s"
      • Channel Specific: False
      • Help: Determines what the bot's logging format will be. The relevant documentation on the available formattings is Python's documentation on its logging module.
    • .level
      • Default: INFO
      • Channel Specific: False
      • Help: Determines what the minimum priority level logged will be. Valid values are VERBOSE, DEBUG, INFO, WARNING, ERROR, and CRITICAL, in order of increasing priority.
    • .statistics
      • Default: -1
      • Channel Specific: False
      • Help: Determines what level statistics reporting is to be logged at. Mostly, this just includes, for instance, the time it took to parse a message, process a command, etc. You probably don't care about this.
    • .timestampFormat
      • Default: "%Y-%m-%dT%H:%M:%S"
      • Channel Specific: False
      • Help: Determines the format string for timestamps in logfiles. Refer to the Python documentation for the time module to see what formats are accepted. If you set this variable to the empty string, times will be logged in a simple seconds-since-epoch format.
    • .stdout
      • Default: True
      • Channel Specific: False
      • Help: Determines whether the bot will log to stdout.
      • .colorized
        • Default: False
        • Channel Specific: False
        • Help: Determines whether the bot's logs to stdout (if enabled) will be colorized with ANSI color.
      • .wrap
        • Default: True
        • Channel Specific: False
        • Help: Determines whether the bot will wrap its logs when they're output to stdout.
      • .format
        • Default: "%(levelname)s %(asctime)s %(message)s"
        • Channel Specific: False
        • Help: Determines what the bot's logging format will be. The relevant documentation on the available formattings is Python's documentation on its logging module.
    • .plugins
      • .individualLogfiles
        • Default: False
        • Channel Specific: False
        • Help: Determines whether the bot will separate plugin logs into their own individual logfiles.
      • .format
        • Default: "%(levelname)s %(asctime)s %(message)s"
        • Channel Specific: False
        • Help: Determines what the bot's logging format will be. The relevant documentation on the available formattings is Python's documentation on its logging module.
  • supybot.capabilities
    • Default: -owner -admin -trusted
    • Channel Specific: False
    • Help: These are the capabilities that are given to everyone by default. If they are normal capabilities, then the user will have to have the appropriate anti-capability if you want to override these capabilities; if they are anti-capabilities, then the user will have to have the actual capability to override these capabilities. See docs/CAPABILITIES if you don't understand why these default to what they do.
    • .default
      • Default: True
      • Channel Specific: False
      • Help: Determines whether the bot by default will allow users to have a capability. If this is disabled, a user must explicitly have the capability for whatever command he wishes to run.


Valid HTML 4.01! Valid CSS! SourceForge.net Logo