Updated docs

Sven Heidemann 2023-01-14 01:43:01 +01:00
parent f79feda586
commit 61e8435ef4

@ -28,9 +28,11 @@ ODER
### Begriffe
Autor: Das Mitglied, welches den Befehl geschickt hat Member: Ein Mitglied auf dem Server WarnungsId: Id einer Warnung Modul: Ein Teil-System des Bots. (database, level, filter)
Autor: Das Mitglied, welches den Befehl geschickt hat Member: Ein Mitglied auf dem Server WarnungsId: Id einer Warnung
Modul: Ein Teil-System des Bots. (database, level, filter)
MitgliedAttribut: Ein Attribut eines Mitglieds (ontime, xp)
ontime: Die Zeit, die das Mitglied in einem Sprachkanal verbracht hat xp: Nummer anhand welcher das Level bestimmt wird logins: Ein Eintrag, wenn ein Mitglied dem Server
ontime: Die Zeit, die das Mitglied in einem Sprachkanal verbracht hat xp: Nummer anhand welcher das Level bestimmt wird
logins: Ein Eintrag, wenn ein Mitglied dem Server
beigetreten ist warnings: Eine Verwarnung (z.B. Regelverstoß)
kicks: Ein Eintrag, wenn ein Mitglied gekickt wurde bans: Alle Bans des Mitglieds
@ -48,25 +50,25 @@ 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 |
| 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" |
### Auto Role
Befehle der Gruppe /auto-role
| Befehl | Berechtigungen | Parameter | Beschreibung |
|--------|----------------|-----------------------------------|-------------------------------------------------------------|
| list | Moderator | wait: int? | Listet alle AutoRoles auf |
| 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 |
| Befehl | Berechtigungen | Parameter | Beschreibung |
|--------|----------------|-----------------------------------|-------------------------------------------|
| list | Moderator | wait: int? | Listet alle AutoRoles auf |
| 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 |
Befehle der Gruppe /auto-role rule
@ -80,26 +82,29 @@ 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 |
| remove | 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 |
|--------|----------------|---------------------------------------|-----------------------------------------------------------------------------------------------------------------------|
| 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 |
### Level
Befehle der Gruppe /level
| Befehl | Berechtigungen | Parameter | Beschreibung |
|---------|----------------|---------------------------------------------------------|---------------------------------------------------------------------------------------------|
| list | Moderator | wait: int? | Listet alle Level auf |
| create | Admin | name: str, color: str, min_xp: int, permissions: int | Erstellt ein Level & die Rolle anhand des Levels. Das Levelsystem wird danach neu geladen |
| edit | Admin | name: str, color: str?, min_xp: int?, permissions: int? | Bearbeitet das Level, indem die Werte gesetzt werden, welche als Parameter übergeben werden |
| remove | Admin | level: str | Löscht ein Level. Das Levelsystem wird danach neu geladen |
| 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 |
| Befehl | Berechtigungen | Parameter | Beschreibung |
|--------|----------------|---------------------------------------------------------|---------------------------------------------------------------------------------------------|
| list | Moderator | wait: int? | Listet alle Level auf |
| create | Admin | name: str, color: str, min_xp: int, permissions: int | Erstellt ein Level & die Rolle anhand des Levels. Das Levelsystem wird danach neu geladen |
| edit | Admin | name: str, color: str?, min_xp: int?, permissions: int? | Bearbeitet das Level, indem die Werte gesetzt werden, welche als Parameter übergeben werden |
| remove | Admin | level: str | Löscht ein Level. Das Levelsystem wird danach neu geladen |
| 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 |
### Techniker
@ -123,12 +128,12 @@ Befehle der Gruppe /stats
### Noch geplante Befehle
| Berechtigungen | Befehl | Parameter | Beschreibung |
|----------------|----------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
| 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 |
| Berechtigungen | Befehl | Parameter | Beschreibung |
|----------------|----------------|---------------|---------------------------------------------|
| 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 |