Mikaela
/
Limnoria
mirror of https://github.com/Mikaela/Limnoria.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Karma: reword readme & mention the onlyNicks option 

[skip ci]
This commit is contained in:
James Lu 2017-09-20 21:46:38 -07:00
parent a870d02a27
commit 5e880fd73d
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
plugins/Karma/README.md
View File

@ -1,7 +1,7 @@
This will increase or decrease karma for the item.
This plugins tracks karma for users and things in channels.
If `config plugins.karma.allowUnaddressedKarma` is set to `True` (default since 2014.05.07), saying `boats++` will give 1 karma to `boats`, and `ships--` will subtract 1 karma from `ships`.
However, if you use this in a sentence, like `That deserves a ++. Kevin++`, 1 karma will be added to `That deserves a ++. Kevin`, so you should only add or subtract karma in a line that doesn't have anything else in it.
However, if you use this in a sentence, like `That deserves a ++. Kevin++`, 1 karma will be added to `That deserves a ++. Kevin`, so you should only add or subtract karma in a line that doesn't have anything else in it. Alternatively, you can restrict karma tracking to nicks in the current channel by setting `config plugins.Karma.onlyNicks` to `True`.
If `config plugins.karma.allowUnaddressedKarma` is set to `False`, you must address the bot with nick or prefix to add or subtract karma.