Skip to content

bsd-ac/karma-bot

Repository files navigation

build CodeQL Maintainability GitHub license GitHub issues contributions welcome

Karma Bot

Karma bot for Matrix, invite Banana-Bot:matrix.org to the channel.

Features

On top of standard features which parse messages of the form thanks <abcxyz>, this bot also supports a few more enhancements

  • Support message reactions:
    • positive emojis give karma: ❤️,👍️,💯,🍌,🎉,💞,💗,💓,💖,💘,💝,💕,😻,😍,❤️‍🔥
    • negative emojis reduce karma: 👎️,💔,😠,👿,🙁,☹️,🤬,☠️,💀
    • removing the reactions removes the karma contribution
  • Per room and global karma stats.
  • Ability to opt out/in of tracking: !optout, !optin

Commands

command notes
!karma [user] get karma of a user in a room, defaults to sender if user is not specified
!tkarma [user] get karma of a user across all rooms, defaults to sender if
user is not specified
!optin remove the sender from the karma tracking system (all votes
given to and by the sender are deleted and permanently lost)
!optout allow the sender to be tracked in the karma tracking system
(past events are not tracked)
!optstatus [user] check if a user has opted in/out of the karma tracking system,
defaults to sender if user is not specified
!uptime check how long the bot has been up

Usage

$ karma-bot -h
Usage of karma-bot:
  -d string
        debug level of output (debug, info, warn, error, dpanic, panic, fatal) (default "warn")
  -f string
        alternative configuration file (default "/etc/karma-bot.ini")
  -o string
        debug output format (console, json) (default "console")

The sample config file contains detailed explanations of options to configure.

Releases

No releases published

Packages

No packages published

Languages