mirror of https://github.com/Mikaela/Limnoria.git synced 2024-11-05 02:29:22 +01:00

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

3.4 KiB

Raw Blame History

Documentation for the Anonymous plugin for Supybot

Purpose

Allows folks to talk through the bot anonymously.

Usage

This plugin allows users to act through the bot anonymously. The 'do' command has the bot perform an anonymous action in a given channel, and the 'say' command allows other people to speak through the bot. Since this can be fairly well abused, you might want to set supybot.plugins.Anonymous.requireCapability so only users with that capability can use this plugin. For extra security, you can require that the user be in the channel they are trying to address anonymously with supybot.plugins.Anonymous.requirePresenceInChannel, or you can require that the user be registered by setting supybot.plugins.Anonymous.requireRegistration.

Example: Proving that you are the owner

When you ask for cloak/vhost for your bot, the network operators will often ask you to prove that you own the bot. You can do this for example with the following method:

@load Anonymous
@config plugins.anonymous.requirecapability owner
@config plugins.anonymous.allowprivatetarget True
@anonymous say <operator nick> Hi, my owner is <your nick> :)

This * Loads the plugin. * Makes the plugin require that you are the owner

If anyone could send private messages as the bot, they could also access network services.

Allows sending private messages
Sends message Hi, my owner is <your nick> :) to operator nick.
- Note that you won't see the messages that are sent to the bot.

Commands

do <channel> <action>: Performs <action> in <channel>.
react <channel> <reaction> <nick>: Sends the <reaction> to <nick>'s last message. <reaction> is typically a smiley or an emoji. This may not be supported on the current network, as this command depends on IRCv3 features. This is also not supported if supybot.protocols.irc.experimentalExtensions disabled (don't enable it unless you know what you are doing).
say <channel> <text>: Sends <text> to <channel>.
tell <nick> <text>: Sends <text> to <nick>. Can only be used if supybot.plugins.Anonymous.allowPrivateTarget is True.

Configuration

supybot.plugins.Anonymous.allowPrivateTarget

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

Determines whether the bot will allow the "tell" command to be used. If true, the bot will allow the "tell" command to send private messages to other users.

supybot.plugins.Anonymous.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.Anonymous.requireCapability

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

Determines what capability (if any) the bot should require people trying to use this plugin to have.

supybot.plugins.Anonymous.requirePresenceInChannel

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

Determines whether the bot should require people trying to use this plugin to be in the channel they wish to anonymously send to.

supybot.plugins.Anonymous.requireRegistration