jude/reminder-bot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 3 Wiki Activity
Reminder Bot for Discord, now in Rust
79 Commits 19 Branches 4 Tags 35 MiB
CSS 44%
Rust 33.9%
TypeScript 13.1%
JavaScript 8.1%
SCSS 0.4%
Other 0.4%
55e388b01a
Go to file
jude 55e388b01a dp.py now statically built into the output binary
2020-10-13 14:53:44 +01:00
.idea natural command stuff 2020-09-26 22:23:41 +01:00
regex_command_attr changed Args to String because we dont need that 2020-08-10 22:12:26 +01:00
src dp.py now statically built into the output binary 2020-10-13 14:53:44 +01:00
.gitignore removed .cargo config from repo 2020-10-12 22:44:37 +01:00
Cargo.lock fixed a lot of message formatting that had been ignored 2020-10-11 01:42:19 +01:00
Cargo.toml made strings table name configurable 2020-10-12 23:17:47 +01:00
create.sql changed permission chekc to be more manual since built in one isnt working 2020-10-11 18:56:27 +01: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 moved around the consts so that default prefix env var isnt being read into the framework. made theme color configurable 2020-10-13 14:35:13 +01: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.

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 python-venv and run python -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