KirschnBot Documentation Release latest 02.05.2016 Inhalt 1 Webinterface Übersicht 1.1 Commands . . . . 1.2 Users . . . . . . . 1.3 Anti-Spam . . . . 1.4 Quotes . . . . . . 1.5 Items . . . . . . . 1.6 Timer . . . . . . . 1.7 Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3 3 5 5 6 7 8 9 2 Menü (Web) 3 Commands (Web) 3.1 Commands (Übersicht) . . . . . . . . . . . 3.2 Command Erstellen . . . . . . . . . . . . 3.3 Command Editieren . . . . . . . . . . . . 3.4 Command Löschen . . . . . . . . . . . . . 3.5 Weitere Parameter für den Command Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 13 13 14 14 14 Lists & Items (Web) 4.1 Item/List (Übersicht) 4.2 Item/List Erstellen . 4.3 List/Item Editieren . 4.4 List/Item Löschen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17 17 17 17 18 Quotes (Web) 5.1 Quotes (Übersicht) 5.2 Quote Hinzufügen 5.3 Quote Editieren . . 5.4 Quote Löschen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 19 19 19 20 Timer (Web) 6.1 Timer (Übersicht) . . . . . . . . . . . . . . 6.2 Timer Erstellen . . . . . . . . . . . . . . . . 6.3 Timer Editieren . . . . . . . . . . . . . . . . 6.4 Timer Löschen . . . . . . . . . . . . . . . . 6.5 Weitere Parameter für den Timer Output Text . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 21 21 22 22 22 Anti-Spam 7.1 Filter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 23 4 5 6 7 11 . . . . i 7.2 7.3 7.4 7.5 7.6 7.7 Link Filter . . . . . . . Link Whitelist . . . . . Add Whitelisted Link . Blacklist Filter . . . . . Phrase Blacklist . . . . Add Blacklisted Phrase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 23 24 24 24 24 8 Settings (Web) 8.1 Custom Chataccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8.2 Confirmed Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8.3 Confirmed User Hinzufügen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 25 25 25 9 Users (Web) 9.1 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9.2 Custom Userlevel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9.3 Add User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 27 27 27 10 Commands IRC 10.1 Command Erstellen . . . . . . . . . . . . 10.2 Command mit Userlevel . . . . . . . . . . 10.3 Userlevel (Erweitert) . . . . . . . . . . . . 10.4 Command Editieren . . . . . . . . . . . . 10.5 Commands Löschen . . . . . . . . . . . . 10.6 Weitere Parameter für den Command Text: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 29 29 29 30 30 30 11 Quotes IRC 11.1 Quote Erstellen . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11.2 Quotes Löschen: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 33 33 12 Timer IRC 12.1 Timer Erstellen . . . . . . . . . . . . 12.2 Timer Starten & Stoppen . . . . . . . 12.3 Timer Editieren . . . . . . . . . . . . 12.4 Timer Löschen . . . . . . . . . . . . 12.5 Weitere Parameter für den Timer Text 35 35 35 35 36 36 ii . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . KirschnBot Documentation, Release latest Bedienung des KirschnBot über das Webinterface. Inhalt 1 KirschnBot Documentation, Release latest 2 Inhalt KAPITEL 1 Webinterface Übersicht 1.1 Commands 1.1.1 Command Overview Übersicht über Alle Commands. Command: Entsprechender Chat Command (zB. !test). Return: Text und Paramter die der Bot Ausgibt (zB. Ich bin ein Command). Userlevel: Userlevel das zum Ausführen des Commands benötigt wird. Actions: Möglichkeit das entsprechende Command zu Editieren & Löschen oder es per Wisper auszugeben. 1.1.2 Add Command Möglichkeit ein Command zu erstellen. Command: Feld zum eintragen des Entsprechenden Commands (zB. !DeinCommand) WICHTIG: Das Command muss mit einem “!” beginnen. Userlevel: Dropdown Menü zum Auwählen des Userlevels welches zum Ausführen des Command benötigt wird. Command Text: Feld zum eintragen des Textes und der Parameter die beim Auführen des Command ausgegeben werden 3 KirschnBot Documentation, Release latest 1.1.3 Mögliche Userlevel • “Everyone” - Alle können diesen Command benutzen • “Subscriber” - Nur Subscriber, Moderator und der Streamer können diesen Command benutzen. • “Moderator” - Nur Moderator und der Streamer können diesen Command Benutzen. • “Streamer” - Nur der Streamer kann diesen Command benutzen. • “Custom” - Nur Viewer mit einem Custom Userlevel können diesen Command benutzen (kann unter “Users” festgelegt werden) 1.1.4 Weitere Parameter Parameter um Commands individuell an zu passen. $query Gibt alles aus was der User hinter !Command schreibt $user Gibt den Usernamen des Users wieder der denn !Command ausführt $[http(https://webseite.com)] Gibt den Source Code der gewählten Webseite wieder $[rngnumber(min,max)] Gibt eine Zufällige Nummer zwischen Min und Max wieder min & max sind hierbei ein Nummerischer Wert $[rnglist(listname)] Gibt ein Zufälliges Item aus der Angegebenen Liste wieder (Listen und Items können unter “Items” angelegt werden) $[index] Gibt ein Spezifisches Wort aus der Eingabe Nachricht wieder Index ist hierbei ein numerischer Wert und gibt die Position des Wortes im Kommando aus. /////TODO///// $[index]elserngnumber(min,max) Wenn spezifisches Wort nicht gegeben ist wird eine zufällige ganze Zahl zwischen min und max ausgegeben $[index]elsernglist(listname) Wenn spezifisches Wort nicht gegeben ist wird ein zufälliges Objekt aus der Liste listname ausgegeben $queryelseuser $queryelsernglist(listname) 4 Kapitel 1. Webinterface Übersicht KirschnBot Documentation, Release latest 1.2 Users 1.2.1 Configuration: Einstellen der Userlevel. “Read your moderators from the Twitch Chat:” Auswählen ob Userlevel die den Moderator Status haben Automatisch aus dem Twitch Chat gelesen werden. “Standard userlevel for your mods:” Festlegen des Nummerischen Wert des Userlevels “Moderator” innerhalb des Bots. “Standard userlevel for your subscribers:” Festlegen des Nummerischen Wert des Userlevels “subscriber” innerhalb des Bots. “Standard userlevel for your Viewers:” Festlegen des Nummerischen Wert des Userlevels “Viewer” innerhalb des Bots. 1.2.2 Übersicht: Custom Userlevel: Übersicht über die Angelegeten Custom Userlevel und Möglichkeit diese zu Löschen. 1.2.3 User hinzufügen: Add User: Usern bestimmte Userlevel zuordnen und Custom Userlevel erstellen (Custom Userlevel haben immer einen numerischen Wert). 1.3 Anti-Spam 1.3.1 Filter Einstellen welche Filter Aktiv sein sollen. Auto-Timeout URLs in your chat: Aktiviert den Linkfilter im Chat. Auto-Timeout blacklisted phrases in your chat: Aktiviert den Blacklistfilter im Chat. 1.3.2 Link Filter Einstellen des Link Filters. Timeout length: 1.2. Users 5 KirschnBot Documentation, Release latest Definiert die Länge die der Bot Timeoutet wenn ein Link gepostet wird (Längen: Purge (1sec), 1 Minute, 5 Minuten, 10 Minuten, 30 Minuten) Send Timeout Notification: Aktivieren der Nachricht wenn der Bot durch den Linkfilter Timeoutet Timeout text: Nachricht die angezeigt wird wenn der Bot durch den Linkfilter Timeoutet Link Whitelist: Links die bei Aktiviertem Linkfilter nicht Automatisch Timeouted werden. Add Whitelisted Link: Möglichkeit URLs in die Whitelist einzutragen 1.3.3 Blacklist Filter: Einstellen des Blacklist Filters. Timeout length: Definiert die Länge die der Bot Timeoutet wenn ein Wort/Satz auf der Blacklist gepostet wird (Längen: Purge (1sec), 1 Minute, 5 Minuten, 10 Minuten, 30 Minuten) Send Timeout Notification: Aktivieren der Nachricht wenn der Bot ein Wort/Satz auf der Blacklist Timeoutet Timeout text: Nachricht die angezeigt wird wenn der Bot ein Wort/Satz auf der Blacklist Timeoutet Phrase Blacklist: Wörter/Sätze die bei Aktivierter Blacklist Automatisch Timeouted werden. Add Blacklisted Phrase: Möglichkeit Wörter/Sätze in die Blacklist einzutragen 1.4 Quotes 1.4.1 Quote Overview Übersicht über Alle Quotes. Name: Name des Quotes der benötigt wird um den Quote im Chat Direkt auf zu rufen (Beispiel: !quote 0). Quote: Der Entsprechende Quote den der Bot Ausgeben kann. Created by: Name ders Users der den Quote angelegt hat. 6 Kapitel 1. Webinterface Übersicht KirschnBot Documentation, Release latest Actions: Möglichkeit Den entsprechenden Quote zu Editieren oder Löschen 1.4.2 Add Quote Möglichkeit ein Quote zu erstellen Quote Name: Feld zum eintragen des Entsprechenden QuoteNamen um diesen direkt im Chat ab zu Rufen (Beispiel: !Quote QuoteName). Quote Text: Feld zum eintragen des QuoteTextes der im Chat augegeben wird. 1.5 Items 1.5.1 List & Item Overview Übersicht über Alle Listen und die Enthaltenen Items. Filter: Dropdown Menü zum Filtern der Listen. List: Name der Listen der die Items zugeordnet sind die dann über den Command Paramter “$[rnglist(listname)]” ausgegeben werden können. Wenn spezifisches Wort nicht gegeben ist wird eine zufällige ganze Zahl zwischen min und max ausgegeben Item: Item der Entsprechenden Liste das der Bot Ausgeben kann. Actions: Möglichkeit das Entsprechende Item zu Editieren oder Löschen (Leere Listen sollten Automatisch gelöscht werden). 1.5.2 Add Item Möglichkeit Listen und Items zu Erstellen List: Feld zum Auswählen in Welche Liste das Item erstellt werden soll (Ist die Liste noch nicht vorhanden wird sie Erstellt) Item: Feld zum Eintragen eines Items in die Oben angegebene Liste 1.5. Items 7 KirschnBot Documentation, Release latest 1.6 Timer 1.6.1 Timer Overview Übersicht über Alle Timer. Name: Name des entsprechenden Timers. Text Text der vom Timer Ausgegeben wird. Interval: Interval in dem ein Timer Ausgelöst wird. Lines Anzahl an Chatnachrichten innerhalb von 5 Minuten die zum Triggern des Timers benötigt werden. Actions: Möglichkeit Den entsprechenden Timer zu Starten/Stoppen Editieren oder Löschen 1.6.2 Add Timer Möglichkeit ein Timer zu erstellen Name: Feld zum eintragen des Entsprechenden Timer Namen. Interval Feld zum eintragen des Intervals nach dem der Timer in ausgegebn wird (in Minuten) Lines Feld zum eintragen der Anzahl an Chatnachrichten innerhalb von 5 Minuten die zum Triggern des Timers benötigt werden. Quote Text: Feld zum eintragen des Timer Textes der im Chat augegeben wird. 1.6.3 Weitere Parameter Parameter um Commands individuell an zu passen. $[http(https://webseite.com)] Gibt den Source Code der gewählten Webseite wieder $[rngnumber(min,max)] Gibt eine Zufällige Nummer zwischen Min und Max wieder min & max sind hierbei ein Nummerischer Wert $[rnglist(listname)] 8 Kapitel 1. Webinterface Übersicht KirschnBot Documentation, Release latest Gibt ein Zufälliges Item aus der Angegebenen Liste wieder (Listen und Items können unter “Items” angelegt werden) $[index] Gibt ein Spezifisches Wort aus der Eingabe Nachricht wieder Index ist hierbei ein numerischer Wert und gibt die Position des Wortes im Kommando aus. 1.7 Settings 1.7.1 Custom Chataccount Möglichkeit einen Custom Chataccount für den KirschnBot zu Nutzen. Username: Feld zum Eintragen des Usernamens des zu Nutzenden Bot Accounts. OAuth Token: Feld zum Eintragen des OAuth-Token des zu Nutzenden Bot Accounts. (OAuth-Token Generieren: https://twitchapps.com/tmi/ Aufrufen und mit dem zu Nutzenden Bot Account einloggen) Reset to “KirschnBot”: Schaltfläche um wieder den Standard Bot Account “KirschnBot” zu nutzen. 1.7.2 Confirmed Users Übersicht über Alle User die vollen Zugiff auf das Eigene Bot Webinterface haben Username: Twitchname der User die Vollen zugriff auf das Webinterface haben Actions: Möglichkeit die Rechte für den Vollzugriff zu Entziehen 1.7.3 Add Confirmed User Möglichkeit Bestimmten Usern zugriff auf das Bot Webinterface zu geben. Username: Feld zum eintragen des Twitchnamen des Users der vollen Zugriff auf das Webinterface haben soll. 1.7. Settings 9 KirschnBot Documentation, Release latest 10 Kapitel 1. Webinterface Übersicht KAPITEL 2 Menü (Web) Commands: Hier erhält man eine Übersicht über Alle Command und kann diese Erstellen, Editieren oder Löschen. Users: Hier kann man die Bot internen Userlevel Anpassen sowie Costume Userlevel erstellen um Bestimmten Personen, bestimmte Commands zugänglich zu machen. Quotes: Hier erhält man eine Übersicht über Alle Zitate und kann diese Erstellen, Editieren oder Löschen. Items: Hier erhält man eine Übersicht über Alle Listen und darin befindlichen Items und kann diese Erstellen, Editieren oder Löschen. Timer: Hier erhält man eine Übersicht über Alle Timer und kann diese Erstellen, Starten/Stoppen, Editieren und Löschen Anti-Spam: Hier kann man den Link und Badword Filter Aktivieren und Anpassen. Zudem erhält man eine Übersicht über Alle Links in der Whitelist sowie alle Blacklist Wörter/Sätze. Des weiteren erhält man hier die Möglichkeit Links und Wörter/Sätze in die Black bzw Whitelist eintragen und Entfernen. Settings: Hier erhält man die Möglichkeit dem Kirschnbot einen Eigenen Bot Account zu zuweisen, sowie kann man hier Bestimmten Usern vollen zugriff auf das Webinterface zuweisen. Disable/Enable Bot: Mit dieser Schaltfläche kann man den Bot im Eigenen Chat Aktivieren oder Deaktivieren. 11 KirschnBot Documentation, Release latest 12 Kapitel 2. Menü (Web) KAPITEL 3 Commands (Web) 3.1 Commands (Übersicht) In der Übersicht könnt ihr sehen Welche Commands sich derzeit im Bot befinden. Command: Hier wird der Name und Auslöser des Command angezeigt. Return Hier wird der Text & die Parameter Angezeigt die beim Auslösen des Command ausgegeben werden. Userlevel Hier wird das Benötigte mindest Userlevel was zum Ausführen des Commands als Nummerischer wert Angezeigt. Actions Hier werden die Optionen zum Löschen (Delete) und Editieren (Edit) so wie die Möglichkein eine Command ausgabe Normal oder über Whisper aus zu geben. 3.2 Command Erstellen Command: Hier trägt man den Namen des Command ein über den er im Chat abrufbar ist, Wichtig ist das dieser mit einem “!” beginnt. Command Text: Hier wird der Text eingetragen der bei der Benutzung des Entsprechenden Command befehls vom Bot im Chat Ausgegeben wird. Dieser Text kann sowohl Normalen Text als auch Parameter Enthalten (Siehe: “Weitere Parameter für den Commands Text”) Wichtig: Commands ohne veränderung des Userlevels sind für Alle User im Chat benutzbar, dazu Nachfolgend weitere Informationen. 3.2.1 Command mit Userlevel Auch ist es Möglich ein Command einer bestimmten Userlevel zugänglich zu machen. Hierfür wählt man zusätzlich noch im Dropdownmenü bei “Userlevel” das Entsprechende Userlevel 13 KirschnBot Documentation, Release latest So wird ausgewählt Welche Userleveln den Erstellten Command am ende Benutzen können "Everyone" "Subscriber" "Moderator" "Streamer" "Custom" - Alle können diesen Command benutzen Nur Subscriber, Moderatoren und der Streamer können diesen Command benutzen. Nur Moderatoren und der Streamer können diesen Command Benutzen. Nur der Streamer kann diesen Command benutzen. Nur Viewer mit einer Custom Userlevel können diesen Command benutzen (siehe: Erklär Wählt man das Userlevel “Custom” kann man den Nummerischen Wert für die CustomUserlevel eintragen 3.3 Command Editieren Zum Editieren eines Command wählt man Rechts “Edit” aus Nun öffnet sich ein Popup Fenster in dem man Alle Parameter ändern Kann Wichtig ist hier das man Das Userlevel nicht mit einem Dropdown Menü Editieren kann sondern nur durch den Nummerischen wert Folgende Werte Entsprechen den Standard Userleveln: "Everyone" "Subscriber" "Moderator" "Streamer" "Custom" - 999 500 100 000 ### - Alle können diesen Command benutzen Nur Subscriber, Moderatoren und der Streamer können diesen Command benutzen. Moderatoren und der Streamer können diesen Command Benutzen. Nur der Streamer kann diesen Command benutzen. Nur Viewer mit einer Custom Userlevel können diesen Command benutzen ("###" d 3.4 Command Löschen Zum Löschen eines Command wählt man Rechts “Delete” aus Und um das löschen zu Bestätigen drückt man im sich öffnenden Popup Fenster auf “OK” 3.5 Weitere Parameter für den Command Text Um deine Commands bei der Ausgabe etwas an zu passen gibt es eine handvoll weiterer Parameter für den Commandtext. $query - Gibt alles aus was der Benutzer hinter !Command schreibt Beispiel: Eingabe & Ausgabe: $user - Gibt den Benutzernamen des Benutzers wieder der denn !Command ausführt Beispiel: Eingabe & Ausgabe: $[http(https://webseite.com)] - Gibt den Source Code der gewählten Webseite wieder Beispiel: Eingabe & Ausgabe: $[rngnumber(min,max)] - Gibt eine Zufällige Nummer zwischen Min und Max wieder Beispiel: 14 Kapitel 3. Commands (Web) KirschnBot Documentation, Release latest Eingabe & Ausgabe: $[rnglist(listname)] - Gibt ein Zufälliges Item aus der Angegebenen Liste wieder (siehe: Items) Beispiel: Eingabe & Ausgabe //// TODO //// $[index] - Gibt ein Spezifisches Wort aus der Eingabe Nachricht wieder Beispiel 1: Eingabe & Ausgabe 1: Beispiel 2: Eingabe & Ausgabe 2: Beispiel 3: Eingabe & Ausgabe 3: NOTE: the “else” variable is triggered, if the query word isn’t available! • $[index]elserngnumber(min,max) - should be self explainatory • $[index]elsernglist(min,max) • $queryelseuser • $queryelsernglist(listname) 3.5. Weitere Parameter für den Command Text 15 KirschnBot Documentation, Release latest 16 Kapitel 3. Commands (Web) KAPITEL 4 Lists & Items (Web) 4.1 Item/List (Übersicht) In dieser Übersicht kann man Alle erstellten Listen und Items einsehen. List (Dropdown): Dies Ermögtlich bei Vielen Items ein Filtern nach bestimmten Listen List: Hier steht der Name der Listen der die Items zugeordnet sind die dann über den Command Parameter “$[rnglist(listname)]” ausgegeben werden können Beispiel: Parameter $[rnglist(liste1)] würde nur die Items aus “liste1” zufällig wiedergeben Item: Hier Steht das Entsprechende Item das der Bot Ausgeben kann Actions: Hier befinden sich die Optionen zum Editieren (Edit) und Löschen (Delete) von Items 4.2 Item/List Erstellen List: Hier wird die Liste Angegeben oder Erstellt in der das Item eingetragen wird Item: Hier wird das Item eingetragen welches welches zur Liste hinzugefügt wird 4.3 List/Item Editieren Zu diesem Fenster kommt man wenn man in der Übersicht Rechts beim entsprechenden Item auf “Edit” Klickt List: Hier kann die Liste des Items Editiert werden Item: 17 KirschnBot Documentation, Release latest Hier kann das Item Editiert werden 4.4 List/Item Löschen Um ein Item aus der Datenbank zu löschen drückt man einfach in der Übersicht rechts beim entsprechenden Item auf “Delete“ Ist eine Liste Leer sollte diese ebenfalls gelöscht werden 18 Kapitel 4. Lists & Items (Web) KAPITEL 5 Quotes (Web) 5.1 Quotes (Übersicht) In dieser Übersicht kann man Alle erstellten Quotes einsehen. Name: Hier steht der Name des Quotes der benötigt wird um den Quote im Chat Direkt auf zu rufen (Beispiel: !Quote 0) Quote: Hier Steht der Entsprechende Text den der Bot Ausgeben kann Created by: Hier wird angezeigt welcher User den Quote angelegt hat, dies dient nur der übersicht. Actions: Hier befinden sich die Optionen zum Editieren (Edit) und Löschen (Delete) von Quotesn 5.2 Quote Hinzufügen Quote Name: Hier wird der Name des Quotes angegeben um diesen direkt im Chat ab zu Rufen (Beispiel: !Quote QuoteName) Quote Text: Hier wird der Text eingegeben der vom Bot beim Aufruf von !Quote bzw !Zitat QuoteName ausgeben soll 5.3 Quote Editieren Zu diesem Fenster kommt man wenn man in der Übersicht Rechts beim entsprechenden Quote auf “Edit” Klickt Quote Name: Hier kann der Name des Quotes Editiert werden Quote Text: 19 KirschnBot Documentation, Release latest Hier kann der Text des Quotes Editiert werden 5.4 Quote Löschen Um ein Quote aus der Datenbank zu löschen drückt man einfach in der Übersicht rechts beim entsprechenden Quote auf “Delete” 20 Kapitel 5. Quotes (Web) KAPITEL 6 Timer (Web) 6.1 Timer (Übersicht) In dieder Übersicht kann man Alle erstellten Timer einsehen Name: Hier steht die Namen der Timer. Text Hier steht der Entsprechende Text den die Timer Ausgeben Interval Hier kann man die Zeit in Minuten einsehen in welchem Interval der Entsprechende Timer den Timertext ausgibt. Lines Hier befindet sich die Anzahl der Chatnachrichten die innerhalb von 5 Minuten benötigt werden damit der Timer getriggert wird Actions Hier befinden sich die Optionen zum Starten und Stoppen so wie Editieren und Löschen von Timern 6.2 Timer Erstellen Name Hier wird der Name des zu erstellenden Timers Eingetragen. Interval (Minutes) Hier wird die Zeit in Minuten eingetragen in welchen abständen der Timer auslöst. Wichtig: Dieser Wert muss ein Nummerischer Wert sein! Lines (how many lines have to appear in 5 minutes to activate the timer) Hier wird die Anzahl der Chatnachrichten eingetragen die innerhalb von 5 Minuten benötigt werden damit der Timer getriggert wird. dies dient dazu das der Bot nur dann Nachrichten ausgibt wenn der Chat auch genutzt wird. Wichtig: Dieser Wert muss ein Nummerischer Wert sein! Output Text 21 KirschnBot Documentation, Release latest Hier wird der Text des Timers eingetragen, der dann im Oben angegebenen Interval ausgegeben wird 6.3 Timer Editieren Zu diesem Fenster kommt man wenn man in der Übersicht Rechts beim entsprechenden Timer auf “Edit” Klickt Name Hier wird der Name des zu erstellenden Timers geändert. Interval Hier wird die Zeit in Minuten geändert in welchen abständen der Timer auslöst. Wichtig: Dieser Wert muss ein Nummerischer Wert sein! Lines Hier wird die Anzahl der Chatnachrichten geändert die innerhalb von 5 Minuten benötigt werden damit der Timer getriggert wird. Wichtig: Dieser Wert muss ein Nummerischer Wert sein! Output Text Hier wird der Text der vom Timer Ausgegeben wird geändert. 6.4 Timer Löschen Zum Löschen eines Timers wählt man in der Übersicht bei Action “Delete” aus 6.5 Weitere Parameter für den Timer Output Text $[http(https://webseite.com)] - Gibt den Source Code der gewählten Webseite wieder Beispiel: Ausgabe: "Werden wir es schaffen? $[http(https://apis.rtainc.co/witchbot/8ball)]" "Werden wir es schaffen? ("Zufällige Antwort")" $[rnglist(listname)] - Gibt ein Zufälliges Item aus der Angegebenen Liste wieder Beispiel: Ausgabe: "Gibts allen $[rnglist(give)]" "Gibt allen (Ein zufälligen Gegenstand der sich in der Liste "give" befindet)" $[rngnumber(min,max)] - Gibt eine Zufällige Nummer zwischen dem Min und Max wert wieder Beispiel: Ausgabe: "Die Glückszahl der nächsten 10 Minuten ist $[rngnumber(0,99)]" "Die Glückszahl der nächsten 10 Minuten ist: (Zufällige Zahl zwischen 0 und 99)" WICHTIG: Die Parameter “min” & “max” müssen einen Nummerischen Wert besitzen 22 Kapitel 6. Timer (Web) KAPITEL 7 Anti-Spam 7.1 Filter Auto-Timeout URLs in your chat Wählt man dieses aus so Timeoutet der Bot Automatisch Alle Links die NICHT auf der Whitelist stehen Auto-Timeout blacklisted phrases in your chat Wählt man dieses aus so Timeoutet der Bod Automatisch Alle Wörter oder Sätze die in der Blacklist eingetragen wurden 7.2 Link Filter Timeout length: Hier kann man die Länge des Timeouts einstellen wenn Links gepostet werden die Nicht auf der Whitelist stehen Gewählt werden kann zwischen: • Purge (1sec) • 1 Minute • 5 Minuten • 10 Minuten • 30 Minuten Send Timeout Notification: Wählt man dieses aus, so wird die unter “Timeout text” angegebene Nachricht beim verstoß gegen den Link Filter ausgegeben Timeout text: Hier kann man den Text der bei einem Verstoß gegen den Linkfilter ausgegeben wird eingeben 7.3 Link Whitelist Hier kann man Alle links die sich in der Whitelist des Bots befinden einsehen und gegebenenfalls Entfernen In diesem Beispiel ist die URL “kirschnbot.tk” auf der Whitelist und somit kann diese in den Chat geschrieben werden, ohne das der Linkfilter sie timeoutet. 23 KirschnBot Documentation, Release latest 7.4 Add Whitelisted Link Add Link: Hier werden die URLs eingetragen die der Bot nicht Timeouten soll 7.5 Blacklist Filter Timeout length: Hier kann man die Länge des Timeouts einstellen wenn Wörter und Sätze gepostet werden die auf der Blacklist stehen Gewählt werden kann zwischen: • Purge (1sec) • 1 Minute • 5 Minuten • 10 Minuten • 30 Minuten Send Timeout Notification: Wählt man dieses aus, so wird die unter “Timeout text” angegebene Nachricht beim verstoß gegen die Blacklist ausgegeben Timeout text: Hier kann man den Text der augegeben wird wenn man Timeoutet wird falls man ein Wort oder ein Satz der auf der Blacklist steht eingibt 7.6 Phrase Blacklist Hier kann man Alle Wörter und Sätze die sich in der Blacklist des Bots befinden einsehen und gegebenenfalls Entfernen In diesem Beispiel ist der Satz “ich bin ein ganz böser text” auf der Blacklist. somit wird man Timeoutet wenn man diesen Satz im Chat schreibt. 7.7 Add Blacklisted Phrase Phrase: Hier werden die Wörter und Sätze eingetragen die der Bot Timeouten soll 24 Kapitel 7. Anti-Spam KAPITEL 8 Settings (Web) 8.1 Custom Chataccount Diese Option ermöglicht es dem KirschnBot einen anderen Account zu nutzen welcher dann als Bot Fungiert. Username: Hier wird der Username des zu Nutzenden Accounts eingegeben. OAuth Token: Hier wird der OAuth-Token des zu Nutzenden Accounts eingetragen Beispiel: oauth:aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Einen OAuth-Token generieren kann man indem man Sich mit dem entsprechenden Account bei Twitch einloggt und folgende Seite Aufruft. https://twitchapps.com/tmi/ Reset to “KirschnBot”: Diese Schaltfläche ermögtlich es vom Costum Account wieder auf den Eigentlichen KirschnBot Account zurück zu wechseln. 8.2 Confirmed Users Hier erhaltet ihr eine Übersicht über Alle User die vollen Zugriff das Webinterface von eurem Bot haben und die Möglichkeit diese zu Entfernen. 8.3 Confirmed User Hinzufügen Hier kann man User hinzufügen die Vollen zugriff auf das Webinterface Eures Bots haben sollen Wichtig: Diese Personen haben nur Zugriff zu Eurem und Ihrem Eigenen Bot Webinterface 25 KirschnBot Documentation, Release latest 26 Kapitel 8. Settings (Web) KAPITEL 9 Users (Web) 9.1 Configuration Read your moderators from the Twitch Chat: Wählt man diesen Punkt aus werden Die Userlevel die den Moderator Status haben Automatisch aus dem Twitch Chat gelesen. Standard userlevel for your mods: Hier kann man den Nummerischen Wert des Userlevels “Moderator” innerhalb des Bots anpassen. Standard userlevel for your subscribers: Hier kann man den Nummerischen Wert des Userlevels “subscriber” innerhalb des Bots anpassen. Standard userlevel for your Viewers: Hier kann man den Nummerischen Wert des Userlevels “Viewer” innerhalb des Bots anpassen 9.2 Custom Userlevel Hier werden die Userlevel mit einem “Custome Userlevel” Angezeigt so wie der Nummerische wert der Userlevelguppe dem dieser Userlevel innerhalb des Bots angehört. Über Delete kann die zuortnung einer Userlevelguppe auch wieder entzogen werden. 9.3 Add User Username: Hier wird der Twitch Userlevelname des Userlevels eingetragen dem man innerhalb des Bots eine bestimmte Userlevelgruppe zuordnen Möchte Userlevel: Hier wählt man Welcher Userlevelgruppe der Userlevel Angehören soll Zur Auswahl stehen: Chatter, Moderator, Streamer und Custome Custome Erlaubt es dem Userlevel eine Eigene Userlevelgruppe innerhalb des Bots zu zuordnen Beispiel: Hat ein Userlevel das “Userlevel” 300 zugewiesen bekommen kann dieser Entsprechend Commands benutzen die ebenfalls dem Userlevel 300 zugeordnet sind (siehe Commands) 27 KirschnBot Documentation, Release latest 28 Kapitel 9. Users (Web) KAPITEL 10 Commands IRC Bedienung des KirschnBot über den Twitchchat. 10.1 Command Erstellen Parameter: Beispiel: !addcom !deincommand Dein Command Text !addcom !hallo Hallo ich bin ein Command. Dies erstellt denn Command “!deincommand” der dazu führt das der Bot “Dein Command Text” ausgibt. Wichtig: Wenn kein Userlevel angegeben wurde, wird automatisch das Userlevel für Normale User benutzt. Dadurch kann jeder dieses Command ausführen 10.2 Command mit Userlevel Auch ist es Möglich ein Command einer bestimmten Usergruppe zugänglich zu machen. Hierfür benutzt man hinter “!addcom” den Userlevel Parameter “-ul=” so hat man die Möglichkeit zu entscheiden ob ein Command nur für Moderatoren, Subscriber oder den Streamer zur Verfügung steht. Parameter: Beispiel: !addcom -ul=mod !deincommand Dein Command Text !addcom -ul=mod !hallo Hallo ich bin ein Command nur für Mods In diesem Beispiel ist der Command “!hallo” nur für Mods und den Streamer ausführbar. Die Parameter für die einzelnen Usergruppen sind: "-ul=sub" "-ul=mod" "-ul=owner" - Nur Subscriber, Moderatoren und der Streamer können diesen command benutzen. - Nur Moderatoren und der Streamer können diesen command benutzen. - Nur der Streamer kann diesen command benutzen. 10.3 Userlevel (Erweitert) Des weiteren ist es Möglich neben der Beschreibung des Userlevels auch möglich den Nummerischen Wert zu Benutzen Parameter: Beispiel: !addcom -ul=100 !deincommand Dein Command Text !addcom -ul=100 !hallo Hallo ich bin ein Command nur für Mods 29 KirschnBot Documentation, Release latest Auch in diesem Beispiel ist der Command “!hallo” nur für Mods und den Streamer ausführbar. Die Standard Parameter für die einzelnen Usergruppen sind: "-ul=500" "-ul=100" "-ul=0" - Nur Subscriber, Moderatoren und der Streamer können diesen command benutzen. - Nur Moderatoren und der Streamer können diesen command benutzen. - Nur der Streamer kann diesen command benutzen. 10.4 Command Editieren Command Text Editieren: Parameter: Beispiel: !editcom text !deincommand Dein Neue Command Text !editcom text !hallo Hallo ich bin der Neue Command Mit dem Command “!editcom text” ist es möglich den Ausgabe Text des Commands zu Editieren. Userlevel Editieren/Hinzufügen: Parameter: Beispiel: !editcom userlevel !deincommand mod !editcom userlevel !hallo mod Durch den Command “!editcom userlevel” und dem Syntax “mod” hinter dem Commands Namen “!hallo” wird dieser Command nur für Moderatoren und höher benutzbar. Natürlich ist auch hier wie bei der Erstellung neben der direkten Angabe des Userlevels auch der Nummerische Wert möglich. Parameter: Beispiel: !editcom userlevel !deincommand 100 !editcom userlevel !hallo 100 Auch hier wird der Command “!hallo” nun durch den Nummerischen Wert “100” nur für Moderatoren und höher benutzbar. Parameter für die Userlevel sind: "viewer" "subscriber" "moderator" "streamer" (Nummerischer (Nummerischer (Nummerischer (Nummerischer Standard: Standard: Standard: Standard: 999) 500) 100) 0) 10.5 Commands Löschen Parameter: Parameter2: Beispiel: Beispiel2: !delcom !remcom !delcom !remcom !deincommand !deinfehl !hallo !hallo Mit dem Command “!delcom” / “!remcom” vor dem Command Namen wird in diesem Beispiel der Command “!hallo” gelöscht und steht dadurch nicht mehr zur Verfügung. 10.6 Weitere Parameter für den Command Text: $query - Gibt alles was der User hinter !command schreibt Parameter: Beispiel: 30 !addcom !deincommand Beispieltext mit $query !addcom !hallo Hallo $query Kapitel 10. Commands IRC KirschnBot Documentation, Release latest Eingabe: Ausgabe: !hallo an alle die das hier Lesen "Hallo an alle die das hier Lesen" $user - Gibt den Usernamen des Users wieder der denn !command ausführt Parameter: Beispiel: Eingabe: Ausgabe: !addcom !deincommand Commandstext mit $user !addcom !hallo Hallo $user !hallo "Hallo (Username)" $[http(https://webseite.com)] - Gibt den Source Code der gewählten Webseite wieder Parameter: Beispiel: Eingabe: Ausgabe: !addcom !deincommand Beispieltext mit $[http(https://webseite.com)] !addcom !8ball $[http(https://apis.rtainc.co/twitchbot/8ball)] !8ball Werde ich diesen Command benutzen? "Zufällige Antwort" $[rnglist(listname)] - Gibt ein Zufälliges Item aus der Angegebenen Liste wieder Parameter: Beispiel: Eingabe: Ausgabe: !addcom !deincommand Beispieltext mit $[rnglist(listname)] !addcom !give Gibt dir $[rnglist(give)] !give "Gibt dir (Ein zufälligen Gegenstand der sich in der Liste "Give" befindet)" [$rngnumber(min,max)] - Gibt eine Zufällige Nummer zwischen Min und Max wieder Parameter: Beispiel: Eingabe: Ausgabe: !addcom !deincommand Beispieltext mit $rngnumber(min,max) !addcom !dice Du Würfelst eine $rngnumber(1,6) !dice "Du Würfelst eine (Zufällige Zahl zwischen 1 und 6)" $[index] - Gibt ein Spezifisches Wort aus der Eingabe Nachricht wieder Parameter: Beispiel1: Eingabe1: Ausgabe1: !addcom !deincommand Beispieltext mit $[index] !addcom !hallo Hallo $[1] !Hallo Ihr Alle zusammen "Hallo Ihr" Beispiel2: Eingabe2: Ausgabe2: !addcom !hallo Hallo $[2] !Hallo Ihr Alle zusammen "Hallo Alle" Beispiel3: Eingabe3: Ausgabe3: !addcom !hallo Hallo $[3] !Hallo Ihr Alle zusammen "Hallo zusammen" Wobei hier die Zahl die anstelle von “index” benutzt wird, den Stellenwert der Wörter des auszugebenden Wortes wiederspiegelt. //// TODO //// NOTE: the “else” variable is triggered, if the query word isn’t available! • $[index]elserngnumber(min,max) - should be self explainatory • $[index]elsernglist(min,max) • $queryelseuser • $queryelsernglist(listname) 10.6. Weitere Parameter für den Command Text: 31 KirschnBot Documentation, Release latest 32 Kapitel 10. Commands IRC KAPITEL 11 Quotes IRC Bedienung des KirschnBot über den Twitchchat. 11.1 Quote Erstellen Paramter: Beispiel: !addquote QuoteName "Dein Quote Text" - Name, Jahreszahl !addquote lustigeszitat "Ich habe etwas lustiges gesagt" - LustigerStreamer, 2016 In diesem Beispiel wird das Quote “lustigeszitat” mit dem Text “‘Ich habe etwas lustiges gesagt” - LustigerStreamer, 2016’ erstellt. Führt man nun im Chat den Befehl “!zitat” oder “!quote” aus, gibt der Bot ein Zufälliges Quote aus der Datenbank aus. Nutzt man hingegen “!zitat QuoteName” oder “!quote QuoteName” so gibt der Bot das gewählte Quote aus. 11.2 Quotes Löschen: Parameter: Parameter2: Beispiel: Beispiel2: !delquote !remquote !delquote !remquote QuoteName QuoteName Lustigeszitat Lustigestitat Mit dem Befehl “!delquote” oder “!remquote” vor dem QuoteNamen wird in diesem Beispiel das Quote “Lustigeszitat” gelöscht und steht dadurch nicht mehr zur Verfügung. 33 KirschnBot Documentation, Release latest 34 Kapitel 11. Quotes IRC KAPITEL 12 Timer IRC Bedienung des KirschenBot über den Twitchchat 12.1 Timer Erstellen Parameter: Beispiel: !addtimer <timername> <time> <lines> Dein Timer Text. !addtimer hallo 5 10 Hallo ich bin ein Timer Dies erstellt den Timer “timername” der dazu führt das der Bot “Dein Timer Text” ineinem interval von “time” und einer Anzahl von Chat “lines” in einem zeitraum von 5 Minuten ausgibt. Wichtig: Die Paramter “time” und “lines” müssen einen Nummerischen Wert besitzen 12.2 Timer Starten & Stoppen Timer Starten Parameter: Beispiel: !starttimer <timername> !starttimer hallo Mit diesem Command wir der Timer mit dem entsprechenden “Timername” gestartet falls dieser zuvor gestoppt wurde. Timer Stoppen Parameter: Beispiel: !stoptimer <timername> !stoptimer hallo Mit diesem Command wird der Timer mit dem entsprechenden “Timernamen” gestoppt. 12.3 Timer Editieren Timer Namen Editieren Parameter: Beispiel: !edittimer name <timername> <newtimername> !edittimer name hallo huhu Mit dem Command “!edittimer name” ist es möglich den Namen des Timers zu Editieren. Timer Text Editieren 35 KirschnBot Documentation, Release latest Parameter: Beispiel: !edittimer text <timername> Dein Neuer Timer Text. !edittimer text hallo Hallo ich bin der Neue Timer. Mit dem Command “!edittimer text” ist es möglich den Ausgabe Text des Timers zu Editieren. Timer Zeit Editieren Parameter: Beispiel: !edittimer time <timername> <newtime> !edittimer time hallo 10 Mit dem Command “!edittimer time” ist es möglich den Ausgabe Interval des Timers zu ändern (in Minuten)*. Wichtig: der Parameter “newtime” muss einen Nummerischen Wert besitzen. Timer Chatlines Editieren Parameter: Beispiel: !edittimer lines <timername> <newlines> !edittimer lines hallo 15 Mit dem Command “!edittimer lines” ist es möglich die benötigten Chat Nachrichten (in einem Zeitraum von 5 Minuten) die benötigt werden damit der Timer Getriggert wird zu ändern Wichtig der Parameter “newlines” muss einen Nummerischen Wert besitzen. 12.4 Timer Löschen Parameter1: Parameter2: Beispiel1: Beispiel2: !deltimer !remtimer !deltimer !remtimer <timername> <timername> hallo hallo Mit dem Command “!deltimer” oder “!remtimer” vor dem Timernamen wird in diesem Beispiel der Timer “hallo” gelöscht und steht dadurch nicht mehr zur verfügung. 12.5 Weitere Parameter für den Timer Text $[http(https://webseite.com)] - Gibt den Source Code der gewählten Webseite wieder Parameter: Beispiel: Ausgabe: !addtimer <timername> <time> <lines> Beispieltext mit $[http(https://webseite.com)] !addtimer 8ball 30 15 $[http(https://apis.rtainc.co/witchbot/8ball)] "Zufällige Antwort" $[rnglist(listname)] - Gibt ein Zufälliges Item aus der Angegebenen Liste wieder Parameter: Beispiel: Ausgabe: !addtimer <timername> <time> <lines> Beispieltext mit $[rnglist(listname)] !addtimer give 10 20 Gibts allen $[rnglist(give)] "Gibt allen (Ein zufälligen Gegenstand der sich in der Liste "give" befindet)" $[rngnumber(min,max)] - Gibt eine Zufällige Nummer zwischen dem Min und Max wert wieder Parameter: Beispiel: Ausgabe: !addtimer <timername> <time> <lines> Beispieltext mit $[rngnumber(min,max)] !addtimer luckynumber 10 30 Die Glückszahl der nächsten 10 Minuten ist $[rngnumber(0,99)] "Die Glückszahl der nächsten 10 Minuten ist: (Zufällige Zahl zwischen 0 und 99)" WICHTIG: Die Parameter “min” & “max” müssen einen Nummerischen Wert besitzen 36 Kapitel 12. Timer IRC
© Copyright 2024 ExpyDoc