Popple

A karma bot for Discord.

Overview

• DEVELOPING.md is an introduction to the Popple architecture and hints on how to get started developing your feature or bug-fix.

• MANUAL.md is for learning how to deploy Popple.

• Popple has some additional configuration options. Run ./popple -help for more info. These are optional, but could be helpful for adapting Popple to better suit your needs.

Building

Clone or otherwise download the Popple source code and run:

$ go build ./...

The go toolchain should download the dependencies and build Popple.

Running

Popple requires a valid Discord bot token in order to interact with the Discord API.

$ echo -n "my super secret token" > popple_token
$ chmod 0600 popple_token

Then, once that one-time setup is complete:

$ ./popple -token /path/to/popple_token

Usage

Command	Values	Description
@Popple announce	on, off, yes, no	Whether or not Popple will print a subject's karma level after it has been modified
@Popple karma	Something with karma	Prints the subjects' karma level. Multiple subjects' karma levels may be checked
@Popple bot	Integer > 0	Prints the n subjects with the least karma. The default value is 10 if a value is not supplied
@Popple top	Integer > 0	Prints the top n subjects with the most karma. The default value is 10 if a value is not supplied
Subject++	N/A	Increases Subject's karma
Subject--	N/A	Decreases Subject's karma
(Subject with space or - +)	N/A	Parentheses may be used for complicated subjects with whitespace or special symbols

Once Popple has joined a Discord server, it will watch for karma events in the chat. Increase or decrease karma by suffixing the subject with a ++ or a --, respectively.

For example,

Person) Thanks for being so neat, Popple++!
Popple) Popple has 1 karma.

Popple will ignore "net-zero" operations on karma.

Person) Popple++ Popple--

*crickets*

A message can have any number of karma events for any number of subjects:

Person) PoeThePotatoPirate++ Popple-- HelloWorld--
Popple) PoeThePotatoPirate has 2 karma. Popple has 3 karma. HelloWorld has -2 karma.

Parentheses may be used for more complicated karma subjects, including those with whitespace, ticks, or other parentheses in their name.

Person) (Poe the Potato Pirate)++ (meme-bot)++
Popple) Poe the Potato Pirate has 2 karma. meme-bot has 2 karma.

Karma levels can be checked without requiring any karma events:

Person) @Popple karma Popple
Popple) Popple has 3 karma.
Person) @Popple karma DoesNotExist
Popple) DoesNotExist has 0 karma.

The above could be combined into one command like so:

Person) @Popple karma Popple DoesNotExist
Popple) Popple has 3 karma. DoesNotExist has 0 karma.

By default, Popple will announce a subject's karma level after it is modified. This behavior can be disabled. Karma levels may still be checked with the karma command.

Person) @Popple announce off
Person) Person++

*crickets*

Or

Person) @Popple announce no
Person) Person++

*crickets*

It can be turned back on with @Popple announce yes or @Popple announce on.