sh-edraft.de/sh_discord_bot

Table of Contents

Befehle

Inhaltsverzeichnis
Begriffserklärung

Begriffe
Datentypen

Befehle

Allgemein
Game server
Register
Unregister
Submit
Achievement
Auto role

Auto role rule

User
Level

Short role name

Techniker

Api Key
Sync xp
Realms

Noch geplante Befehle

Befehle

Inhaltsverzeichnis

Begriffserklärung
- Begriffe
- Datentypen
Befehle
- Allgemein
- Game server
- Register
- Unregister
- Submit
- Achievement
- Auto role
- Auto role rule
- User
- Level
- Short role name
- Techniker
- Api Key
- Sync xp
- Realms
- Noch geplante Befehle

Um einen Befehl auszuführen, muss man eine Nachricht in einen Text-Kanal (vorzugsweise in einen für Bot Befehle) schicken.

Diese muss wie folgt aufgebaut sein:

!k BEFEHL PARAMETER1 PARAMETER2 ... ODER /BEFEHL PARAMETER1 PARAMETER2 ... ODER /GRUPPE BEFEHL PARAMETER1 PARAMETER2 ...

Begriffserklärung

Begriffe

Autor: Das Mitglied, welches den Befehl geschickt hat
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.

Datentypen

int: Ganzzahlen
str: Text
Member: Discord Mitglied
Channel: Discord Kanal
Guild: Discord Server

Befehle

Allgemein

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, 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

Befehl	Berechtigungen	Parameter	Beschreibung
list	Moderator		Listet alle Gameserver des Discord Servers auf
add	Admin	name: str, 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, game_server: int, name: str	Verknüpft das Mitglied mit dem Spielerprofil auf dem Gameserver

Unregister

Befehl	Berechtigungen	Parameter	Beschreibung
unregister	Moderator	member: Member, 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

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

Auto role rule

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
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

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
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

Befehl	Berechtigungen	Parameter	Beschreibung
shutdown	Techniker		Stoppt den Bot
restart	Techniker		Startet den Bot neu
log	Techniker	dateFrom: str?, dateTo?	Schickt ein ZIP-Paket mit den angefragten Logs darin

Api Key

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

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, ,member: Member	Übernimmt die XP für ein Mitglied von einem anderen Server, sofern diese größer ist

Realms

Befehl	Berechtigungen	Parameter	Beschreibung
list	Moderator		Listet alle Realms
add	Moderator	name: str, leader: Member?	Erstellt einen Realm inkl. Kategorie & Rolle
edit	Moderator	realm_name: str, name: str	Ändert den Namen des Realms
delete	Moderator	realm_name: str	Entfernt die Kategorie inkl. Rolle & Kanäle
member add	Server oder Realm Moderator	realm: str, member: Member	Mitglied zum Realm zuweisen
member remove	Server oder Realm Moderator	realm: str, member: Member	Mitglied aus dem Realm entfernen
moderator add	Server oder Realm Moderator	realm: str, member: Member	Mitglied zum Moderator ernennen
moderator remove	Server oder Realm Moderator	realm: str, member: Member	Moderator status eines Mitglieds entfernen

Noch geplante Befehle

Berechtigungen	Befehl	Parameter	Beschreibung
Moderator	filter-list		Zeigt die Filterliste
Moderator	filter-add	Wort	Fügt ein Begriff zur Filterliste hinzu
Admin	filter-remove	Wort	Entfernt einen Begriff aus der Filterliste
Admin	filter-clear		Leert die Filterliste