mirrors/untisbot-discord
1
0
Fork 0
mirror of https://github.com/bytedream/untisbot-discord.git synced 2025-05-09 12:15:09 +02:00
Code Issues Packages Projects Releases Wiki Activity

Added new commands + updated version to 1.2

Browse Source
This commit is contained in:
ByteDream 2020-12-15 20:45:39 +01:00
parent 246e130be9
commit 656a0bf7c8
1 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -22,21 +22,33 @@ To see all available commands and get infos about it, simply type `help`.
`<>` are required arguments, `[]` is optional.
Commands which everyone can execute:
| command | usage | example | default |
| --- | --- | --- | --- |
| `classes` | Displays all classes | `classes` | - |
| `departments` | Displays all departments / buildings | `departments` | - |
| `info` | Displays information about the bot | `info` | - |
| `help [command]` | Displays help to a given command | `help data` | - |
| `holidays` | Displays all holidays with their name, start and end date | `holidays` | - |
| `rooms` | Displays all rooms | `rooms` | - |
| `stats` | Displays a message with some stats (total cancelled lessons, etc.) | `stats` | - |
| `subjects` | Displays all subjects | `subjects` | - |
| `teachers` | Displays all teachers | `teachers` | - |
| `timetable [date] [class name]` | Displays the timetable for a specific date. As `date` you can use 3 formats. 1: Only the day (`12`); 2. Day and month (`13.04`); 3. Day, month and year (`31.12.2020`). Only works if data was set with the `data` command. If no date is given, the timetable for the current date is displayed. As `class name` you can use any class from your school. If class is not given, the class which was assigned in the `data` command is used | `timetable 11.11` | - |
Command which only a member with admin rights can execute:
| command | usage | example | default |
| --- | --- | --- | --- |
| `channel` | In the channel where this command is entered, the bot shows the timetable changes | `channel` | - |
| `clear` | Clears the given untis data, given from the `data` command | `clear` | - |
| `data <username> <password> <login page url> [class name]` | Sets the data with which the bot logs in to untis and checks for timetable changes. The data is stored encrypted on the server. `username` and `password` are the normal untis login data with which one also logs in to the untis website / app. To gain the login page url you have to go to webuntis.com, type in your school and choose it. Then you will be redirected to the untis login page, The url of this page is the login page url, for example `https://example.webuntis.com/WebUntis/?school=myschool#/basic/main`. `class name` is just the name of the class you want to check (eg. `12AB`). As `class name` you can use any class from your school. If it isn't specified, the bot tries to get the default class which is assigned to the given account. | `data myname secure https://example.webuntis.com/WebUntis/?school=example#/basic/main 12AB` | - |
| `info` | Displays information about the bot | `info` | - |
| `help [command]` | Displays help to a given command | `help data` | - |
| `language <language>` | Changes the language in which the timetable information are displayed. Currently only `de` (german) and `en` (english) are supported | `language de` | `en` |
| `prefix <new prefix>` | Changes the prefix with which commands are called | `prefix $` | `!untis ` |
| `stats` | Displays a message with some stats (total cancelled lessons, etc.) | `stats` | - |
| `start` | Starts the stopped timetable listener. Only works if data was set with the `data` command | `start` | - |
| `stop` | Stops timetable listening. Only works if data was set with the `data` command | `stop` | - |
| `timetable [date] [class name]` | Displays the timetable for a specific date. As `date` you can use 3 formats. 1: Only the day (`12`); 2. Day and month (`13.04`); 3. Day, month and year (`31.12.2020`). Only works if data was set with the `data` command. If no date is given, the timetable for the current date is displayed. As `class name` you can use any class from your school. If class is not given, the class which was assigned in the `data` command is used | `timetable 11.11` | - |
Note: All commands except for `help [command]`, `timetable [date] [class]` and `<stats>` can only be executed by a member with admin rights.
## Self-hosting
@ -67,7 +79,7 @@ When you run the bot manually you can choose from 2 types of data storage:
### In-memory storage
In memory data storage is pretty simple: Just download the [jar](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.1.1/UntisBot-1.1.1.jar) and run it with `java -jar UntisBot-<version>.jar token=<your discord bot token>`.
In memory data storage is pretty simple: Just download the [jar](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.2/UntisBot-1.2.jar) and run it with `java -jar UntisBot-<version>.jar token=<your discord bot token>`.
The simple things have unfortunately also often disadvantages: The user data is only stored as long as the bot is running. If you shut it down, all data will be lost.
If you want to keep the data even after a shutdown, you should use [database storage](#MariaDB).
@ -84,7 +96,7 @@ To set up the database, you have to execute the following command and replace `<
mysql -u <user> -p -e "CREATE DATABASE Untis; USE Untis; $(wget -qO- https://raw.githubusercontent.com/ByteDream/untisbot-discord/master/files/database.sql)"
```
Now you have set up the database and are ready to go. Download the [jar](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.1/UntisBot-1.1.1.jar) and run it with `java -jar UntisBot-<version>.jar <your discord bot token> mariadb`.
Now you have set up the database and are ready to go. Download the [jar](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.2/UntisBot-1.2.jar) and run it with `java -jar UntisBot-<version>.jar <your discord bot token> mariadb`.
## Run options
@ -171,7 +183,7 @@ If you want to add a language which isn't supported you can
- [Database client](https://github.com/mariadb-corporation/mariadb-connector-j) (mariadb java client)
- [Logger](https://github.com/qos-ch/logback) (logback-core and logback-classic)
**_Note_: The [UntisBot jar file](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.1.1/UntisBot-1.1.1.jar) and the [Dockerfile](Dockerfile) are containing all dependencies.**
**_Note_: The [UntisBot jar file](https://github.com/ByteDream/untisbot-discord/releases/tag/v1.2/UntisBot-1.2.jar) and the [Dockerfile](Dockerfile) are containing all dependencies.**
## License