Chipbot is an IRC bot that tracks karma of users. Karma is a stat tracked just for fun - if you see someone say something funny or interesting, "++" them! You can also "--" if you're feeling salty...
Chipbot is an offshoot of Bamboo. Original Bamboo source can be found here.
To run Chipbot in debug mode, the following syntax is recommended:
python bot.py -n "uniqueusername" -c "#uniquechannel" -d
And the bot will join #uniquechannel as uniqueusername on esper.net. All messages received will be printed to the terminal.
pattern modules will also be required, which can be installed via pip:
pip install argparse pip install pattern
All pull requests for anything at all are welcome. Chipbot is the product of its creators. To increase the likelihood of your branch being merged, please try to ensure that it is based off master, and GitHub gives it the "ready to merge" status.
Karma is awarded to users that are presently in the channel. Points can also be awarded to phrases. The differences between the two primarily revolve around the fact that if the object directly to the left of the operator (++/--) is a user, then only the user will be awarded points, whereas phrases can be separated by spaces and the entire word will be awarded points.
Incrementing Karma (User)
- any arbitrary words [user]++
result: [user] will get +1 karma
Incrementing Points (Phrase)
- any arbitrary words++
result: "any arbitrary words" will get +1 point
Incrementing Karma/Points (Inline)
- any++ arbitrary++ [user]++
result: "any" will get +1 point, "arbitrary" will get +1 point, and [user] will get +1 karma
Checking karma/points rank
- .ranks [user]
result: information on the top 5 users and phrases
Stats are kept track of for each user that sends messages to the channel. That is, every time a user speaks a counter specifically for them is incremented. This keeps track of who is speaking the most in the channel.
- .stats [user]
result: information about the top 5 speakers in the channel, or information on specific user
Quality is calculated by dividing a user's karma by the number of times they've spoken, and multiplying that by 100. This gives a metric for the "quality" of a user's posts (i.e. what percent of them are "good")
- .quality [user]
Generosity tracks which users are giving the most karma using the ++ commands. Every time a user issues such a command, their generosity value increases. If a user issues the -- command, their generosity will decrease. This information will give a metric of who is using the system the most to increase other user's karma.
- .generosity [user]
Sometimes it is annoying to be mentioned in the above "leaderboard" style commands. The following command is a workaround that will "scramble" one's username so that they won't be notified in IRC.
- chipbot: scramble
Chipbot is able to search a few different sites, including xkcd, youtube, and bandcamp. It will report the top result, including a link, to the channel. More can be added if requested.
- .yt [search terms]
- .xkcd [search terms]
- .bc [search terms]
- .sc [search terms]
Chipbot is able to remember single-line quotes.
Add a quote:
- .quote [quote]
Post a quote:
- .getquote (random)
- .getquote [# of quote]
Chipbot can now keep track of different user nicks. Registering an alias takes two separate commands: .addalias and .confirmalias. .addalias is used on your main nick to declare that you want to register a new alias. .confirmalias is used on your newly declared alias to confirm it as an official alias of your main nick.
Declaring an alias:
- Example: (Nick is Hoodie) .addalias PresidentHoodie
Confirming an alias:
- Example: (Nick is PresidentHoodie) .confirmalias Hoodie
If you want to stop associating an alias with your nick, log into the alias and use .resetalias
Reset an alias:
Chipbot can now use EMOTIONS. To make chipbot display some EMOTIONS use .emote
If you see weird characters instead of EMOTIONS, you'll need to change your font. Monospace and Sans are guaranteed to work, though results may vary.