Package: helga-karma
.. image:: https://travis-ci.org/coddingtonbear/helga-karma.png?branch=master:target: https://travis-ci.org/coddingtonbear/helga-karmaHelga Karma===========Modeled after `PMXBot <https://bitbucket.org/yougov/pmxbot>`_'s karma plugin,but just a little bit better.Commands--------``!t[hanks] <nickname>``++++++++++++++++++++++++Thank somebody for doing a good job!Example::youthere> I've just fitzbangled the horsemonster for you, person.person>   !thanks youtherehelga>    You're doing good work, youthere!Also has an alias -- ``!m[otivate]`` -- for situations in which somebodyhasn't yet done the thing you're appreciative of or otherwise justneeds motivation::youthere> I'm having an awful day; I've orangeenveloped thetwinkleverse like a dozen times so far and it's not evennoon!somebody> !m youtherehelga>    You're doing good work, youthere!somebody> It'll be OK, buddy; it's Friday.The people you've thanked (or motivated) will get a little bump in theirkarma (and that bump is variable depending on the ratio of times you --the thanker -- have thanked others vs. the number of times you've beenthanked).``!k[arma] [details] [for] [<nick>]``+++++++++++++++++++++++++++++++++++++Get a user's Karma information.Example::person> I wonder how much karma I have.person> !karmahelga>  person has about 24 karma, person.You can also ask about another person's karma::person> I wonder how much karma somebody has.person> !karma somebodyhelga>  somebody has about 10 karma, person.And, if you're curious about the details, you can ask for those, too, andeven abbreviate the command itself::person> I wonder if somebody has every thanked anybody in his life.person> !k details somebodyhelga>  somebody has 10.1 karma.  (thanked others 20 times, receivedthanks 12 times, karma coefficient: 0.6, aliases: adam,coddingtonbear)``!k[arma] top [10]``+++++++++++++++++++++Get a list of people ordered by how much karma they have.Example::person> Let's see who's the most helpful around here.person> !karma top 3helga> #1: somebody (2213 karma) | #2: somebody_else (2013 karma) |#3: whoisthis (1408 karma)person> Not me :-(``!k[arma] alias <nick1> <nick2>``+++++++++++++++++++++++++++++Link two nicknames together to share the same karma values.  This is commonlyused for away nicknames.Example::person> !karma coddingtonbear==coddingtonbear_awayhelga>  coddingtonbear and coddingtonbear_away are now linked, person.``!k[arma] unalias <nick1> <nick2>``+++++++++++++++++++++++++++++Unlink two nicknames from one another.Example::person> !karma coddingtonbear!=coddingtonbear_awayhelga>  coddingtonbear and coddingtonbear_away are now unlinked, person.Settings--------``KARMA_MESSAGE_OVERRIDES``+++++++++++++++++++++++++++You can override the existing messages by adding dictionary entries tothis dictionary matching the name of existing messages.See ``helga_karma.plugin.MESSAGES`` for existing messages.The following example changes the default 'info_none' message from"I'm not aware of {for_nick} having done anything helpful, {nick}." toone that is slightly less polite::KARMA_MESSAGE_OVERRIDES = {'info_none': '{for_nick} is useless, {nick}'}``KARMA_VALUE_NAME``++++++++++++++++++++Set this to a string to replace the word 'karma' in all messages.To make helga-karma behave more like MeowMeowBeenz, you would addthe following setting::KARMA_VALUE_NAME='MeowMeowBeenz'``KARMA_COEFFICIENT_NAME``++++++++++++++++++++++++++Set this to a string to replace the word 'karma coefficient' in the detailedper-user karma report.To make helga-karma behave more like MeowMeowBeenz, you could add thefollowing setting::KARMA_COEFFICIENT_NAME='5 Factor'``KARMA_SCALED_RANGE``++++++++++++++++++++++Set this to a 2-tuple of values between which all users' karma should becontinuously distributed.To make helga-karma behave more like MeowMeowBeenz (in which allusers have karma values ranging between one and five), you couldadd the following setting::KARMA_SCALED_RANGE=(1, 5)``KARMA_SCALE_LINEAR``++++++++++++++++++++++Set this to a truthy value to scale karma linearly.  By default, karma willbe scaled logarithmically across the range::KARMA_SCALE_LINEAR=True``KARMA_THANKS_WORDS``++++++++++++++++++++++Set this to a list of "thanks" words that will be used for automatic karma.This will mean that messages like ``thanks helga`` or ``tyvm helga`` willboth give automatic karma. Default values for this are: 'thank you', 'thanks','tyvm', and 'ty'.