jude/reminder-bot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity
Reminder Bot for Discord, now in Rust
137 Commits 19 Branches 4 Tags 36 MiB
CSS 43.5%
Rust 34.6%
TypeScript 13%
JavaScript 8.1%
SCSS 0.4%
Other 0.4%
44d06e4298
Go to file
jellywx 44d06e4298 silent mentioning for roles in reminders
2020-12-15 23:03:41 +00:00
.idea added a missing table to create.sql 2020-11-08 15:37:56 +00:00
regex_command_attr removed standard_framework completely 2020-10-26 11:10:00 +00:00
src silent mentioning for roles in reminders 2020-12-15 23:03:41 +00:00
.gitignore new language manager that loads strings from compiled json file 2020-11-21 16:48:20 +00:00
1.3.0-changelog silent mentioning for roles in reminders 2020-12-15 23:03:41 +00:00
Cargo.lock help command rework started 2020-11-30 16:06:05 +00:00
Cargo.toml help command rework started 2020-11-30 16:06:05 +00:00
create.sql added a missing table to create.sql 2020-11-08 15:37:56 +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 removed all remaining instances of UserData::response. languagemanager now loads from string compiled into executable. languagemanager falls back properly. removed unnecessary param from language_of 2020-11-22 01:31:50 +00:00

README.md

reminder-rs

Reminder Bot for Discord, now in Rust. Old Python version: https://github.com/reminder-bot/bot

What is this?

This is a rewrite of Reminder Bot in Rust, using Serenity and SQLx amongst other libraries.

Why is this?

Serenity and Rust are proving wonders for SoundFX. This is all in an effort to reduce resource consumption and improve performance.

How do I use it?

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
  • STRINGS_FILE - accepts the name of a compiled strings file located in $CARGO_MANIFEST_DIR/assets/ to be used for creating messages. Compiled string files can be generated with compile.py at https://github.com/reminder-bot/languages

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

  • LOCAL_TIMEZONE - default UTC, necessary for calculations in the natural language processor
  • DEFAULT_PREFIX - default $, used for the default prefix on new guilds
  • 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
  • IGNORE_BOTS - default 1, if 1, Reminder Bot will ignore all other bots
  • PYTHON_LOCATION - default venv/bin/python3. Can be changed if your Python executable is located somewhere else
  • LOCAL_LANGUAGE - default EN. Specifies the string set to fall back to if a string cannot be found (and to be used with new users)
  • THEME_COLOR - default 8fb677. Specifies the hex value of the color to use on info message embeds
  • CASE_INSENSITIVE - default 1, if 1, commands will be treated with case insensitivity (so both $help and $HELP will work)
  • SHARD_COUNT - default None, accepts the number of shards that are being ran
  • SHARD_RANGE - default None, if SHARD_COUNT is specified, specifies what range of shards to start on this process