Forgot your password?
New user?
Karma
Document Actions
Documentation for the Karma plugin for Supybot
Purpose
Plugin for handling Karma stuff for a channel.
Commands
- clear [<channel>] <name>
Resets the karma of <name> to 0.
- 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.
- karma [<channel>] [<thing> ...]
Returns the karma of <text>. If <thing> is not given, returns the top three and bottom three karmas. 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.
- 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.
- 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.
Configuration
- supybot.plugins.Karma.public
This config variable defaults to True and is not channel specific.
Determines whether this plugin is publicly visible.
- supybot.plugins.Karma.simpleOutput
This config variable defaults to False and is channel specific.
Determines whether the bot will output shorter versions of the karma output when requesting a single thing's karma.
- supybot.plugins.Karma.response
This config variable defaults to False and is channel specific.
Determines whether the bot will reply with a success message when something's karma is increased or decreased.
- supybot.plugins.Karma.rankingDisplay
This config variable defaults to 3 and is channel specific.
Determines how many highest/lowest karma things are shown when karma is called with no arguments.
- supybot.plugins.Karma.mostDisplay
This config variable defaults to 25 and is channel specific.
Determines how many karma things are shown when the most command is called.'
- supybot.plugins.Karma.allowSelfRating
This config variable defaults to False and is channel specific.
Determines whether users can adjust the karma of their nick.
- supybot.plugins.Karma.allowUnaddressedKarma
This config variable defaults to False and is channel specific.
Determines whether the bot will increase/decrease karma without being addressed.
How to add or steal karma
Oops!
