From bd32568f62fe0c82fb68f95adecb21c934fcae47 Mon Sep 17 00:00:00 2001 From: codey Date: Fri, 22 Nov 2024 01:12:00 +0000 Subject: [PATCH] Create Karma --- Karma.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 Karma.md diff --git a/Karma.md b/Karma.md new file mode 100644 index 0000000..1da94d8 --- /dev/null +++ b/Karma.md @@ -0,0 +1,32 @@ +# karma + +##### Access: Public +----- + +This command is part of the karma system, described in further detail below. + +----- + +Usage: `/karma [keyword]` or `.karma [keyword]` + +`keyword` is optional. If provided, the bot will provide the score for the keyword specified. If not provided, the bot will list the top 10 karma keywords. + +---- + +## Karma System + +Havoc watches for messages globally to pick out those that match the below patterns: + +- `keyword`++ +- `keyword`-- + +When keyword++ is seen, Havoc will increase the karma score of `keyword` by 1. +Conversely, when keyword-- is seen, Havoc will decrease the karma score of `keyword` by 1. + +Rate limiting is in place. Multiple keywords in one message are supported, eg: + +`keyword1++ keyword--` will result in the karma score of `keyword1` being increased, and `keyword2` being decreased. If the same keyword is specified more than once in the same message, only the first instance will be considered to prevent cheating. + +Mentions are flattened - the display name of the tagged/mentioned user will be used to allow `@user++` to function. + +