3.1 KiB
The Karma plugin
Main commands
karma clear [<channel>] <name>
Resets the karma of <name> to 0.
karma 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.
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.
Maintenance
karma 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.
karma 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.
Configuration
supybot.plugins.Karma.allowSelfRating
Default value: False
Determines whether users can adjust the karma of their nick.
supybot.plugins.Karma.allowUnaddressedKarma
Default value: False
Determines whether the bot will increase/decrease karma without being addressed.
supybot.plugins.Karma.mostDisplay
Default value: 25
Determines how many karma things are shown when the most command is called.
supybot.plugins.Karma.rankingDisplay
Default value: 3
Determines how many highest/lowest karma things are shown when karma is called with no arguments.
supybot.plugins.Karma.response
Default value: False
Determines whether the bot will reply with a success message when something's karma is increased or decreased.
supybot.plugins.Karma.simpleOutput
Default value: False
Determines whether the bot will output shorter versions of the karma output when requesting a single thing's karma.
supybot.plugins.Karma.public
Default value: True
Determines whether this plugin is publicly visible.