Skip to content

pgsvox/bot

 
 

Repository files navigation

Reminder Bot

A bot for doing reminders

Installing

Deps:

  • Python 3.6+
  • MySQL 8+
  • pymysql, discord.py==1.2.2j, pytz, dateparser, sqlalchemy, sqlalchemy-json
  • Rust 1.31 with Cargo (for compilation only)

Optional Deps:

  • Mypy (for static type checking if modifying code)

Running:

  • Ensure the languages folder has your desired language files (a git submodule init should get all of them from the official repo, or check https://github.com/reminder-bot/languages for specifics)
  • Log into MySQL and execute
CREATE DATABASE reminders;
  • Create file config.ini in the same location as main.py
  • Fill it with the following stub:
[DEFAULT]
token =
dbl_token =
patreon_server =
patreon_enabled = no
strings_location = ./languages/

[MYSQL]
user = 
;passwd =
host = localhost
database = reminders
DISCORD_TOKEN="auth token as above"
SQL_URL="mysql://user:passwd@localhost/reminders"
INTERVAL=15
THREADS=1

N: You can change INTERVAL to be higher for less CPU usage or lower for reminders that are more on time. Any value less than 15 is fairly excessive; the live bot uses 5. Modifying the THREADS value is NOT recommended. This increases the amount of threads used for sending reminders. If you're sending many reminders in a single interval, increase this value. The live bot uses 1.

  • Run the release binary in ./target/release alongside the python file.

About

The bot core

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 94.6%
  • TSQL 4.6%
  • Mako 0.8%