mirror of
https://github.com/progval/Limnoria.git
synced 2025-04-26 04:51:06 -05:00
63eb6672ea
This commit reverts db7ef3f02517f9f2a3c56829a22b9fad3c36e374 (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 db7ef3f02517f9f2a3c56829a22b9fad3c36e374 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.
.. _plugin-Limiter:
Documentation for the Limiter plugin for Supybot
================================================
Purpose
-------
This plugin sets channel limits (MODE +l) based on
``plugins.Limiter.MaximumExcess`` plus the current number of users
in the channel. This is useful to prevent flood attacks.
Usage
-----
In order to use this plugin, its config values need to be properly
setup. supybot.plugins.Limiter.enable needs to be set to True and
supybot.plugins.Limiter.{maximumExcess,minimumExcess} should be set to
values appropriate to your channel (if the defaults aren't satisfactory).
Once these are set, and someone enters/leaves the channel, Supybot will
start setting the proper +l modes.
.. _conf-Limiter:
Configuration
-------------
.. _conf-supybot.plugins.Limiter.enable:
supybot.plugins.Limiter.enable
This config variable defaults to "False", is network-specific, and is channel-specific.
Determines whether the bot will maintain the channel limit to be slightly above the current number of people in the channel, in order to make clone/drone attacks harder.
.. _conf-supybot.plugins.Limiter.maximumExcess:
supybot.plugins.Limiter.maximumExcess
This config variable defaults to "10", is network-specific, and is channel-specific.
Determines the maximum number of free spots that will be saved when limits are being enforced. This should always be larger than supybot.plugins.Limiter.limit.minimumExcess.
.. _conf-supybot.plugins.Limiter.minimumExcess:
supybot.plugins.Limiter.minimumExcess
This config variable defaults to "5", is network-specific, and is channel-specific.
Determines the minimum number of free spots that will be saved when limits are being enforced. This should always be smaller than supybot.plugins.Limiter.limit.maximumExcess.
.. _conf-supybot.plugins.Limiter.public:
supybot.plugins.Limiter.public
This config variable defaults to "True", is not network-specific, and is not channel-specific.
Determines whether this plugin is publicly visible.