jude/reminder-bot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity
Reminder Bot for Discord, now in Rust
249 Commits 19 Branches 4 Tags 35 MiB
CSS 44%
Rust 33.9%
TypeScript 13.1%
JavaScript 8.1%
SCSS 0.4%
Other 0.4%
06c4deeaa9
Go to file
jude 06c4deeaa9 component models
2022-02-19 22:11:21 +00:00
migration ..... 2022-02-11 20:03:53 +00:00
postman component models 2022-02-19 22:11:21 +00:00
src component models 2022-02-19 22:11:21 +00:00
web component models 2022-02-19 22:11:21 +00:00
.gitignore removed IDE files 2021-03-21 14:19:52 +00:00
Cargo.lock everything except component model actions 2022-02-19 18:21:11 +00:00
Cargo.toml everything except component model actions 2022-02-19 18:21:11 +00:00
dp.py natural command stuff 2020-09-26 22:23:41 +01:00
LICENSE Create LICENSE 2020-09-21 09:16:10 +00:00
README.md extracted event handler. removed custom sharding code. extracted util functions 2022-02-19 13:28:24 +00:00
Rocket.toml ..... 2022-02-11 20:03:53 +00:00
rustfmt.toml more commands. fixed an issue with text only commands 2021-09-11 00:14:23 +01:00

README.md

reminder-rs

Reminder Bot for Discord.

How do I use it?

We offer a hosted version of the bot. You can invite it with: https://invite.reminder-bot.com. The catch is that repeating reminders are paid on the hosted version of the bot. Keep reading if you want to host it yourself.

You'll need rustc and cargo for compilation. To run, you'll need Python 3 still (due to no suitable replacement for dateparser in Rust)

Compiling

Reminder Bot can be built by running cargo build --release in the top level directory. It is necessary to create a folder called 'assets' containing an image file with its name specified in the environment as WEBHOOK_AVATAR, of dimensions 128x128px to be used as the webhook avatar.

Compilation environment variables

These environment variables must be provided when compiling the bot

  • DATABASE_URL - the URL of your MySQL database (mysql://user[:password]@domain/database)
  • WEBHOOK_AVATAR - accepts the name of an image file located in $CARGO_MANIFEST_DIR/assets/ to be used as the avatar when creating webhooks. IMPORTANT: image file must be 128x128 or smaller in size

Setting up Python

Reminder Bot by default looks for a venv within it's working directory to run Python out of. To set up a venv, install python3-venv and run python3 -m venv venv. Then, run source venv/bin/activate to activate the venv, and do pip install dateparser to install the required library

Environment Variables

Reminder Bot reads a number of environment variables. Some are essential, and others have hardcoded fallbacks. Environment variables can be loaded from a .env file in the working directory.

Required Variables

  • DATABASE_URL - the URL of your MySQL database (mysql://user[:password]@domain/database)
  • DISCORD_TOKEN - your application's bot user's authorization token

Other Variables

  • MIN_INTERVAL - default 600, defines the shortest interval the bot should accept
  • LOCAL_TIMEZONE - default UTC, necessary for calculations in the natural language processor
  • SUBSCRIPTION_ROLES - default None, accepts a list of Discord role IDs that are given to subscribed users
  • CNC_GUILD - default None, accepts a single Discord guild ID for the server that the subscription roles belong to
  • PYTHON_LOCATION - default venv/bin/python3. Can be changed if your Python executable is located somewhere else
  • THEME_COLOR - default 8fb677. Specifies the hex value of the color to use on info message embeds
  • DM_ENABLED - default 1, if 1, Reminder Bot will respond to direct messages

Todo List

  • Convert aliases to macros