Improved command docs

Sven Heidemann 2024-01-18 17:52:37 +01:00
parent 1664e95b6c
commit c528831a8d

@ -7,11 +7,19 @@
- [Datentypen](#datentypen)
- [Befehle](#befehle)
- [Allgemein](#allgemein)
- [Auto Role](#auto-role)
- [Game server](#game-server)
- [Register](#register)
- [Unregister](#unregister)
- [Submit](#submit)
- [Achievement](#achievement)
- [Auto role](#auto-role)
- [Auto role rule](#auto-role-rule)
- [User](#user)
- [Level](#level)
- [Short role name](#short-role-name)
- [Techniker](#techniker)
- [Statistik](#statistik)
- [Api Key](#api-key)
- [Sync xp](#sync-xp)
- [Noch geplante Befehle](#noch-geplante-befehle)
Um einen Befehl auszuführen, muss man eine Nachricht einen Text-Kanal (vorzugsweise in einen für Bot Befehle) schicken.
@ -53,16 +61,16 @@ Parameter mit einem ```?``` sind optionale Parameter.
### Allgemein
| Befehl | Berechtigungen | Parameter | Beschreibung |
|-------------|----------------|-------------------------------------------------|---------------------------------------------------------------------------------|
| afk | | | Verschiebt den Autor in den AFK Kanal. Der Autor muss in einem Sprachkanal sein |
| help | | | Gibt den Link dieser Seite aus |
| info | | | Gibt allgemeine Informationen über den Bot aus |
| make-coffee | | | Sendet ein Gif von Kaffee |
| mass-move | Moderator | channel_to: Channel,<br/>channel_from: Channel? | Verschiebt alle Mitglieder von einen Sprachkanal in einen anderen |
| ping | | | Sendet eine einfache Antwort, um zu überprüfen ob der Bot reagiert |
| presence | Moderator | text: str | Setzt das Spiel, welches der Bot gerade "Spielt" |
| purge | Moderator | | Löscht alle nachrichten aus dem Kanal, indem der Befehl geschickt wurde |
| Befehl | Berechtigungen | Parameter | Beschreibung |
|-------------|----------------|-------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| afk | | member: Member? | Verschiebt den Autor oder das angegebene Mitglied in den AFK Kanal. Um ein Mitglied angeben zu können, muss man Moderator sein alternativ muss der Autor in einem Sprachkanal sein |
| help | | | Gibt den Link dieser Seite aus |
| info | | | Gibt allgemeine Informationen über den Bot aus |
| make-coffee | | | Sendet ein Gif von Kaffee |
| mass-move | Moderator | channel_to: Channel,<br/>channel_from: Channel? | Verschiebt alle Mitglieder von einen Sprachkanal in einen anderen |
| ping | | | Sendet eine einfache Antwort, um zu überprüfen ob der Bot reagiert |
| presence | Moderator | text: str | Setzt das Spiel, welches der Bot gerade "Spielt" |
| purge | Moderator | | Löscht alle nachrichten aus dem Kanal, indem der Befehl geschickt wurde |
### Game server
@ -128,18 +136,18 @@ Befehle der Gruppe /auto-role rule
Befehle der Gruppe /user
| Befehl | Berechtigungen | Parameter | Beschreibung |
|----------|----------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| birthday | | day: int, month: int, year: int | Speichert das Geburtsdatum des Autors |
| info | | member: Member? | Gibt alle Werte des gegebenen Mitglieds aus |
| get | | member: Member?, atr: str | Gibt den Wert des gegebenen Attributes aus. Wird kein Mitglied angegeben, wird der Autor genutzt |
| set | Moderator | member: Member?, atr: str | Setzt den Wert des gegebenen Attributes auf den gegebenen Wert. Wird kein Mitglied angegeben, wird der Autor genutzt |
| add | Moderator | member: Member?, value: int, atr: str | Addiert den gegebenen Wert auf den Wert des gegebenen Attributes |
| remove | Moderator | member: Member?, value: int, atr: str | Subtrahiert den gegebenen Wert von den Wert des gegebenen Attributes |
| reset | Moderator | member: Member?, atr: str | Setzt den Wert des gegebenen Attributes auf den Standard zurück. Wird kein Mitglied angegeben, wird der Autor genutzt |
| show | Moderator | member: Member, wait: int? | Zeigt alle Verwarnungen für ein Mitglied |
| add | Moderator | member: Member, description: str | Fügt eine Verwarnung für das Mitglied hinzu |
| remove | Moderator | warning_id: int | Entfernt die angegebene Verwarnung |
| Befehl | Berechtigungen | Parameter | Beschreibung |
|----------------|----------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| birthday | | day: int, month: int, year: int | Speichert das Geburtsdatum des Autors |
| info | | member: Member? | Gibt alle Werte des gegebenen Mitglieds aus |
| get | | member: Member?, atr: str | Gibt den Wert des gegebenen Attributes aus. Wird kein Mitglied angegeben, wird der Autor genutzt |
| set | Moderator | member: Member?, atr: str | Setzt den Wert des gegebenen Attributes auf den gegebenen Wert. Wird kein Mitglied angegeben, wird der Autor genutzt |
| add | Moderator | member: Member?, value: int, atr: str | Addiert den gegebenen Wert auf den Wert des gegebenen Attributes |
| remove | Moderator | member: Member?, value: int, atr: str | Subtrahiert den gegebenen Wert von den Wert des gegebenen Attributes |
| reset | Moderator | member: Member?, atr: str | Setzt den Wert des gegebenen Attributes auf den Standard zurück. Wird kein Mitglied angegeben, wird der Autor genutzt |
| warning show | Moderator | member: Member, wait: int? | Zeigt alle Verwarnungen für ein Mitglied |
| warning add | Moderator | member: Member, description: str | Fügt eine Verwarnung für das Mitglied hinzu |
| warning remove | Moderator | warning_id: int | Entfernt die angegebene Verwarnung |
### Level