Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-19 08:59:27 +01:00
Code Issues Projects Releases Wiki Activity
63eb6672ea
Limnoria/plugins/Limiter
History
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

README.rst

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.

Configuration

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.

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.

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.

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.