Limnoria/plugins/NickCapture/README.rst

.. _plugin-NickCapture:

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.
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:29:49 +02:00			`.. _plugin-NickCapture:`

			`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.`