Skip to content

Latest commit

 

History

History
94 lines (68 loc) · 3.87 KB

README.md

File metadata and controls

94 lines (68 loc) · 3.87 KB

Mr_BOT - Bot Discord

Bienvenue sur Mr_BOT, un bot Discord complet et créé de toutes pièces, prêt à être utilisé et modifié selon vos besoins ! Ce projet est actuellement actif et utilise plusieurs API gratuites pour offrir une variété de fonctionnalités à votre serveur Discord.

Fonctionnalités principales

  • Intégration avec l'API Tenor pour la gestion de GIFs.
  • Utilisation de l'API Fluxpoint pour des fonctionnalités supplémentaires.
  • Support d'une base de données (MariaDB) pour la persistance des données.
  • Système de log avec winston et gestion de la durée de rétention des logs.
  • Personnalisable et open source pour ajouter vos propres fonctionnalités.

Prérequis

Avant de pouvoir exécuter le bot, assurez-vous d'avoir les éléments suivants installés :

  • Node.js (version 20.x ou plus)
  • npm
  • Un serveur Discord pour tester le bot
  • Un compte sur Discord Developer Portal pour générer un token de bot
  • Des clés API pour les services Tenor et Fluxpoint (gratuites)

Installation

  1. Cloner le dépôt :

    git clone https://github.com/Ludo-code/Mr_BOT.git
cd Mr_BOT

  2. Installer les dépendances :

    npm install

  3. Configuration de l'environnement :

    Créez un fichier .env à la racine du projet avec les valeurs suivantes :

    BOT_TOKEN=<DISCORD_BOT_TOKEN>
TENOR_API_KEY=<TENOR_API_KEY>
FLUXPOINT_API_KEY=<FLUXPOINT_API_KEY>
UPTIME_KUMA_URL=<UPTIME_KUMA_URL>
DB_NAME=<DATABASE_NAME>
DB_USERNAME=<DATABASE_USERNAME>
DB_PASSWORD=<DATABASE_PASSWORD>
DB_HOST=<DATABASE_ADDRESS_OR_IP>
DB_PORT=<DATABASE_PORT>
DB_DIALECT=mariadb
    • BOT_TOKEN : Le token de votre bot Discord, généré depuis Discord Developer Portal.
    • TENOR_API_KEY : Votre clé API Tenor (pour les GIFs).
    • FLUXPOINT_API_KEY : Votre clé API Fluxpoint.
    • UPTIME_KUMA_URL : Votre URL push uptime kuma mettre vide si vous n'en avez pas.
    • DB_NAME : Nom de la base de données que vous utilisez.
    • DB_USERNAME : Nom d'utilisateur pour la base de données.
    • DB_PASSWORD : Mot de passe pour la base de données.
    • DB_HOST : Adresse ou IP du serveur de base de données.
    • DB_PORT : Port utilisé par la base de données (par défaut pour MariaDB : 3306).
    • DB_DIALECT : mariadb (défini dans l'exemple pour MariaDB, peut être changé selon votre configuration).

  4. Lancer le bot :

    npm start

Système de logs

Le bot utilise winston pour le logging avec rotation automatique des fichiers :

  • Les fichiers de log sont créés quotidiennement avec un nom de fichier basé sur la date (logs/Mr_BOT-DD-MM-YYYY.log).
  • Les anciens fichiers de log sont automatiquement compressés et conservés pendant 180 jours (6 mois).
  • Après 6 mois, les fichiers de log sont automatiquement supprimés.

Pour personnaliser la configuration des logs, vous pouvez modifier le fichier logger dans le code source, en particulier les options filename, maxSize, maxFiles, et zippedArchive dans le transport DailyRotateFile.

API utilisées

  • Tenor API - Utilisée pour envoyer des GIFs directement dans les canaux Discord.
  • Fluxpoint API - Utilisée pour des fonctionnalités diverses comme des citations, images, etc.

Contributions

Les contributions sont les bienvenues ! Si vous avez des idées de nouvelles fonctionnalités ou trouvez des bugs, n'hésitez pas à ouvrir une issue ou une pull request.

Support

Si vous avez besoin d'aide pour configurer ou utiliser le bot, n'hésitez pas à me contacter via un ticket sur GitHub ou sur Discord.

Projet actif et en développement constant !