Limnoria/plugins/NickCapture
Valentin Lorentz 63eb6672ea Revert generic 'The Limnoria Contributors' in copyright notices
This commit reverts db7ef3f025
(though it keeps the year updates)

After discussion with several people, it seems better to mention
copyright owners explicitly. eg. https://reuse.software/faq/#vcs-copyright
explains the issue of using VCSs to track copyright.

As db7ef3f025 only replaced mentions
of my name with 'The Limnoria Contributors', this commit only needs
to undo that + add one person who contributed to setup.py.
2021-10-17 09:57:55 +02:00
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01: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 PluginDownloader: update l10n-fi. 2014-03-22 16:38:16 +02:00
plugin.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +02:00
README.rst all plugins: regenerate READMEs 2021-04-22 00:29:15 +02:00
test.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +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.

.. _conf-NickCapture:

Configuration
-------------

.. _conf-supybot.plugins.NickCapture.ison:


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.

  .. _conf-supybot.plugins.NickCapture.ison.period:


  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.

.. _conf-supybot.plugins.NickCapture.public:


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.