WhatThePhoqueBOT

Bienvenue sur la documentation de WhatThePhoqueBOT !

WTPBot est un bot utile à FRANCE MEMES, il permet d'automatiser des tâches répetitives aux modérateurs, créer des évènements et gérer le support. Le bot a été design pour marcher sur 2 serveurs, le serveur de production et le serveur staff.

Ce bot n'est pas un "Bot Discord public", nous n'avons pas l'infrastructure pour et nous gardons le process à usage privé sur FRANCE MEMES pour le moment.

Document concernant la mise à jour vers la version 2.2.0 de WTPBot : https://docs.google.com/document/d/1zoPg5Qn9ekLlfRBoHV0a8ynJmao0QODnw4AdbL5DAz0/edit?usp=sharing

Prérequis

Installation

Cloner le projet

git clone https://github.com/LotharieSlayer/wtpbot/

Passer MongoDB en mode Replica Set (facultatif)

Documentation MongoDB - Replica Set

Pour Linux :

Aller dans /etc/mongod.conf
Décommenter les lignes suivantes et donner un nom à votre replica

replication:
   replSetName: "rs0"

Redémarrer MongoDB
mongosh -> rs.initiate()

Pour Windows :

Lancer un terminal
mongod --port 27017 --dbpath "C:\ce que vous voulez tant que c'est vide" --replSet rs1 --bind_ip 127.0.0.1
mongosh -> rs.initiate()
Laisser le terminal ouvert

Entrer le token .env

Dans src/, créer un fichier .env contenant le token de votre bot donné par Discord.
Mettez votre token de la manière suivante : TOKEN="votre token"

Si vous n'avez aucune idée de ce qu'est un token Discord, vous aurez plus d'infos sur la documentation officielle ou en tapant simplement sur Google/Youtube ("Comment avoir le token de mon bot sur Discord")

Une fois tout ça fait, il faut générer un URL pour inviter votre bot, vous pouvez le faire depuis le dashboard Discord, mais voilà quelques informations.

Mettre votre bot sur votre serveur Discord

Permissions (facultatif)

Si vous êtes familier avec les permissions vous savez sûrement que vous devez les énumérer dans l'URL que vous allez générer pour inviter le bot dans votre serveur. La permission 8 est nécessaire pour TOUTES les commandes. Si vous n'avez pas l'utilité de ce code 8 (qui veut dire admin), cherchez simplement le repository du plugin et regardez selon le README de ce dernier. Dans le doute, si vous ne connaissez pas les permissions nécessaires au bon fonctionnement de votre bot, laissez le code 8 dans l'URL plus bas.

Client ID (obligatoire)

Enfin, vous n'avez plus qu'à chercher le Client ID de votre bot sur le dashboard de Discord et le remplacer dans l'URL au niveau de VOTRE_CLIENT_ID.

https://discord.com/api/oauth2/authorize?client_id=VOTRE_CLIENT_ID&permissions=8&scope=bot%20applications.commands

Copiez-coller ce lien dans un navigateur et tadaaa !

Démarrage

npm run start ou node main.js depuis src/ : Lancer le bot (production)
npm run dev : Lancer le bot (développement)

Gestion des plugins (Linux seulement)

npm run first : Télécharger les plugins pour la première fois
npm run update : Installer/Supprimer/Mettre à jour des plugins depuis le fichier plugins.list avec des repositories provenant de GitHub. (cf. src/files/plugins.list)
npm run rebase : Réinitialiser les plugins et les retélécharger de manière clean depuis GitHub.
npm run list : Afficher tous les plugins téléchargés et actifs

License (CC BY-NC-ND 4.0)

This work is licensed under a Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License.