hubot-good-karma

A simple karma script for hubot.

The script is called good karma because it only lets you give positive karma to people. You can give people karma and you can take away your karma, but you can't give negative karma.

hubot-good-karma uses fuzzy matching for names, so you can say things like "anish++" and "anish--" in chat to modify karma for the user "anishathalye.

Demo

Installation

In hubot project repo, run:

npm install hubot-good-karma --save

Then add hubot-good-karma to your external-scripts.json:

[
  "hubot-good-karma"
]

If you want to be able to change configuration settings from the chat without having to use environment variables, you should also install hubot-conf.

Usage

hubot-good-karma is pretty intuitive to use. Say "{user}++" to give someone karma, and say "{user}--" to take it away. You don't even have to say the full username because hubot-good-karma does fuzzy username matching.

Run the help command ({botname} help karma) in your chat to see more documentation.

Tips

• Take advantage of the HUBOT_KARMA_BLACKLIST_NAME setting to make things like saying "c++" not give random people karma.

Configuration

hubot-good-karma can be configured either using hubot-conf or environment variables. hubot-conf settings override environment variables.

For all of the settings below like HUBOT_SETTING_NAME, you can change the setting via chat by saying {botname} conf set setting.name "{new value}" (the setting name is mapped by skipping the HUBOT_ part, changing to lowercase, and replacing _ with .).

• HUBOT_KARMA_TOP - a number indicating how many people to show in the leaderboard. This setting defaults to 5.

• HUBOT_KARMA_BLACKLIST_ROOM - a comma-separated list of rooms where karma is disabled. This variable can also be left unset, which is the default.

• HUBOT_KARMA_BLACKLIST_NAME - comma-separated list of names for which karma is disabled. This variable can also be left unset, which is the default.

License

Copyright (c) 2017 Anish Athalye. Released under the MIT License. See LICENSE.md for details.