Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-25 20:29:23 +01:00
Code Issues Projects Releases Wiki Activity
cd02444f87
Limnoria/plugins/Protector
History
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 all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
config.py Protector: disable by default. 2014-05-03 16:11:18 +03:00
messages.pot Squashed commit of the following: 2014-12-20 14:37:27 +01:00
plugin.py all plugins: Use msg.channel instead of msg.args[0] + give network name to self.registryValue. 2019-08-24 23:35:01 +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

README.rst

Documentation for the Protector plugin for Supybot

Purpose

Defends a channel against actions by people who don't have the proper capabilities, even if they have +o or +h.

Usage

Prevents users from doing things they are not supposed to do on a channel, even if they have +o or +h.

Configuration

supybot.plugins.Protector.enable

This config variable defaults to "False", is network-specific, and is channel-specific.

Determines whether this plugin is enabled in a given channel.

supybot.plugins.Protector.immune

This config variable defaults to " ", is network-specific, and is channel-specific.

Determines what nicks the bot will consider to be immune from enforcement. These nicks will not even have their actions watched by this plugin. In general, only the ChanServ for this network will be in this list.

supybot.plugins.Protector.public

This config variable defaults to "True", is not network-specific, and is not channel-specific.

Determines whether this plugin is publicly visible.