tdaron / EPLBot

EPLBot sources repository

Home Page:https://discord.gg/9wKTDtPbvm

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

README.md

Ce dépôt contient les sources du bot EPLBot présent sur le discord de l'École Polytechnique de Louvain-la-Neuve (EPL).


Prérequis

Avant de commencer, assurez-vous d'avoir les éléments suivants :

  • Java Development Kit (JDK) 17 installé sur votre machine.
  • Un compte Discord pour créer un bot et obtenir un jeton d'authentification.
  • Gradle installé (ou vous pouvez utiliser la version fournie avec le projet).

Installation

  1. Clonez ce dépôt sur votre machine :

    git clone https://github.com/Hokkaydo/EPLBot.git
  2. Accédez au répertoire du projet :

    cd eplbot
  3. Créez un répertoire pour la persistence:

    mkdir persistence
  4. Compilez le projet en exécutant la commande :

    ./gradlew shadowJar
  5. Ajoutez les variables d'environnement :

    DISCORD_BOT_TOKEN=votre-jeton
    TEST_DISCORD_ID=id-de-votre-discord-de-test
  6. Exécutez le bot Discord en utilisant la commande :

      ./gradlew run

Docker

Pour executer le bot avec docker, voici la marche à suivre.

  1. Build l'image Docker

    docker build . -t eplbot
  2. Lancer le docker

        docker run --rm -e docker run --rm  -e DISCORD_BOT_TOKEN=token -e TEST_DISCORD_ID=id-de-votre-discord-de-test -t eplbot

Configuration du bot Discord

Le bot propose un système modulaire permettant d'activer et désactiver les modules via les commandes Discord /enable <module> et /disable <module>.

Contribution

Les contributions à ce projet sont les bienvenues. Si vous souhaitez apporter des améliorations, veuillez créer une branche à partir de la branche master, effectuer vos modifications et soumettre une Pull Request (PR).

Afin de savoir ce qui est prévu ou en cours, n'hésitez pas à consulter le kanban du projet.

Ressources

Licence

Ce projet est sous licence GNU GPLv3.

About

EPLBot sources repository

https://discord.gg/9wKTDtPbvm

License:GNU General Public License v3.0


Languages

Language:Java 99.9%Language:Dockerfile 0.1%