Skip to content

Supybot Website

Sections
Personal tools
You are here: Home » Documentation » Supybot Help Center » Tutorials » Configuring Supybot » Configuration Values

Configuration Values

Document Actions
How can I see what the values are and change them?

ali

A description of the basics involved in configuring your Supybot.
Page 4 of 9.

Okay, now that you've used the Config plugin to list configuration variables, it's time that we start looking at individual variables and their values.

The first (and perhaps most important) thing you should know about each configuration variable is that they all have an associated help string to tell you what they represent. So the first command we'll cover is config help. To see the help string for any value or group, simply use the config help command. For example, to see what this supybot.snarfThrottle configuration variable is all about, we'd do this:

  <jemfinch|lambda> @config help supybot.snarfThrottle
  <supybot> jemfinch|lambda: 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.  (Current value:
            10.0)

Pretty simple, eh?

Now, if you're curious what the current value of a configuration variable is, you'll use the config command with one argument, the name of the variable you want to see the value of:

  <jemfinch|lambda> @config supybot.reply.whenAddressedBy.chars
  <supybot> jemfinch|lambda: '@'

To set this value, just stick an extra argument after the name:

  <jemfinch|lambda> @config supybot.reply.whenAddressedBy.chars @$
  <supybot> jemfinch|lambda: The operation succeeded.

Now, check this out:

  <jemfinch|lambda> $config supybot.reply.whenAddressedBy.chars
  <supybot> jemfinch|lambda: '@$'

Note that we used $ as our prefix character, and that the value of the configuration variable changed. If I were to use the flush command now, this change would be flushed to the registry file on disk (this would also happen if I made the bot quit, or pressed Ctrl-C in the terminal the bot was running in). Instead, I'll revert the change:

  <jemfinch|lambda> $config supybot.reply.whenAddressedBy.chars @
  <supybot> jemfinch|lambda: The operation succeeded.
  <jemfinch|lambda> $note that this makes no response.

Created by ali
Last modified 19:00 February 06, 2005
 

Powered by Plone

This site conforms to the following standards: