Mikaela
/
Limnoria
mirror of https://github.com/Mikaela/Limnoria.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Limnoria/plugins/AutoMode
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 Remove Spanish translations as requested by the author 2021-06-24 22:36:04 -07:00
README.rst all plugins: regenerate READMEs 2021-04-22 00:29:15 +02: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 Squashed commit of the following: 2014-12-20 14:37:27 +01:00
plugin.py Revert generic 'The Limnoria Contributors' in copyright notices 2021-10-17 09:57:55 +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 AutoMode plugin for Supybot

Purpose

Automatically ops, voices, or halfops, or bans people when they join a channel, according to their capabilities. If you want your bot automatically op users when they join your channel, this is the plugin to load.

Usage

This plugin, when configured, allows the bot to automatically set modes on users when they join.

  • if plugins.automode.op is set to True, users with the #channel,op capability are opped when they join.
  • if plugins.automode.halfop is set to True, users with the #channel,halfop are halfopped when they join.
  • if plugins.automode.voice is set to True, users with the #channel,voice are voiced when they join.

This plugin also kbans people on @channel ban list (config plugins.automode.ban) when they join and if moding users with lower capability is enabled, that is also applied to users with higher capability (config plugins.automode.fallthrough).

Configuration

supybot.plugins.AutoMode.alternativeCapabilities

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

Determines whether the bot will check for 'alternative capabilities' (ie. autoop, autohalfop, autovoice) in addition to/instead of classic ones.

supybot.plugins.AutoMode.ban

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

Determines whether the bot will automatically ban people who join the channel and are on the banlist.

supybot.plugins.AutoMode.ban.period

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

Determines how many seconds the bot will automatically ban a person when banning.

supybot.plugins.AutoMode.delay

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

Determines how many seconds the bot will wait before applying a mode. Has no effect on bans.

supybot.plugins.AutoMode.enable

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

Determines whether this plugin is enabled.

supybot.plugins.AutoMode.extra

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

Extra modes that will be applied to a user. Example syntax: user1+o-v user2+v user3-v

supybot.plugins.AutoMode.fallthrough

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

Determines whether the bot will "fall through" to halfop/voicing when auto-opping is turned off but auto-halfopping/voicing are turned on.

supybot.plugins.AutoMode.halfop

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

Determines whether the bot will automatically halfop people with the <channel>,halfop capability when they join the channel.

supybot.plugins.AutoMode.op

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

Determines whether the bot will automatically op people with the <channel>,op capability when they join the channel.

supybot.plugins.AutoMode.owner

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

Determines whether this plugin will automode owners even if they don't have op/halfop/voice/whatever capability.

supybot.plugins.AutoMode.public

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

Determines whether this plugin is publicly visible.

supybot.plugins.AutoMode.voice

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

Determines whether the bot will automatically voice people with the <channel>,voice capability when they join the channel.