Fixed command doku

Sven Heidemann 2023-10-12 18:03:35 +02:00
parent f6b9f3e44a
commit a26823e523

@ -50,17 +50,58 @@ Guild: Discord Server
### 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 |
| mass-move | | | Verschiebt alle Mitglieder von einen Sprachkanal in einen anderen |
| ping | | | Sendet eine einfache Antwort, um zu überprüfen ob der Bot reagiert |
| purge | Moderator | | Löscht alle nachrichten aus dem Kanal, indem der Befehl geschickt wurde |
| presence | Moderator | text: str | Setzt das Spiel, welches der Bot gerade "Spielt" |
| 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 |
### Auto Role
### Game server
| Befehl | Berechtigungen | Parameter | Beschreibung |
|--------------|----------------|--------------------------------|---------------------------------------------------------------------------------|
| list | Moderator | | Listet alle Gameserver des Discord Servers auf |
| add | Admin | name: str,<br/>api_key_id: int | Fügt einen Gameserver hinzu |
| remove | Admin | id: int | Entfernt einen Gameserver |
| list-members | Moderator | id: int | Listet alle Mitglieder, welche für einen bestimmten Gameserver registriert sind |
### Register
Befehle der Gruppe /register
| Befehl | Berechtigungen | Parameter | Beschreibung |
|-----------|----------------|-----------------------------------------------------|-----------------------------------------------------------------|
| minecraft | Moderator | member: Member,<br/>game_server: int,<br/>name: str | Verknüpft das Mitglied mit dem Spielerprofil auf dem Gameserver |
### Unregister
| Befehl | Berechtigungen | Parameter | Beschreibung |
|------------|----------------|--------------------------------------|-----------------------------------------------------------------------------------|
| unregister | Moderator | member: Member,<br/>game_server: int | Löscht die Verknüpfung zwischen Mitglied und dem Spielerprofil auf dem Gameserver |
### Submit
Befehle der Gruppe /submit
| Befehl | Berechtigungen | Parameter | Beschreibung |
|-----------|----------------|-----------|---------------------------------------------------------|
| complaint | | | Nimmt eine Beschwerde auf und teilt diese dem Team mit |
| bug | | | Nimmt einen Bug auf und teilt diese den Entwicklern mit |
### Achievement
Befehle der Gruppe /submit
| Befehl | Berechtigungen | Parameter | Beschreibung |
|--------|----------------|----------------|---------------------------------------------------------------|
| check | Moderator | member: Member | Überprüft, ob das Mitglied neue Errungenschaften erreicht hat |
### Auto role
Befehle der Gruppe /auto-role
@ -70,6 +111,8 @@ Befehle der Gruppe /auto-role
| add | Moderator | channel: Channel, message_id: str | Erstellt eine AutoRole für eine Nachricht |
| remove | Moderator | auto_role: int | Löscht die AutoRole anhand der Id |
#### Auto role rule
Befehle der Gruppe /auto-role rule
| Befehl | Berechtigungen | Parameter | Beschreibung |
@ -82,14 +125,18 @@ Befehle der Gruppe /auto-role rule
Befehle der Gruppe /user
| Befehl | Berechtigungen | Parameter | Beschreibung |
|--------|----------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| info | Keine | member: Member? | Gibt alle Werte des gegebenen Mitglieds aus |
| get | Keine | 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 |
| 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 |
### Level
@ -104,7 +151,13 @@ Befehle der Gruppe /level
| up | Moderator | member: Member | Erhöht das Level des Mitglieds auf das nächst höhere |
| down | Moderator | member: Member | Verringert das Level des Mitglieds auf das nächst niedrigere |
| set | Moderator | level: str, user: Member | Setzt das Level des Mitglieds auf das gegebene Level |
| reload | Moderator | | Lädt das Levelsystem neu |
| reload | Moderator | | Lädt das Levelsystem neu |
#### Short role name
| Befehl | Berechtigungen | Parameter | Beschreibung |
|-----------------------|----------------|-----------|------------------------------------------------------------------------------|
| short-role-name-check | Moderator | | Überprüft ob alle Rollen Kürzel bei allen Mitgliedern richtig gesetzt wurden |
### Techniker
@ -114,17 +167,20 @@ Befehle der Gruppe /level
| restart | Techniker | | Startet den Bot neu |
| log | Techniker | dateFrom: str?, dateTo? | Schickt ein ZIP-Paket mit den angefragten Logs darin |
### Statistik
#### Api Key
Befehle der Gruppe /stats
| Befehl | Berechtigungen | Parameter | Beschreibung |
|--------|----------------|----------------------|---------------------------------------------|
| get | Techniker | key: str, wait: int? | Gibt den Schlüssel für einen API-Key zurück |
| add | Techniker | identifier: str | Fügt einen API-Key hinzu |
| remove | Techniker | key: str | Entfernt einen API-Key |
| Befehl | Berechtigungen | Parameter | Beschreibung |
|--------|----------------|-----------------------|-------------------------------------------------|
| list | Moderator | wait: int? | Listet alle Statistiken auf |
| view | Moderator | name: str, wait: int? | Führt die Statistik mit dem gegebenen Namen aus |
| add | Techniker | name: str | Fügt eine Statistik hinzu |
| edit | Techniker | name: str | Bearbeitet die gegebene Statistik |
| remove | Techniker | name: str | Löscht die Statistik mit dem gegebenen Namen |
#### Sync xp
| Befehl | Berechtigungen | Parameter | Beschreibung |
|-------------|----------------|-------------------------------------|-------------------------------------------------------------------------------------|
| all_members | Techniker | server_id: int | Übernimmt die XP aller Mitglieder von einem anderen Server, sofern diese größer ist |
| by_member | Techniker | server_id: int,<br/>,member: Member | Übernimmt die XP für ein Mitglied von einem anderen Server, sofern diese größer ist |
### Noch geplante Befehle
@ -132,8 +188,5 @@ Befehle der Gruppe /stats
|----------------|----------------|---------------|---------------------------------------------|
| Moderator | filter-list | | Zeigt die Filterliste |
| Moderator | filter-add | Wort | Fügt ein Begriff zur Filterliste hinzu |
| Moderator | warning-show | Mitglied | Zeigt alle Verwarnungen für ein Mitglied |
| Moderator | warning-add | Mitglied Text | Fügt eine Verwarnung für das Mitglied hinzu |
| Moderator | warning-remove | WarnungsId | Entfernt die gegebene Verwarnung |
| Admin | filter-remove | Wort | Entfernt einen Begriff aus der Filterliste |
| Admin | filter-clear | | Leert die Filterliste |