Wie man SCAPI verwendet
import
Statement.
pip
installieren. (pip install pyyaml
)Flag | Erklärung |
---|---|
username | Der Nutzername des Bots |
token | Der Token (Passwort) des Bots |
host | Remote-Server, wo der Bot sich mit verbinden soll |
port | Der Port des Remote-Servers |
enable_user_input | Aktiviere die Nachrichteneingabe innerhalb der Konsole (Auch als Flag verfügbar) |
print_recv_msg | Gebe empfangende Nachrichten in die Bot-Logs aus (Konsole) (Auch als Flag verfügbar) |
Flag | Erklärung |
---|---|
print_recv_msg | Gebe empfangende Nachrichten in die Bot-Logs aus (Konsole) |
enable_user_input | Aktiviere die Nachrichteneingabe innerhalb der Konsole |
log_msg | Ändere das Format der Log-Nachrichten |
@commands
Modul)Commands
.
Dieser Teil erklärt wie du einen Command mithilfe des Command-Modules schreiben kannst.Für die andere Methode kannst du dir diesen Dokumentationsteil anschauenCode | Erklärung |
---|---|
name | Steht für den Command-Namen, welcher anschließend in der Registry eingefügt wird. Du kannst den Command dann mithilfe des Prefixes und dann den Namen aufrufen (z.B. !test ) |
arg_count | Anzahl der Argumente, die der Befehl annimmt und mindestens benötigt. Es kann auch eine niedrigere Zahl angegeben werden und mehr Argumente trotzdem angenommen werden |
required_permissions | Benötigte Berechtigung für den Command. Hier muss ein Wert der Scapi-Klasse übergeben werden. Scapi.Bot.PermissionLevel.CUSTOM für die Custom-Liste, die du hier definiert hast |
username | Der Nutzername, des Benutzers, der den Command ausgeführt hat |
args | Die Argumente, die beim Ausführen des Commands übergeben wurden. Wird in einer Liste gespeichert (["first", "second", "third"] ) |
send_message(...) | Funktion um eine Nachricht zu senden |
on_message
Events verwendet um reine Nachrichten zu akzeptieren & zu verarbeiten.
Code | Erklärung |
---|---|
Commands() | Erstellt eine Funktion für das allgemeine verarbeiten der empfangenden Nachrichten & Commands |
while True | Eine Schleife die nie endet, um immer die Nachrichten zu empfangen |
Bot.recv_message(raw=True) | Empfängt die Nachrichten in einem rohen Format (Ohne Farben) |
if message.startswith("!hello") | Kontrolliert, ob die empfangende Nachricht mit !hello startet |
send_message(...) | Funktion um eine Nachricht zu senden |
on_ready
.
Dieses Event wird aufgerufen, wenn du den Bot startest. Du musst nur bei der Bot.run()
Funktion als Argument die on_ready
Funktion übergeben.
Ein on_ready
Event kann so aussehen:
Flag | Erklärung |
---|---|
username | Der Nutzername des Bots |
token | Der Token (Passwort) des Bots |
host | Remote-Server, wo der Bot sich mit verbinden soll |
prefix | Der Prefix des Bots, worauf er hören soll (z.B. !help ) |
port | Der Port des Remote-Servers |
enable_user_input | Aktiviere die Nachrichteneingabe innerhalb der Konsole (Auch als Flag verfügbar) |
print_recv_msg | Gebe empfangende Nachrichten in die Bot-Logs aus (Konsole) (Auch als Flag verfügbar) |
json | Aktiviert oder deaktiviert den Kompatiblitätsmodus für alte Server |
json
ist erst seit Scapi v0.12.1 verfügbarprefix
ist erst seit Scapi v0.13.1b2 verfügbarFlag | Erklärung |
---|---|
print_recv_msg | Gebe empfangende Nachrichten in die Bot-Logs aus (Konsole) |
enable_user_input | Aktiviere die Nachrichteneingabe innerhalb der Konsole |
log_msg | Ändere das Format der Log-Nachrichten |
ignore_capitalization | Aktiviert oder deaktiviert das ignorieren von Großbuchstaben für die on_message Methode (Nur verfügbar ab Scapi v0.13) |
Commands
.
Dieser Teil erklärt wie du einen Command mithilfe des Command-Modules schreiben kannst.Die ältere Methode ist seit Scapi v0.12.1 veraltet und sollte daher auch nicht mehr verwendet werdenCode | Erklärung |
---|---|
name | Steht für den Command-Namen, welcher anschließend in der Registry eingefügt wird. Du kannst den Command dann mithilfe des Prefixes und dann den Namen aufrufen (z.B. !test ) |
arg_count | Anzahl der Argumente, die der Befehl annimmt und mindestens benötigt. Es kann auch eine niedrigere Zahl angegeben werden und mehr Argumente trotzdem angenommen werden |
required_permissions | Benötigte Berechtigung für den Command. Hier muss ein Wert der Scapi-Klasse übergeben werden. Scapi.Bot.PermissionLevel.CUSTOM für die Custom-Liste, die du hier definiert hast |
username | Der Nutzername, des Benutzers, der den Command ausgeführt hat |
args | Die Argumente, die beim Ausführen des Commands übergeben wurden. Wird in einer Liste gespeichert (["first", "second", "third"] ) |
send_message(...) | Funktion um eine Nachricht zu senden |
Direktnachrichten
Chat verlassen
@on_message
Methode (Seit v0.13). Bei fehlender Funktionalität bitte ein Issue auf unserem GitHub öffnenFalls du trotzdem aus was auch immer welchen Gründen diese Methode verwenden möchtest, schaue dir bitte diesen Teil der Dokumentation an@on_message
Methode mehr eingeschränkt.Folgende Funktionen konnten bis jetzt nicht implementiert werden (Aber könnten in Zukunft in einer anderen Form auftreten):Bot.run()
Funktion als Argument die on_ready
Funktion übergeben.
Ein on_ready
Event kann so aussehen:
@json-communication
/@main
) hier erhalten.
Die folgenden Code-Stücke zeigen dir wie du einen einfachen Bot mit Scapi (stbmv2) erstellen kannst.
json
zu False
aktiviert den Kompatiblitätsmodus. Beachte das dies noch nicht vollständig entwickelt wurde.