Mikaela/Limnoria
1
0
Fork 0
mirror of https://github.com/Mikaela/Limnoria.git synced 2024-12-25 12:12:54 +01:00
Code Issues Projects Releases Wiki Activity
b0cdf474a8
Limnoria/plugins/Praise
History
Valentin Lorentz cd02444f87 supybot-plugin-doc: Add labels for all command and config variables 
So they can be referenced from elsewhere in the doc.
2021-04-06 00:33:07 +02:00
..
locales Fix msgfmt warnings. 2020-03-26 22:10:28 +01:00
__init__.py Use importlib instead of imp. 2020-01-26 12:00:08 +01:00
config.py Fix neutral pronouns. 2014-04-11 21:56:42 +00:00
messages.pot PluginDownloader: update l10n-fi. 2014-03-22 16:38:16 +02:00
plugin.py all plugins: auto-generate READMEs 2021-04-05 17:42:31 +02:00
README.rst supybot-plugin-doc: Add labels for all command and config variables 2021-04-06 00:33:07 +02:00
test.py Praise: make tests channel specific 2015-05-15 17:04:03 -07:00

README.rst

Documentation for the Praise plugin for Supybot

Purpose

Hand out praise to IRC denizens with this plugin.

Usage

Praise is a plugin for ... well, praising things. Feel free to add your own flavor to it by customizing what praises it gives. Use "praise add <text>" to add new ones, making sure to include "$who" in <text> where you want to insert the thing being praised.

Example:

  • If you add hugs $who
  • Someone says @praise ChanServ.
  • * bot hugs ChanServ

Commands

add [<channel>] <text>

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

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

Changes the praise 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 praise with id <id> from the praise database for <channel>. <channel> is only necessary if the message isn't sent in the channel itself.

praise [<channel>] [<id>] <whowhat> (for <reason>, if given). If <id> is given, uses that specific praise. <channel> is only necessary if the message isn't sent in the channel itself.

remove [<channel>] <id>

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

search [<channel>] [--{regexp,by} <value>] [<glob>]

Searches for praises matching the criteria given.

stats [<channel>]

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

Configuration

supybot.plugins.Praise.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.Praise.showIds

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

Determines whether the bot will show the ids of a praise when the praise is given.