reminder-bot/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
* `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__
* `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
Create README.md 2020-10-01 23:51:02 +00:00			`# reminder-rs`
Update README.md 2020-10-02 14:19:53 +00:00			`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)`

padded readme out. made python location configurable. made ignore_bots configurable. replaced max_message_length with serenity's provided constant 2020-10-12 18:12:33 +00:00			`### Compiling`
bumped to rc.7. embed avatar inside executable. nudge now outputs the current nudge when ran with no arguments 2020-10-23 21:23:43 +00:00			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.
padded readme out. made python location configurable. made ignore_bots configurable. replaced max_message_length with serenity's provided constant 2020-10-12 18:12:33 +00:00
fix for the del command not working properly 2020-10-25 17:39:39 +00:00			`#### Compilation environment variables`
			`These environment variables must be provided when compiling the bot`
			* `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

padded readme out. made python location configurable. made ignore_bots configurable. replaced max_message_length with serenity's provided constant 2020-10-12 18:12:33 +00:00			`### Setting up Python`
insert events on deleting a reminder 2020-10-14 15:08:26 +00:00			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
padded readme out. made python location configurable. made ignore_bots configurable. replaced max_message_length with serenity's provided constant 2020-10-12 18:12:33 +00:00
			`### 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
readded local_language config option 2020-10-12 21:43:02 +00:00			* `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)
moved around the consts so that default prefix env var isnt being read into the framework. made theme color configurable 2020-10-13 13:35:13 +00:00			* `THEME_COLOR` - default `8fb677`. Specifies the hex value of the color to use on info message embeds
added case insensitivity to commands 2020-10-22 09:31:47 +00:00			* `CASE_INSENSITIVE` - default `1`, if `1`, commands will be treated with case insensitivity (so both `$help` and `$HELP` will work)
use serenity from my repo. other minor improvements 2020-10-25 11:19:21 +00:00			* `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