Limnoria/plugins/NickCapture
Valentin Lorentz 833af36b08 all plugins: auto-generate READMEs
Starting with this commit, there should be no "original" text
in READMEs.
Instead, the entire text should be in docstrings, and READMEs
should be automatically generated from these docstrings.

Motivation:

* The same help is available both via IRC and in the README
  (although the README can be more detailed, as only the first
  paragraph will be shown on IRC)
* This will allow auto-generating plugin help on docs.limnoria.net
  using the same content as the README, as it's sourced from the
  docstrings

Additionally, this converts all READMEs from Markdown to ReST,
because the documentation already uses ReST, and other docstrings
in the codebase are in ReST for this reason.
2021-04-05 17:42:31 +02:00
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01: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
README.rst all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
test.py Change the modeline to use softtabstop instead of tabstop. 2006-02-11 15:52:51 +00:00

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.