🛡️ Bot Discord OTKR Guardian

Ce bot Discord a vu le jour pour pouvoir gérer principalement les rôles des utilisateurs compliqués.

📜 Sommaire

• Commande Discord
• Prérequis
• Création du Bot
• .env
• Lancement du Bot

🧑‍💻 Commandes Discord

Il possède à ce jour 5 commandes. Afin de les utiliser, il faudra placer le rôle OTKR Guardian au-dessus des rôles qu'il doit gérer dans vos paramètres de serveur :

1. choosechannel : permet de sélectionner le salon unique où les commandes pourront être effectuées. Seul un administrateur peut utiliser cette commande :

   /choosechannel channel:#général
   

2. roleban : permet de bloquer l'ajout de rôle à une ou plusieurs personnes :

   /roleban 
   

3. roledeban : permet de débloquer un utilisateur si des rôles lui ont été bannis :

   /roledeban 
   

4. allroleban : permet d'enregistrer des rôles que personne ne doit posséder :

   /allroleban 
   

5. allroledeban : permet d’enlever les rôles bannis de la liste :

   /allroledeban 
   

6. exemptrole : permet d'exempter certains utilisateurs de la liste globale du serveur :

   /exemptrole 
   

7. alertadmin : permet d'enregistrer des membres pour qu'il soit notifié lorsque le Bot est expluser (cette fonctionnalité ne marche que si les utilisateurs séléctionné sont présent sur un autre serveur ou le Bot est également présent) :

   /alertadmin 
   

⚙️ Prérequis

1. Pour pouvoir utiliser le Bot, il vous faudra Python installé sur votre machine que vous pourrez retrouver ici :

   https://www.python.org/downloads/

2. Vous pouvez créer un environnement virtuel Python, cette étape est optionnelle :

   Créer un environnement virtuel :

   python -m venv "nom de l'environnement"

   Entrer dans l'environnement :

   ."nom de l'environnement"/Scripts/activate

   Sortir de l'environnement :

   deactivate

3. Installation de la dépendance Discord qui permet de pouvoir interagir avec Discord :

   pip install discord.py

4. Installation de la dépendance dotenv qui permet de pouvoir récupérer les informations du fichier .env :

   pip install python-dotenv

🤖 Création du Bot

Tout d'abord, votre Bot Discord doit être sur la plateforme Discord Dev :

https://discord.com/developers/applications

1. Après avoir créé votre Bot, vous devrez récupérer le Token pour pouvoir par la suite le connecter à votre programme :

   Pour ce faire, dans la partie settings, allez dans Bot puis cliquez sur le bouton Reset Token et copiez le Token.

2. Sur la même page, dans la partie Privileged Gateway Intents, vous devrez cocher Presence Intent, Server Members Intent et Message Content Intent. Cela permettra de voir la présence du Bot...

3. Toujours dans settings, mais cette fois-ci dans la catégorie Installation, dans les scopes après application.commands, vous devrez rajouter le terme "bot". Un nouveau champ apparaîtra et vous permettra de donner les permissions qui seront demandées à l'ajout du Bot dans un serveur.

4. Plus haut dans Installation Contexts, vous allez décocher la case User Install pour qu'ainsi l'ajout du Bot se fasse uniquement dans des serveurs, ici appelés Guilds.

5. Vous trouverez juste en dessous une URL, cette URL vous permettra d'ajouter le bot dans un serveur. Pour ce faire, copiez-la et collez-la sur une nouvelle page Web.

🔒 .env

Dans le même dossier que votre code Python, il vous faudra ajouter un fichier .env qui contiendra en lui les données sensibles, ici le Token du Bot. Pour ce projet, vous allez entrer :

   DISCORD_TOKEN="Votre token, attention à ne pas mettre de guillemets ou d'espace après le signe ="

🚀 Lancement du Bot

Pour lancer le bot, vous allez devoir entrer cette commande dans le terminal, depuis la racine du projet :

python main.py

Une fois lancé, une console interactive est disponible dans le terminal pour piloter le bot (tapez help pour voir la liste des commandes : lister les serveurs, les rôles, les membres, ou donner un rôle à quelqu'un).

📂 Structure du projet

main.py               # Point d'entrée : démarre le bot
core/                  # Configuration, instance du bot, stockage, console interactive
events/                # Gestion des événements Discord (on_ready, on_member_update, ...)
commands/              # Une commande slash (ou un groupe de commandes liées) par fichier
data/                  # Données persistées (roles_to_remove.json)