Added new commands docs
parent
c2c9507423
commit
58a6df303e
154
Befehle.md
154
Befehle.md
@ -1,25 +1,34 @@
|
||||
# Befehle
|
||||
|
||||
Befehle werden in drei Gruppen unterschieden:
|
||||
## Inhaltsverzeichnis
|
||||
|
||||
- [Einfache Befehle](#einfache-befehle)
|
||||
- [Moderator Befehle](#moderator-befehle)
|
||||
- [Admin Befehle](#admin-befehle)
|
||||
- [Begriffserklärung](#begriffserklärung)
|
||||
- [Begriffe](#begriffe)
|
||||
- [Datentypen](#datentypen)
|
||||
- [Befehle](#befehle)
|
||||
- [Allgemein](#allgemein)
|
||||
- [Auto Role](#auto-role)
|
||||
- [User](#user)
|
||||
- [Level](#level)
|
||||
- [Techniker](#techniker)
|
||||
- [Statistik](#statistik)
|
||||
- [Noch geplante Befehle](#noch-geplante-befehle)
|
||||
|
||||
[Hier](#geplante-befehle) kannst du dir die geplanten Befehle anschauen.
|
||||
|
||||
Dabei können die [Einfachen Befehle](#einfache-befehle) von jedem ausgeführt werden, [Moderator Befehle](#moderator-befehle) jedoch nur von leuten mit dem Rollen ```Moderator```
|
||||
& ```Admin```. [Admin Befehle](#admin-befehle) dienen zur Verwaltung des Bots sowie der Verwaltung der Module, diese können wie der Name suggeriert nur von leuten mit der
|
||||
Rolle ```Admin``` ausgeführt werden.
|
||||
|
||||
Um einen Befehl auszuführen, muss man eine Nachricht einen Text-Kanal (vorzugsweise in einen für Bot Befehle) schicken.
|
||||
|
||||
Diese muss wie folgt aufgebaut sein:
|
||||
|
||||
!k BEFEHL PARAMETER1 PARAMETER2
|
||||
!k BEFEHL PARAMETER1 PARAMETER2 ...
|
||||
ODER
|
||||
/BEFEHL PARAMETER1 PARAMETER2 ...
|
||||
ODER
|
||||
/GRUPPE BEFEHL PARAMETER1 PARAMETER2 ...
|
||||
|
||||
## Begriffserklärung
|
||||
|
||||
### 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)
|
||||
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
|
||||
@ -28,44 +37,101 @@ kicks: Ein Eintrag, wenn ein Mitglied gekickt wurde bans: Alle Bans des Mitglied
|
||||
|
||||
Parameter mit einem ```?``` sind optionale Parameter.
|
||||
|
||||
## Einfache Befehle
|
||||
### Datentypen
|
||||
|
||||
| Befehl | Parameter | Beschreibung |
|
||||
|--------|-----------|---------------------------------------------------------------------------------|
|
||||
| afk | | Verschiebt den Autor in den AFK Kanal. Der Autor muss in einem Sprachkanal sein |
|
||||
| info | | Gibt allgemeine Informationen über den Bot aus |
|
||||
| ping | | Sendet eine einfache Antwort, um zu überprüfen ob der Bot reagiert |
|
||||
int: Ganzzahlen
|
||||
str: Text
|
||||
Member: Discord Mitglied
|
||||
Channel: Discord Kanal
|
||||
Guild: Discord Server
|
||||
|
||||
## Moderator Befehle
|
||||
## Befehle
|
||||
|
||||
| Befehl | Parameter | Beschreibung |
|
||||
|-----------|-----------|-------------------------------------------------------------------------------------------------------------|
|
||||
| user-info | Member | Gibt alle Informationen über das angegebene Mitglied. Wurde kein Mitglied gegeben, wird der Autor verwendet |
|
||||
| purge | | Löscht alle Nachrichten aus dem Kanal, in dem der Befehl geschickt wurde |
|
||||
### Allgemein
|
||||
|
||||
## Admin Befehle
|
||||
| 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 | Parameter | Beschreibung |
|
||||
|----------|------------|------------------|
|
||||
| Noch | Keine | Vorhanden |
|
||||
|
||||
## Geplante Befehle
|
||||
### Auto Role
|
||||
|
||||
| Typ | Befehl | Parameter | Beschreibung |
|
||||
|------------|----------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| Einfach | get | MitgliedAttribut | Gibt dir den gespeicherten Wert des gegebenen Attributes |
|
||||
| Moderator | mm | Kanal? Kanal | Verschiebt alle Mitglieder von einen Kanal in den anderen Kanal. Ist nur ein Kanal gegeben, wird der Kanal aus Quelle genutzt, in dem der Autor sitzt |
|
||||
| Moderator | filter-list | | Zeigt die Filterliste |
|
||||
| Moderator | filter-add | Wort | Fügt ein Begriff zur Filterliste hinzu |
|
||||
| Moderator | get | MitgliedAttribut Mitglied? | Gibt den Wert des gegebenen Attributes aus. Wird kein Mitglied angegeben, wird der Autor genutzt |
|
||||
| Moderator | set | MitgliedAttribut Mitglied? | Setzt den Wert des gegebenen Attributes auf den gegebenen Wert. Wird kein Mitglied angegeben, wird der Autor genutzt |
|
||||
| Moderator | remove | MitgliedAttribut Mitglied? | Setzt den Wert des gegebenen Attributes auf den Standard zurück. Wird kein Mitglied angegeben, wird der Autor genutzt |
|
||||
| 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 |
|
||||
| Admin | reload | Modul | Lädt das gegebene Modul neu |
|
||||
| Admin | restart | | Start den Bot neu |
|
||||
| Admin | shutdown | | Fährt den Bot herunter |
|
||||
| Admin | presence | Text | Setzt das Spiel, welches der Bot gerade "Spielt" |
|
||||
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 |
|
||||
|
||||
Befehle der Gruppe /auto-role rule
|
||||
|
||||
| Befehl | Berechtigungen | Parameter | Beschreibung |
|
||||
|--------|----------------|-----------------------------------------------|----------------------------------------------------------------------------------------------------------|
|
||||
| list | Moderator | wait: int? | Listet alle AutoRoles Regeln auf |
|
||||
| add | Moderator | auto_role: int, emoji_name: str, role_id: str | Erstellt eine Regel für die gegebene AutoRole. Es wird auf die gegebene Nachricht mit dem Emoji reagiert |
|
||||
| remove | Moderator | auto_role_rule: int | Löscht die AutoRole Regel anhand der Id |
|
||||
|
||||
### User
|
||||
|
||||
Befehle der Gruppe /user
|
||||
|
||||
| Befehl | Berechtigungen | Parameter | Beschreibung |
|
||||
|--------|----------------|------------------|-----------------------------------------------------------------------------------------------------------------------|
|
||||
| info | Moderator | member: Member? | Gibt alle Werte des gegebenen Mitglieds aus |
|
||||
| get | Moderator | member: Member? | Gibt den Wert des gegebenen Attributes aus. Wird kein Mitglied angegeben, wird der Autor genutzt |
|
||||
| set | Moderator | member: Member? | Setzt den Wert des gegebenen Attributes auf den gegebenen Wert. Wird kein Mitglied angegeben, wird der Autor genutzt |
|
||||
| remove | Moderator | member: Member? | 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 |
|
||||
| up | Moderator | member: Member | Verringer das Level des Mitglieds auf das nächst niedrigere |
|
||||
| set | Moderator | level: str, user: Member | Setzt das Level des Mitglieds auf das gegebene Level |
|
||||
|
||||
### Techniker
|
||||
|
||||
| Befehl | Berechtigungen | Parameter | Beschreibung |
|
||||
|-----------------|----------------|--------------------|--------------------------------|
|
||||
| shutdown | Moderator | | Stoppt den Bot |
|
||||
| restart | Moderator | | Startet den Bot neu |
|
||||
| reload | Moderator | module: str | Lädt das angegebene Module neu |
|
||||
|
||||
### Statistik
|
||||
|
||||
Befehle der Gruppe /stats
|
||||
|
||||
| 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 |
|
||||
|
||||
|
||||
### 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 |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user