Installation

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

Attention

Ces instructions supposent que vous avez déjà un bot Discord fonctionnel et que vous savez comment ajouter des scripts à votre bot.

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

   • Connexion à la plateforme développeur Google
     Rendez-vous sur : Dasboard pour vous connecter ou pour vous créer un compte afin d’accéder au dashboard.
   
   
   • Créer un projet
     Cliquer sur Create project, puis encoder le nom de son projet et confirmer la création.
   
   
   • Activation de l’API Youtube sur votre compte Google
     Rendez-vous sur : Youtube API pour activer l’API Google.
   
   

   • Création de votre application
     Cliquez sur Credentials ou se rendre sur ce lien : Credentials

     
     

     Cliquer sur Create credentials, puis choisir API Keys

     
     

     Remplissez les champs suivants :

     • Nom (le nom de votre application, exemple : BotYoutube)
     • Application restrictions => IP Addresses et vous encodez l’adresse ip de votre VPS/votre machine
     • Dans la partie API restrictions, sélectionner YouTube Data API v3

     Puis confirmer la création. Une clef sera affichée pour que vous puissiez la mettre dans le fichier .env.

   
   
   • ⚠️ Si vous ne souhaitez pas payer, vous avez un quotas par jour à respecter
     Via le module vous pouvez encoder jusqu’à 5 comptes Youtube. Si vous en souhaitez plus, il faudra l’ajuster sur la page Quotas
   
   

   Précautions !

   Conservez ces informations en sécurité ! 🔒
   Ne partagez jamais votre clef avec personne !
   Cet identifiant sert à authentifier votre application auprès de Youtube et obtenir les réponses à vos requêtes.

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.

   • youtubeChannelID : ID du salon où les notifications de Youtube seront envoyées
   • youtubeRoleID : ID du rôle des personnes souhaitant reçevoir les notifications (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’une nouvelle vidéo !)
   • youtubeAPIKey : La clef de l’API Youtube (Voir étape 2)
   • youtubeChannelFollowerID : ID du salon vocal qui va être mis à jour concernant le nombre de follower (Configurer le compte dans le code, voir l’étape suivante)

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 :

   • commands/notification/notification-add.js : dans le dossier de vos commandes
   • commands/notification/notification-list.js : dans le dossier de vos commandes
   • commands/notification/notification-remove.js : dans le dossier de vos commandes
   • utils/notification/youtube.js : dans le dossier de vos utilitaires
   • utils/utils.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.

   ❗ Si vous le souhaitez, vous pouvez modifier PSEUDO_UPDATE_CHANNEL_STAT afin de mettre à jour le channel statistique ou commenter cette ligne. Le pseudo doit être le même que celui encodé en base de données.

   

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 nouvelle vidéo youtube 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 :

   npx prisma generate
   
   npx prisma migrate dev --name add_youtube_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 :

   npm install

7. Redémarrez le bot

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

Modifier les permissions des commandes

Accédez à votre serveur, puis allez dans Paramètres du serveur > Intégrations. Dans la section Bots et applications, cliquez sur votre bot.

Dans l’onglet Commandes, vous pouvez ajouter des dérogations pour gérer les permissions des différentes commandes ajoutées par notre module.

Si vous ne configurez pas ces permissions, tous les membres de votre serveur auront accès aux commandes du module.

Conseils

• Pour la commande /notification-add, vous devez encoder le nom de la chaine youtube qui est indiqué dans l’url de la chaine. Exemple : https://www.youtube.com/@Joyca => Le nom à encoder lors de l’utilisation de la commande est Joyca (Sans le @).