From f6c36b76ffaf7108b48c4d9e0d75f88ccd3571d1 Mon Sep 17 00:00:00 2001 From: Adrian Amaglio Date: Wed, 1 Apr 2020 12:35:19 +0200 Subject: [PATCH] update --- .gitignore | 1 + README.md | 25 +++++++++++++++++++++++++ index.html | 3 ++- 3 files changed, 28 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 15813be..1612f74 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ package-lock.json node_modules/ +.env diff --git a/README.md b/README.md index 5b1dfd6..1e368ea 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ Un petit bot d'éduc pop pour Discord (WIP). Il permet de voir qui secoue les mains dans une discussion vocale. +## Contribuer +Pour donner votre avis, proposer une modification ou amélioration, contactez nous via le [formulaire de Jean-Cloud](https://jean-cloud.net#contact) + +Pour proposer une modification, n’hésitez pas à faire une pull request ! + ## Utilisation ### Installer le bot dans le serveur Discord @@ -48,3 +53,23 @@ Pour des raisons de visibilités, le message utilisateur et les anciens messages #### Interface web Une interface web permet de suivre l’état des compteurs sans être secoué par un chat en folie. +## Lancer sa propre instance +Vu que le bot peut lire tous vos messages, il est normal de vouloir héberger sa propre instance ! +Il faut suivre la documentation discord pour la création d’un bot, récupérer un token de développeur et le mettre dans le fichier `.env` + +## Développement +### Fichiers +- `index.js` est un module nodejs qui est le cœur du bot ! +- `index.html` est la page html qui affiche les réactions des gens en temps réel +- `main.js` est le script qui fait tourner la page précédente +- `defaultReactions.json` est le fichier qui contient les réactions possibles par défaut + +### Améliorations futures +#### Interface web +- Pouvoir supprimer des réactions / les reset (on y est presque) +- Avoir les emojis. Voir [twemoji](https://github.com/twitter/twemoji/tree/master/assets/svg). Il faut avoir leur code utf-truc. + +#### Discord +- Faire une image docker +- La déployer et mettre le bot sur le serveur discord + diff --git a/index.html b/index.html index 3cec2b3..ef876c1 100644 --- a/index.html +++ b/index.html @@ -12,7 +12,8 @@

Non connecté !