History

Aminda Suomalainen 4ed318d06f NickCapture: fix typo thus -> this		2023-10-16 21:10:34 +02:00
..
locales	NickCapture: fix typo thus -> this	2023-10-16 21:10:34 +02:00
README.rst	NickCapture: fix typo thus -> this	2023-10-16 21:10:34 +02:00
__init__.py	Revert generic 'The Limnoria Contributors' in copyright notices	2021-10-17 09:57:55 +02:00
config.py	Revert generic 'The Limnoria Contributors' in copyright notices	2021-10-17 09:57:55 +02:00
messages.pot	NickCapture: fix typo thus -> this	2023-10-16 21:10:34 +02:00
plugin.py	NickCapture: fix typo thus -> this	2023-10-16 21:10:34 +02:00
test.py	Revert generic 'The Limnoria Contributors' in copyright notices	2021-10-17 09:57:55 +02: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 this 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.