Luna the friendly Discord bot

Luna is a friendly Discord bots with features for the online game Pokefarm Q.

Commands:

• /hug @user hug a user
• /pokerus mypfqusername tell luna your pfq username and get pings when you have pokerus. If your username changes, run this command again with your new username.
• /hyperbeam @user blast a hyperbeam at a user
• /setreminder set a reminder and receive a ping

Automatic features:

• If your guild has a channel #rus-alert, Luna announces the Pokérus host every 15 minutes

Testing luna

Tests are run against a real database. Run the following commands

1. Create a docker container bound to port 24019

docker container run -p 24019:5432 -e POSTGRES_HOST_AUTH_METHOD=trust -d --name luna-db postgres

2. Apply the migrations

migrate -source "file://./migrations" -database "postgres://postgres@localhost:24019/postgres?sslmode=disable" up

3. Run the tests

go test luna/operations

4. Create a config file and run luna

edit ~/.config/luna/config.toml

5. Run

go run .

Running luna

• Create a postgres database and apply migrations/init.sql
• Build the project with go build
• Create the config at one of these locations:
  • /etc/luna/config.toml
  • $XDG_CONFIG_HOME/luna/config.toml
  • $HOME/.config/luna/config.toml
  • $LUNA_CONFIG
• Run

Deploying luna

These deployment tips are intended for Linux.

This code snippet shows a systemd unit to launch Luna.

[Unit]
Description=Luna the friendly Discord Bot
Wants=network.target
After=network.target

[Service]
ExecStart=/path/to/luna\
	-app $APP_FROM_DISCORD_DEV_PORTAL\
	-token $TOKEN_FROM_DISCORD_DEV_PORTAL\
	-db 'user=mydbuser dbname=mydbname'\
	-hugdir '/path/to/folder/of/hug/gifs'\
	-server ':12345'\
	-pokeruslocktime 10
Restart=always
RestartSec=5

[Install]
WantedBy=default.target

Two of luna's commands should be run on schedules. Luna does not implement a scheduler. You need to make a HTTP request to localhost to run the respective job. You can use cron to schedule these jobs.

If you start Luna with -server 12345, check for the Pokerus host at ten seconds past :00, :15, :30, :45 each hour:

0,15,30,45 * * * * sleep 10 && curl 'localhost:12345/pokerus'

Developing luna

• To modify an existing command locate the files ./operations/$command.go and ./operations/$command_test.go and modify them accordingly.
• To create a new command create the files ./operations/$command and ./operations/$command_test.go where $command should match the Discord command that is executed. Register the new command in ./main.go
• To create a migration, use (example): ~/.go/bin/migrate create -dir migrations -ext sql -seq 6 add_settings
• To run Luna go run main.go -db "postgres://postgres@localhost:24019/postgres?sslmode=disable" -app MY_APP -token MY_TOKEN -pokerusserver ":12345"

Running luna with Docker

1. Download the project
2. There is a docker volume config in which you can create the file config.toml, it will be mounted at /etc/luna/config.toml in the luna container.
3. You can also conveniently place a directory of gifs for the hug command into the config volume
4. The luna container provides the migrate program to run migrations. You need to migrate them manually.

docker container exec luna-app-1 migrate -source file:///app/migrations -database 'postgres://luna@db:5432/postgres?sslmode=disable' up