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 Token Bearer Twitter

   • Connexion à la plateforme développeur Twitter
     Rendez-vous sur : Dasboard pour vous connecter ou pour vous créer un compte afin d’accéder au dashboard.
     Si c’est la première fois, vous devrez choisir un abonnement, ou cliquer sur Sign up for Free Account.
     Écrire une description de l’utilisation de leur API, pour notre cas voici un exemple en anglais :
     

     Retrieving a user’s ID allows us to access their recent tweets, analyze updates in real time, and automatically share them on our Discord server. This keeps the community informed of the latest messages and activities. All while linking back to Twitter so they can comment on the messages.

     
     Vous cochez les cases pour valider votre demande et puis vous cliquez sur Soumette.
   
   

   • Récupération de votre token bearer votre application
     Rendez-vous sur la page suivante : Projects and apps

     
     

     Vous avez un projet déjà créé avec un nom auto-généré, en sachant que vous n’avez droit qu’à une seule application en tant qu’abonnement gratuit.

     
     

     Sur le projet visible sur la page, cliquez sur l’engrenage App Settings, puis sur Keys and tokens.
     Dans la partie Authentication Tokens, cliquez sur Generate pour le Bearer Token.
     Le bearer token sera affiché pour que vous puissiez la mettre dans le fichier .env.

   
   
   • ⚠️ Si vous ne souhaitez pas payer, vous avez un quotas par tranche de 15 minutes à respecter
     Via le module vous pouvez encoder jusqu’à 1 compte Twitter. 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 token bearer avec personne !
   Cet identifiant sert à authentifier votre application auprès de Twitter 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.

   • twitterChannelID : ID du salon où les notifications des tweets seront envoyés
   • twitterRoleID : 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’un nouveau tweet !)
   • twitterTokenBearer : Le token bearer de l’API Twitter (Voir étape 2)
   • twitterChannelFollowerID : ID du salon vocal qui va être mis à jour concernant le nombre d’abonné (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/twitter.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_twitter_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 du compte twitter qui est indiqué dans l’url de la page. Exemple : https://x.com/JoycaOff => Le nom à encoder lors de l’utilisation de la commande est JoycaOff (Sans le @ du pseudo).