DJ4H-CPA

Bot de distribution automatique des points pour le jeu des 4 heures du serveur Développons!

Développons! Jeu des 4 Heures - Détection de Points Automatique (DJ4H-CPA)

Fonctionnement

Le comportement attendu du bot est détaillé dans le cahier des charges.

Mise en place

Prérequis

Python
Pycord (pip install py-cord)

Instructions

Ajouter une variable d'environnement nommée DISCORD_TOKEN avec votre token du bot comme valeur
Démarrer le bot :

python bot.py

Déploiement

Docker

Dans un premier temps, il faut cloner le répertoire GitHub :

git clone https://github.com/Developpons-Discord/DJ4H-CPA .

Pour assurer le bon fonctionnement du bot, il est important de passer le token dans le conteneur en tant que variable d'environnement sous le nom DISCORD_TOKEN.

Les données du bot étant conservées dans le répertoire /conf, il faut donc également ajouter un volume afin de monter un volume de la machine hôte au répertoire /bot/conf.

Voici un example de fichier compose.yaml pour lancer le bot :

name: "DJ4H-CPA"

services:
  bot:
    build: .
    environment:
      - DISCORD_TOKEN="<your_discord_token>"
    volumes:
      - "/local/path:/bot/conf"

Utilisation

Installation

Une fois le bot invité sur le serveur, il est nécessaire de le configurer avec la commande /setup [canal] (temps) (historique). Cette commande permet de spécifier le canal du serveur dans lequel le jeu aura lieu, la durée (en heure) minimum entre deux messages pour marquer un point, ainsi que le canal où seront envoyés l'historique des gains de points.

Paramètres :

canal: discord.TextChannel (obligatoire) : Le canal textuel dédié au jeu.
temps: int (optionnel) : Durée minimum requise entre deux messages pour marquer un point. Cette valeur doit être comprise entre 1et 10. La valeur par défaut est 4.
historique: discord.TextChannel (optionnel) : Un message sera envoyé à chaque fois qu'un nouveau gagnant est désigné.

Remarques :

Il n'est possible d'avoir qu'un seul canal dédié au jeu dans un serveur.

L'usage de cette commande nécessite la permission "Gérer le serveur".

FlenderrAX/DJ4H-CPA