Installation

Befolgen Sie diese Schritte, um das Skript korrekt in Ihren Bot zu installieren.

Achtung

Diese Anweisungen setzen voraus, dass Sie bereits einen funktionierenden Discord-Bot haben und wissen, wie man Skripte zu Ihrem Bot hinzufügt.

Installationsschritte

1. Modul herunterladen & Ordner entpacken

   Laden Sie den Modulordner (meist im .zip- oder .rar-Format) von der offiziellen Quelle herunter. Verwenden Sie ein Tool wie WinRAR oder 7-Zip, um den Skript-Ordner auf Ihrem Computer zu entpacken.

2. Erstellen Sie Ihre Twitch-API-Schlüssel

   • Anmeldung auf der Twitch-Entwicklerplattform
     Besuchen Sie: Entwickler, um sich anzumelden oder ein Konto zu erstellen und auf die Entwicklerkonsole zuzugreifen.
   
   
   • Zugriff auf die Entwicklerkonsole
     Nach der Anmeldung gehen Sie zur Anwendungskonsole: Konsole
   
   
   • Erstellen Sie Ihre Anwendung
     Klicken Sie auf “Anwendung erstellen” oder besuchen Sie diesen Link: App erstellen
     Füllen Sie die folgenden Felder aus:
     • Name (der Name Ihrer Anwendung, Beispiel: BotTwitch)
     • OAuth-Weiterleitungs-URL: http://localhost
     • Kategorie: Application Integration
     • Client-Typ: Confidential
   
   
   • Abrufen der Schlüssel
     Nach der Erstellung der Anwendung klicken Sie auf “Verwalten” neben Ihrer Anwendung.
     Kopieren Sie Ihre Client-ID
     Klicken Sie auf “Neues Geheimnis”, um Ihr Client-Secret zu generieren und kopieren Sie es
     Im nächsten Schritt müssen wir diese in der .env-Datei kodieren (twitchClientID & twitchClientSecret)
   
   

   Vorsichtsmaßnahmen!

   Bewahren Sie diese Informationen sicher auf! 🔒
   Teilen Sie niemals Ihre Client-ID und Ihr Secret mit anderen!
   Diese Anmeldedaten dienen zur Authentifizierung Ihrer Anwendung bei Twitch und zum Erhalt von OAuth-Tokens für die Twitch-API.

3. Konfigurieren Sie die Umgebungsvariablen

   Öffnen Sie die mit dem Skript gelieferte .env-Datei und fügen Sie die für das Modul erforderlichen Umgebungsvariablen hinzu bzw. ändern Sie diese.

   • twitchClientID : Der Client-ID-Schlüssel der Twitch-API (Siehe Schritt 2)
   • twitchClientSecret : Der geheime Schlüssel der Twitch-API (Siehe Schritt 2)
   • twitchUserAccount : ⚠️ Der exakte Benutzername des Streamers auf Twitch
   • twitchIDAccount : Twitch-Account-ID (Leer lassen, wird automatisch ausgefüllt)
   • twitchChannelPostLive : ID des Kanals, in dem Live-Benachrichtigungen gesendet werden
   • twitchRoleViewerID : ID der Zuschauer-Rolle (Üblicherweise die Mitgliederrolle für Server-weite Benachrichtigungen oder eine benutzerdefinierte Rolle, damit Mitglieder diese Rolle für Stream-Benachrichtigungen wählen können!)
   • twitchChannelFollowerID: ID des Sprachchats, der hinsichtlich der Anzahl der Follower aktualisiert werden soll. Lassen Sie das Feld leer, wenn Sie keinen Sprachchat aktualisieren möchten.

4. Dateien/Code in Ihr Projekt kopieren/verschieben

   Kopieren Sie die folgenden Dateien in die entsprechenden Ordner Ihres Discord-Bot-Projekts:

   • utils/twitch-notification.js : in Ihren Utilities-Ordner
   • utils/environment.js : in Ihren Utilities-Ordner

   Kopieren Sie auch den Modul-Initialisierungscode in Ihre Hauptdatei index.js. In dieser Datei haben wir Prisma direkt mit dem “client”-Objekt verknüpft - fügen Sie diesen Code in Ihren eigenen ein oder passen Sie ihn entsprechend Ihrer Prisma-Nutzung an.

   ❗ Erstellen Sie einen Images/screen-live/-Ordner, der als Puffer für die Bildspeicherung dient. Nach Beendigung des Streams wird der Ordnerinhalt gelöscht. Fügen Sie im Images/-Ordner das Stream-Start-Bild (online.png) und das Stream-Ende-Bild (offline.png) hinzu, vorzugsweise in 1920*1080 Pixeln.

5. Aktualisieren Sie das Datenbankschema

   Fügen Sie das Datenmodell für Twitch-Live-Benachrichtigungen in Ihre prisma/schema.prisma-Datei ein und führen Sie die erforderlichen Migrationen durch, um die Änderungen in Ihrer Datenbank anzuwenden. Führen Sie den folgenden Befehl aus:

   npx prisma generate
   
   npx prisma migrate dev --name add_twitch_notification

6. Installieren Sie die Abhängigkeiten

   Stellen Sie sicher, dass die erforderlichen Abhängigkeiten installiert sind, indem Sie Ihre package.json überprüfen und ausführen:

   npm install

7. Starten Sie den Bot neu

   Starten Sie Ihren Bot neu, damit das Skript geladen wird.

Tipps

• In der Datei utils/twitch-notification.js können Sie die Zeit in Minuten für die Überprüfung ändern, bevor ein Stream als beendet markiert wird. Ändern Sie die Variable attemptReconnectMax, die derzeit auf 10 Minuten eingestellt ist.