Aller au contenu
Noko

Installation

Suivez ces étapes pour installer correctement le script sur votre bot.

Étapes d’installation

Section intitulée « Étapes d’installation »

  1. Téléchargez le module & décompresser le dossier

    Récupérez le dossier du module (souvent au format .zip ou .rar) depuis la source officielle. Utilisez un outil comme WinRAR ou 7-Zip pour extraire le dossier du script sur votre ordinateur.

  2. Création de vos clefs API Twitch

    • Connexion à la plateforme développeur Twitch
      Rendez-vous sur : Développeur pour vous connecter ou pour vous créer un compte afin d’accéder à la console développeur.

    • Accès à la console développeur
      Une fois connecté, se rendre sur la console des applications : Console

    • Création de votre application
      Cliquez sur “Créer une application” ou se rendre sur ce lien : Créer une application
      Remplissez les champs suivants :
      • Nom (le nom de votre application, exemple : BotTwitch)
      • URL de redirection OAuth : http://localhost
      • Catégorie : Application Integration
      • Type de client : Confidentiel

    • Récupération des clés
      Une fois l’application créée, cliquez sur “Gérer” à côté de votre application.
      Copiez votre Identifiant client (Client ID)
      Cliquez sur “Nouveau secret” pour générer votre Identifiant secret et copiez le (Client Secret)
      Dans la prochaine étape, nous devrons les encoder dans le fichier .env (twitchClientID & twitchClientSecret)

  3. Configurez les variables d’environnement

    Ouvrez le fichier .env fourni avec le script et ajoutez & modifiez les variables d’environnement nécessaires au votre pour le bon fonctionnement du module.

    • twitchClientID : La clef client ID de l’API Twitch (Voir étape 2)
    • twitchClientSecret : La clef secrète de l’API Twitch (Voir étape 2)
    • twitchUserAccount : ⚠️ Le pseudo exacte du streamer sur twitch
    • twitchIDAccount : ID du compte twitch (Le laisser vide, il va automatiquement se remplir)
    • twitchChannelPostLive : ID du salon où les notifications de live seront envoyées
    • twitchRoleViewerID : ID du rôle des viewers (Généralement le rôle membre pour notifier le serveur entier ou un rôle créé par vos soins afin que les membres choissent ce rôle pour être averti d’un nouveau live !)
    • twitchChannelFollowerID : ID du salon vocal qui va être mis à jour concernant le nombre de follower. Le laisser vide si vous ne souhaitez pas mettre à jour de salon vocal.

  4. Copier/déplacer les fichiers/les codes dans votre projet

    Copiez les fichiers suivants dans le(s) dossier(s) approprié(s) de votre projet bot Discord :

    • utils/twitch-notification.js : dans le dossier de vos utilitaires
    • utils/environment.js : dans le dossier de vos utilitaires

    Copiez également le code d’indexation du module dans votre fichier index.js principal. Dans ce fichier, nous avons ajouté prisma directement lié à l’objet “client”, mettez ce code dans le vôtre ou ajuster le selon votre façon d’utiliser prisma.

    ❗ Créé un dossier Images/screen-live/, il sera utilisé comme tampon pour le stockage des images. Une fois le live terminé, le contenu du dossier sera supprimé. Dans le dossier Images/, veuillez ajouter l’image de début de stream (online.png) et l’image de fin de stream (offline.png), de préférence en 1920*1080 pixels.

  5. Mettez à jour le schéma de la base de données

    Ajoutez le modèle de données pour la récupération des notifications de live twitch dans votre fichier prisma/schema.prisma et exécutez les migrations nécessaires pour appliquer les changements à votre base de données. Exécution de la commande suivante :

    Fenêtre du terminal
    npx prisma generate
    

    npx prisma migrate dev --name add_twitch_notification

  6. Installez les dépendances

    Assurez-vous que les dépendances nécessaires sont installées en vérifiant votre package.json et en exécutant :

    Fenêtre du terminal
    npm install

  7. Redémarrez le bot

    Redémarrez votre bot pour que le script soit pris en compte.

Conseils

Section intitulée « Conseils »
  • Dans le fichier utils/twitch-notification.js, vous pouvez modifier le temps en minutes concernant la vérification avant qu’un live passe en terminé. Il faut modifier la variable attemptReconnectMax qui est actuellement à 10 minutes.