kryszak/pythagors

Discord bot for "cyferki" channel game

Pythagors

Rewrite of cyferki-watcher-bot in Rust to use shuttle deployments.

Rules

Game rules can be found in Rules

Required bot Privileged Gateway Intents

• Message Content Intent

Required bot user permissions

• Manage Roles ⚠️ Bot's role must be higher than any role that it sets for this feature to work ⚠️
• Read Messages/View Channels
• Send Messages
• Manage Messages

local dev config

Tools

Make sure that rust toolset is up to date.

rustup update

Shuttle plugin for cargo is required for building, running and deployment of bot

cargo install cargo-shuttle

Config

In main project directory create Secrets.toml file with following contents:

CLIENT_TOKEN="" # bot token
WATCHED_CHANNEL="test1" # name of channel to watch
WRONG_INCREMENT_MESSAGE_TEMPLATE="{{author}} learn learn to count" # Content of message sent, when user posts wrong number
WRONG_FORMAT_MESSAGE_TEMPLATE="{{author}} read game rules - message was not correct" # Content of message sent, when user posts message in wrong format
RANK_WON_MESSAGE_TEMPLATE="{{author}}, congratulations on winning rank {{role}}!" # Content of message sent, when user posts message with number winning role 
GAME_OVER_MESSAGE_TEMPLATE="Game over! Thanks for playing" # Content of message sent on last number
RANKS='{"10": "973271221112291409", "15": "973282436047839262"}' # JSON with number - rankId entries
GAME_OVER_NUMBER="16" # Number, on which game will end as a string

Config placeholders

• {{author}} will be substituted with mention to message's author
• {{role}} will be substituted with mention to won role

Run project locally

cargo shuttle run

Deploy to shuttle

cargo shuttle project new # only if project does not exist yet
cargo shuttle project start
cargo shuttle deploy

Secrets are populated initially from Secrets.toml file and can be edited with cargo shuttle secrets command.

Stop deployment

cargo shuttle project stop

pythagors's Issues

Do not allow to edit messages

If someone edits previously correct message it might breaks the bot's behaviour, so bot should not allow users to edit messages in watched channel.

Use references of single instance of structs instead of creating new ones

There should be single instance of structs created for bot and they should be passed as reference to others that require them instead of creating new ones/cloning them.

Adjust log format

Shuttle registers it's own tracing subscriber which blocks creating own one like here: https://docs.rs/tracing-subscriber/latest/tracing_subscriber/fmt/fn.fmt.html

Log format should be adjusted to include thread names instead of target names.

Add graceful shutdown

Currently on terminating bot process locally it does not logout bot user immediately, on shuttle it stays on even if deployment is stopped.

App should close connections as shown with shard manager here

Possible solutions:

• serenict_ctrl_c
• tokio_graceful_shutdown

Use toml array of objects format for defining prized numbers instead of JSON string

Currently pythagors takes prizes numbers from raw JSON string from secrets, i.e.

RANKS='{"10": 973271221112291409, "15": 973282436047839262}' # JSON with number - rankId entries

TOML format supports arrays and tables and pythagors should parse prizes from more readable format, like:

RANKS = [ 
    { number = 10, rankId = 973271221112291409 },
    { number = 15, rankId = 973282436047839262}
]

Reference:
https://toml.io/en/v1.0.0#array