Skip to content

Latest commit

 

History

History
391 lines (267 loc) · 12.2 KB

README.md

File metadata and controls

391 lines (267 loc) · 12.2 KB
Raw

🎉 Discord Task Master (Bot) 🎉

Votre assistant polyvalent pour la gestion administrative sur Discord.

discord_bot


🛠️ Fonctionnalités Clés :

Note

Simplifie la modération, facilite la communication, et optimise votre serveur de manière efficace.



Attribution de rôle via commande
  • Description : Permet de gérer l'accès aux canaux spécifiques ou aux fonctionnalités du serveur en attribuant des rôles aux utilisateurs via des commandes Discord.
  • Avantages : Facilite la gestion des autorisations et garantit une expérience utilisateur personnalisée et sécurisée.

Accueil des nouveaux utilisateurs
  • Description : Accueille automatiquement les nouveaux membres en les dirigeant vers les règles et conditions générales du serveur.
  • Avantages : Établit un environnement accueillant et bien géré dès l'arrivée des nouveaux membres, favorisant ainsi une intégration harmonieuse.

Décompte pour un événement
  • Description : Affiche un décompte jusqu'à une date et une heure spécifiques pour informer les membres de l'approche d'événements importants.
  • Avantages : Fournit une anticipation et une organisation efficace autour des événements communautaires ou des échéances importantes.

Salutation quotidienne
  • Description : Accueille les utilisateurs une fois par jour lors de leur première interaction, renforçant ainsi l'engagement et le sentiment de communauté.
  • Avantages : Maintient une interaction régulière et personnalisée avec les membres, augmentant ainsi l'activité et la fidélité au serveur.

⚠️Modération automatique 🛠️
  • Description : Filtrage automatique des contenus inappropriés, gestion des spams et des comportements indésirables pour maintenir un environnement sécurisé.
  • Avantages : Soulage les modérateurs en automatisant les tâches de gestion et en assurant une application cohérente des règles du serveur.

⚠️Systèmes de vote ou de sondage 🛠️
  • Description : Facilitation de l'organisation de votes ou de sondages parmi les membres pour des décisions communautaires.
  • Avantages : Encourage la participation et la démocratie au sein de la communauté, favorisant ainsi un sentiment d'appartenance et d'engagement.

⚠️Intégrations avec des services externes 🛠️
  • Description : Intégration avec d'autres bots ou services externes comme des bots musicaux, des systèmes de support client, etc.
  • Avantages : Enrichit l'expérience utilisateur en offrant des fonctionnalités supplémentaires et en connectant le serveur à d'autres plateformes populaires.

⚠️Analyse des données et rapports 🛠️
  • Description : Fourniture de statistiques sur l'activité du serveur, les niveaux de participation des membres, etc., pour une prise de décision informée.
  • Avantages : Aide à évaluer l'efficacité des stratégies de gestion et à ajuster les paramètres pour optimiser l'expérience utilisateur.

⚠️Personnalisation et réglages 🛠️
  • Description : Permet aux administrateurs de personnaliser les comportements du bot selon les besoins spécifiques du serveur.
  • Avantages : Offre une flexibilité maximale pour répondre aux exigences uniques de la communauté Discord et pour ajuster le fonctionnement du bot en fonction des retours des utilisateurs.




📋 Prérequis :

Warning

⚠️ Avant de commencer, assurez-vous d'avoir les éléments suivants installés et configurés sur votre système :



1. Système d'Exploitation :

  • Windows 10, macOS, ou Linux (Ubuntu/Debian recommandé).



2. Node.js et npm :

  • Vérifiez si Node.js et npm sont déjà installés :

    node -v
npm -v

  • Installation de Node.js et npm :

    • Sur macOS avec Homebrew :

      brew install node

    • Sur Linux (Ubuntu/Debian) :

      sudo apt update
sudo apt install nodejs npm

    • Sur Windows :

      Vous pouvez installer Node.js en téléchargeant l'installateur depuis nodejs.org et en suivant les instructions d'installation.



3. Création d'un Compte Discord et d'une Application de Bot

  • Créez un compte sur Discord :


  • Créez une application de bot sur le Discord Developer Portal :

    • Allez sur Discord Developer Portal.
    • Cliquez sur New Application.
    • Donnez un nom à votre application, puis cliquez sur Create.
    • Dans le menu de gauche, sélectionnez Bot.
    • Cliquez sur Add Bot.
    • Configurez les permissions et copiez le token du bot pour une utilisation ultérieure dans votre application.




⚙️ Installation :

1. Clonage du Répertoire

  • Placez-vous dans le répertoire où vous souhaitez cloner le dépôt et exécutez la commande suivante pour cloner le projet depuis GitHub :

    git clone [email protected]:Xxzer042xX/discord_bot.git



2. Installation des Dépendances

  • Allez dans le répertoire fraîchement cloné (racine du projet) :

    cd discord_bot



  • Installez les dépendances nécessaires pour votre bot Discord à l'aide de npm : 
    # Cette commande npm installera les dépendances nécessaires et générera les fichiers package.json et package-lock.json

npm install discord.js schedule dotenv



3. Configuration des Variables d'Environnement

  • Créez un fichier .env à la racine du projet pour stocker votre token Discord et d'autres configurations sensibles :

    touch .env



  • Ajoutez votre token Discord dans le fichier .env en utilisant echo :

    echo "DISCORD_TOKEN=VotreTokenDiscord" >> .env

    Remplacez VotreTokenDiscord par votre véritable token Discord.



4. Structure du Projet

  • Assurez-vous que votre structure de projet ressemble à ceci après avoir suivi les étapes :

    ├── node_modules/
├── README.md
├── commande.js
├── greetedMembers.js
├── images
├── index.js
├── package-lock.json
├── package.json
├── scheduledTask.js
└── .env




🔧 Personnalisation :

Warning

⚠️ Il est essentiel de personnaliser les ID des salons, les noms de commande et les rôles, afin que le Bot active ses fonctionnalités ! ⚠️



⚠️ 1. Ajouter un rôle spécifique à l'utilisateur :

➡ Ouvrez le fichier commands.js

  • Personnalisez ID_DU_ROLE dans handlePiscineCommand
  • Personnalisez votre message de confirmation dans handlePiscineCommand
  • Personnalisez votre message d'erreur dans handlePiscineCommand

➡ Ouvrez le fichier index.js

  • Personnalisez la commande !votrecommande dans handleCustomCommand avec le nom de commande de votre choix pour attribuer le rôle.



⚠️ 2. Gérer les salutations quotidiennes :

➡ Ouvrez le fichier commands.js

  • Personnalisez ID_DU_CANAL dans handleDailyGreetings
  • Personnalisez votre message dans handleDailyGreetings
  • Remplacez ID_DU_CANAL_DE_BIENVENUE dans handleDailyGreetings par l'ID du canal où vous souhaitez envoyer les messages de bienvenue.



⚠️ 3. Messages :

➡ Ouvrez le fichier scheduledTasks.js

  • Personnalisez ID_DU_CANAL dans countdownToAugust19 pour spécifier l'ID du canal où envoyer les messages de décompte.
  • Personnalisez ID_DE_L_EVENEMENT dans countdownToAugust19 pour l'ID réel de votre événement Discord.




🚀 Déploiement



  • Pour déployer votre bot Discord, suivez ces étapes :

  1. Ajout du Bot à Votre Serveur Discord

    • Assurez-vous que votre bot a été ajouté à votre serveur Discord via le Discord Developer Portal.
    • Accordez-lui les permissions nécessaires sur votre serveur Discord.

  2. Lancement du Bot

    • Pour lancer votre bot, vous pouvez utiliser la commande suivante dans votre terminal à la racine de votre projet :

      node index.js &

    • L'ajout de & à la fin de la commande permet à Node.js de lancer le processus en arrière-plan tout en laissant le terminal disponible pour d'autres commandes. Cependant, ce n'est pas une solution robuste pour la gestion à long terme.



Tip

Exécution en Tâche de Fond avec PM2

  • PM2 est un gestionnaire de processus Node.js qui permet de démarrer, arrêter et gérer des applications Node.js de manière robuste.

  • Pour installer PM2 globalement sur votre système, utilisez la commande suivante (cela nécessite npm installé) :

    npm install pm2 -g

  • Une fois PM2 installé, vous pouvez démarrer votre bot en tant que processus PM2 en utilisant la commande :

    pm2 start index.js --name "discord-bot"

  • Cela lancera votre bot Discord en arrière-plan sous le nom "discord-bot". Vous pouvez gérer ce processus avec des commandes telles que pm2 restart, pm2 stop, pm2 delete, etc.

  • Pour plus de détails sur la configuration et les fonctionnalités de PM2, consultez la documentation officielle de PM2.



Note

  • Je recommande l'utilisation de PM2 pour le déploiement de votre bot Discord, car cela garantit une disponibilité continue et une gestion facile des processus Node.js

  • PM2 offre également des fonctionnalités telles que le redémarrage automatique en cas de panne, la surveillance des ressources, et plus encore.




🤝 Contribution :

Note

Contribuez au développement de DiscordTaskMasterBot. Rejoignez-nous et faites la différence !


Comment Contribuer ? :
  1. Forkez le dépôt. 
    git clone [email protected]:Xxzer042xX/discord_bot.git
  2. Créez une branche pour vos modifications 
    git checkout -b feature-ameliorations
  3. Commitez vos changements 
    git commit -am 'Ajout de nouvelles fonctionnalités'
  4. Poussez la branche 
    git push origin feature-ameliorations
  5. Créez une nouvelle Pull Request.




🆘 Besoin d'Aide ?


Si vous rencontrez des problèmes lors de l'installation ou si vous avez des questions, n'hésitez pas à consulter les ressources suivantes :