Limnoria-doc/use/plugins/karma.rst

65 lines
1.4 KiB
ReStructuredText
Raw Normal View History

2011-06-28 08:11:32 +02:00
.. _plugin-karma:
The Karma plugin
================
2011-06-28 08:13:53 +02:00
.. _command-load:
2011-06-28 08:11:32 +02:00
load [<channel>] <filename>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Loads the Karma database for *<channel>* from *<filename>* in the bot's
data directory. *<channel>* is only necessary if the message isn't sent
in the channel itself.
2011-06-28 08:13:53 +02:00
.. _command-dump:
2011-06-28 08:11:32 +02:00
dump [<channel>] <filename>
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Dumps the Karma database for *<channel>* to *<filename>* in the bot's
data directory. *<channel>* is only necessary if the message isn't sent
in the channel itself.
2011-06-28 08:13:53 +02:00
.. _command-die:
2011-06-28 08:11:32 +02:00
die
^^^^
2011-06-28 08:13:53 +02:00
.. _command-clear:
2011-06-28 08:11:32 +02:00
clear [<channel>] <name>
^^^^^^^^^^^^^^^^^^^^^^^^
Resets the karma of *<name>* to 0.
2011-06-28 08:13:53 +02:00
.. _command-most:
2011-06-28 08:11:32 +02:00
most [<channel>] {increased,decreased,active}
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the most increased, the most decreased, or the most active
(the sum of increased and decreased) karma things. *<channel>* is only
necessary if the message isn't sent in the channel itself.
2011-06-28 08:13:53 +02:00
.. _command-karma:
2011-06-28 08:11:32 +02:00
karma [<channel>] [<thing> ...]
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Returns the karma of *<thing>*. If *<thing>* is not given, returns the top
N karmas, where N is determined by the config variable
supybot.plugins.Karma.rankingDisplay. If one *<thing>* is given, returns
the details of its karma; if more than one *<thing>* is given, returns
the total karma of each of the the things. *<channel>* is only necessary
if the message isn't sent on the channel itself.