Added command docs
parent
eb1bb16d7b
commit
35f6c22bd3
70
Befehle.md
70
Befehle.md
@ -1,3 +1,71 @@
|
||||
# Befehle
|
||||
|
||||
Noch sind keine Befehle vorhanden.
|
||||
Befehle werden in drei Gruppen unterschieden:
|
||||
|
||||
- [Einfache Befehle](#einfache-befehle)
|
||||
- [Moderator Befehle](#moderator-befehle)
|
||||
- [Admin Befehle](#admin-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
|
||||
|
||||
## Begriffserklärung
|
||||
|
||||
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
|
||||
beigetreten ist warnings: Eine Verwarnung (z.B. Regelverstoß)
|
||||
kicks: Ein Eintrag, wenn ein Mitglied gekickt wurde bans: Alle Bans des Mitglieds
|
||||
|
||||
Parameter mit einem ```?``` sind optionale Parameter.
|
||||
|
||||
## Einfache Befehle
|
||||
|
||||
| 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 |
|
||||
|
||||
## Moderator 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 |
|
||||
|
||||
## Admin Befehle
|
||||
|
||||
| Befehl | Parameter | Beschreibung |
|
||||
|----------|------------|------------------|
|
||||
| Noch | Keine | Vorhanden |
|
||||
|
||||
## Geplante Befehle
|
||||
|
||||
| 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" |
|
||||
|
||||
Loading…
Reference in New Issue
Block a user