Skip to content

Supybot Website

Sections
Personal tools
You are here: Home » Documentation » Official Plugins Documentation » Config

Config

Document Actions

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 a ChannelValue, that is, it can be separately configured for each channel using the channel command 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.

Created by jamessan
Last modified 19:15 July 25, 2005
News
Oops!
Jun 29, 2007 @ 16:24
We need a Supybot logo!
Jan 18, 2005 @ 03:59
Recent Plugin Releases
IdleRPG 1.1.2
Jun 13, 2008 @ 04:34
QGoogle 0.2.0
Apr 30, 2008 @ 12:13
QGoogle 0.1-r1
Apr 27, 2008 @ 08:25
Ompload 1.0
Apr 11, 2008 @ 22:08
Bunneh 1.0
Mar 21, 2008 @ 21:50
 
 

Powered by Plone

This site conforms to the following standards: