Config
Documentation for the Config plugin for Supybot
Purpose
Handles configuration of the bot while it is running.
Commands
- channel [<channel>] <name>
[<value>]
If <value> is given, sets the channel configuration variable for <name> to <value> for <channel>. Otherwise, returns the current channel configuration value of <name>. <channel> is only necessary if the message isn't sent in the channel itself.
- config <name> [<value>]
If <value> is given, sets the value of <name> to <value>. Otherwise, returns the current value of <name>. You may omit the leading "supybot." in the name if you so choose.
- default <name>
Returns the default value of the configuration variable <name>.
- export <filename>
Exports the public variables of your configuration to <filename>. If you want to show someone your configuration file, but you don't want that person to be able to see things like passwords, etc., this command will export a "sanitized" configuration file suitable for showing publicly.
- help <name>
Returns the description of the configuration variable <name>.
- list <group>
Returns the configuration variables available under the given configuration <group>. If a variable has values under it, it is preceded by an
@sign. If a variable is aChannelValue, that is, it can be separately configured for each channel using thechannelcommand in this plugin, it is preceded by an#sign. - reload takes no arguments
Reloads the various configuration files (user database, channel database, registry, etc.).
- search <word>
Searches for <word> in the current configuration variables.
Configuration
- supybot.plugins.Config.public
This config variable defaults to True and is not channel specific.
Determines whether this plugin is publicly visible.