History

Valentin Lorentz fec6959acb all plugins: regenerate READMEs		2021-04-22 00:29:15 +02:00
..
locales	Fix msgfmt warnings.	2020-03-26 22:10:28 +01:00
README.rst	all plugins: regenerate READMEs	2021-04-22 00:29:15 +02:00
__init__.py	Use importlib instead of imp.	2020-01-26 12:00:08 +01:00
config.py	Fix neutral pronouns.	2014-04-11 21:56:42 +00:00
messages.pot	PluginDownloader: update l10n-fi.	2014-03-22 16:38:16 +02:00
plugin.py	Use irc.isChannel instead of ircutils.isChannel when possible.	2019-08-04 21:52:40 +02:00
test.py	Change the modeline to use softtabstop instead of tabstop.	2006-02-11 15:52:51 +00:00

README.rst

Documentation for the NickCapture plugin for Supybot

Purpose

This module attempts to capture the bot's nick, watching for an opportunity to switch to that nick.

Usage

This plugin constantly tries to take whatever nick is configured as supybot.nick. Just make sure that's set appropriately, and thus plugin will do the rest.

Configuration

supybot.plugins.NickCapture.ison

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether the bot will check occasionally if its preferred nick is in use via the ISON command.

supybot.plugins.NickCapture.ison.period

This config variable defaults to "600", is not network-specific, and is not channel-specific.

Determines how often (in seconds) the bot will check whether its nick ISON.

supybot.plugins.NickCapture.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.