mirror of
https://github.com/Mikaela/Limnoria.git
synced 2024-12-27 05:03:07 +01:00
132 lines
4.3 KiB
ReStructuredText
132 lines
4.3 KiB
ReStructuredText
.. _plugin-AutoMode:
|
|
|
|
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``).
|
|
|
|
.. _conf-AutoMode:
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
.. _conf-supybot.plugins.AutoMode.alternativeCapabilities:
|
|
|
|
|
|
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.
|
|
|
|
.. _conf-supybot.plugins.AutoMode.ban:
|
|
|
|
|
|
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.
|
|
|
|
.. _conf-supybot.plugins.AutoMode.ban.period:
|
|
|
|
|
|
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.
|
|
|
|
.. _conf-supybot.plugins.AutoMode.delay:
|
|
|
|
|
|
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.
|
|
|
|
.. _conf-supybot.plugins.AutoMode.enable:
|
|
|
|
|
|
supybot.plugins.AutoMode.enable
|
|
This config variable defaults to "True", is network-specific, and is channel-specific.
|
|
|
|
Determines whether this plugin is enabled.
|
|
|
|
.. _conf-supybot.plugins.AutoMode.extra:
|
|
|
|
|
|
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
|
|
|
|
.. _conf-supybot.plugins.AutoMode.fallthrough:
|
|
|
|
|
|
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.
|
|
|
|
.. _conf-supybot.plugins.AutoMode.halfop:
|
|
|
|
|
|
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.
|
|
|
|
.. _conf-supybot.plugins.AutoMode.op:
|
|
|
|
|
|
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.
|
|
|
|
.. _conf-supybot.plugins.AutoMode.owner:
|
|
|
|
|
|
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.
|
|
|
|
.. _conf-supybot.plugins.AutoMode.public:
|
|
|
|
|
|
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.
|
|
|
|
.. _conf-supybot.plugins.AutoMode.voice:
|
|
|
|
|
|
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.
|
|
|