Limnoria/plugins/Success
Valentin Lorentz db7ef3f025 all: Add generic 'The Limnoria Contributors' to copyright notices.
No need to bother with details (that are all outdated / out of sync
anyway), just look up the git history.
2021-08-01 21:54:49 +02:00
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01:00
__init__.py all: Add generic 'The Limnoria Contributors' to copyright notices. 2021-08-01 21:54:49 +02:00
config.py all: Add generic 'The Limnoria Contributors' to copyright notices. 2021-08-01 21:54:49 +02:00
messages.pot PluginDownloader: update l10n-fi. 2014-03-22 16:38:16 +02:00
plugin.py all: Add generic 'The Limnoria Contributors' to copyright notices. 2021-08-01 21:54:49 +02:00
README.rst all plugins: regenerate READMEs 2021-04-22 00:29:15 +02:00
test.py all: Add generic 'The Limnoria Contributors' to copyright notices. 2021-08-01 21:54:49 +02:00

Documentation for the Success plugin for Supybot

Purpose

The Success plugin spices up success replies by allowing custom messages instead of the default 'The operation succeeded.' message; like Dunno does for "no such command" replies.

Usage

This plugin was written initially to work with MoobotFactoids, the two of them to provide a similar-to-moobot-and-blootbot interface for factoids. Basically, it replaces the standard 'The operation succeeded.' messages with messages kept in a database, able to give more personable responses.

Commands

add [<channel>] <text>

Adds <text> to the success database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

change [<channel>] <id> <regexp>

Changes the success with id <id> according to the regular expression <regexp>. <channel> is only necessary if the message isn't sent in the channel itself.

get [<channel>] <id>

Gets the success with id <id> from the success database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

remove [<channel>] <id>

Removes the success with id <id> from the success database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

stats [<channel>]

Returns the number of successes in the database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

Configuration

supybot.plugins.Success.prefixNick

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

Determines whether the bot will prefix the nick of the user giving an invalid command to the success response.

supybot.plugins.Success.public

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

Determines whether this plugin is publicly visible.