Blink Reminder Bot

A simple Discord bot that reminds users to blink every once in a while.

Setup

You'll need to host your own instance of this bot in order to use it.

1. Download Node.JS LTS.
2. Clone or download this repo.
3. Set up the .env file as detailed below.
4. Open a terminal and cd into the folder where you've cloned the repository.
5. Run npm i.
6. Run npm start:dev.

Creating a .env file

You will need to create a .env file in the root folder with the following format:

DISCORD_TOKEN=your-bot-token-here
CLIENT_ID=your-client-id-here
PROD=false

You'll need to set up a bot application to get a token and client ID by following the instructions here.

The prod flag

In the .env file, PROD is false by default, which means the bot will run using nodemon. For production, I suggest using the PM2 package to manage the bot. To launch the bot using PM2, first follow the installation instructions for PM2 (but don't run the PM2 command!) here. Then, change the PROD flag in .env to true. Finally, run npm start.

Usage

• /reminders on to turn on blink reminders
• /reminders off to turn off blink reminders
• /setinterval <number in minutes> to change how often you get reminded
• /status to see if your reminders are on/off and what the interval is set to
• You get reminded every (interval) minutes provided you're either online or dnd - if you go idle/offline and then come back, the timer gets reset
• You can use the bot in the #bot-commands channel in Weedlandz or in a DM. Regardless of where you use it, other people can't see the commands that you issue