This project has been retired. It did its job back in 2020 when we got a flood of emails and had to jump into Zoom meetings non-stop, but we have since moved on.
Thanks everyone for the feedback and good riddance.
CoronaBot is the bot doing a few things on a Discord server a friend set up to provide useful information (and comedy relief) during the COVID-19 pandemic of 2020 and beyond.
At the moment, it does the following things:
Forward emails sent to student mailing lists to a Discord text channel(borked and disabled)- Pin items to channels but reacting with 📌 (with code lifted from here)
- Keep deadlines in mind and notifies you shortly before it's due
- Sends out reminders with lecture times
You can suggest features by leaving an issue, or getting in touch with me via that certain Discord server I mentioned earlier.
At this stage, I want to rewrite it in TypeScript, but don't have to time to do that right now.
To get this going, nodejs and npm need to be installed. After that, the usual:
$ git clone [email protected]:thegreatrazz/coronication.git
$ cd coronication
$ npm install
$ npm startThe Discord bot token and other info needs to be saved to config.json. To start the bot (as a daemon), run npm start.
The example config will always be incomplete. Have fun debugging that.
Literally a JSON file with Discord.js activities.
| Class | Event Name | Year | Month | Date | Hour | Minute |
|---|---|---|---|---|---|---|
| COMP261 | Assignment 3 | 2020 | 5 | 17 | 23 | 59 |
| ... | ... | ... | ... | ... | ... | ... |
| Class | Event Name | Cron syntax time | Place |
|---|---|---|---|
| NWEN241 | Josh's Tutorial | 10 14 * * 5 |
NWEN241 Zoom |
| ... | ... | ... | ... |
This data file is not stored in the Git repo since it contains personal information I'd much rather not leak.
There is an example file which has some example data, but it's not used at runtime. You need to add the path to a real file to config.json.
| Name | Discord User ID | Cron syntax time | Birthday Message |
|---|---|---|---|
| Raresh | 69440080... | 0 11 20 4 * |
La Mulți Ani! |
This project uses the FreeBSD License. Feel free to use the source for whatever you want.