educ-bot/README.md
Adrian Amaglio 25507a8e08 fix
2020-03-31 15:24:40 +02:00

51 lines
2.0 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# EducBot
Un petit bot d'éduc pop pour Discord (WIP).
Il permet de voir qui secoue les mains dans une discussion vocale.
## Utilisation
### Installer le bot dans le serveur Discord
Ce nest pour linstant pas forcement facile…
### Fonctionnement
EducBot écoute tous les messages dun serveur où il a été installé (comme tous les bots).
Il réagira a des commandes messages commençants par `!`, et a des mots clef.
EducBot a pour objectif de recenser les utilisateurs souhaitant réagir.
#### Les commandes
EducBot répondra en toutes circonstances (sauf serveur cassé) aux commandes suivantes :
- `!educpop-help` Listera ces commandes
- `!educpop-enable` Commence la comptabilisation
- `!educpop-disable` Stope la comptabilisation
- `!educpop-reset` Remet à zéro les compteurs
- `!educpop-pause` Pause la comptabilisation
- `!educpop-resume` Reprend la comptabilisation
- `!educpop-list` Liste les mots-clés qui sont comptabilisés
Par exemple, taper `!educpop-list` dans un canal texte **où EducBot est activé**, lui fait dire :
```
Tapez simplement le mot-clé ci-dessous pour être comptabilisé. Tapez un - immédiatement suivi du mot-clé pour être retiré du compte : -oui par exemple !
:thumbsup:oui : Je suis daccord
:thumbsdown:non : Je ne suis pas daccord
:raised_hand:parole : Je veux parler
:raised_hands:réponse : Je veux répondre rapidement
:octagonal_sign:suffit : On tourne en rond
:hear_no_evil:écoute : On ne sécoute pas
:heart_eyes:love : Jadore
:dab:dab : Dab
```
#### Les mots-clés
Écrire seulement `oui` dans un canal texte **où EducBot est activé**, lui fait ajouter votre nom dutilisateur dans la liste des gens daccord.
Écrire seulement `-oui` fait retirer ce nom.
#### Visualisation
Le bot fait un résumé de létat des compteurs à chaque changement.
Pour des raisons de visibilités, le message utilisateur et les anciens messages de résumé sont supprimés.
#### Interface web
Une interface web permet de suivre létat des compteurs sans être secoué par un chat en folie.