mirror of
https://github.com/Mikaela/Limnoria-doc.git
synced 2025-02-17 14:00:43 +01:00
65 lines
1.4 KiB
ReStructuredText
65 lines
1.4 KiB
ReStructuredText
|
|
||
|
|
.. _plugin-karma:
|
||
|
|
|
||
|
|
The Karma plugin
|
||
|
|
================
|
||
|
|
|
||
|
|
.. command-load:
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-dump:
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-die:
|
||
|
|
|
||
|
|
die
|
||
|
|
^^^^
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
.. command-clear:
|
||
|
|
|
||
|
|
clear [<channel>] <name>
|
||
|
|
^^^^^^^^^^^^^^^^^^^^^^^^
|
||
|
|
|
||
|
|
Resets the karma of *<name>* to 0.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-most:
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
|
||
|
|
.. command-karma:
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
|