2020-12-03 19:33:01 +00:00
|
|
|
# Untis Bot
|
|
|
|
Simple bot that notifies you of timetable changes on Discord.
|
|
|
|
|
|
|
|
# Setup
|
|
|
|
- Clone the repository and CD into it
|
|
|
|
- `sudo npm install -g typescript` if you haven't already
|
2020-12-03 19:37:04 +00:00
|
|
|
- Use `npm install` to automatically install all dependencies
|
2020-12-03 19:33:01 +00:00
|
|
|
- Type `tsc` to compile
|
|
|
|
- Create a `.env` file in the project's root with the following content:
|
2020-12-03 19:35:22 +00:00
|
|
|
- SCHOOLNAME=Your school's name
|
|
|
|
- USERNAME=Your username
|
|
|
|
- PASSWORD=Your password
|
|
|
|
- BASEURL=Your school's Untis URL, for example mese.webuntis.com
|
|
|
|
- BOT_TOKEN=Discord bot token
|
|
|
|
- CHANNEL=The channel ID that the bot sends messages to. Only supports DM channels right now.
|
2020-12-03 19:33:01 +00:00
|
|
|
- `node dist/index.js` to run the bot. You can use tools like `pm2` to automate starting and stopping.
|