diff --git a/README.md b/README.md index a7f8992..d389bf5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ # DiscordBot -Bot discord fait pour fonctionner sur des machines type Raspberry Pi 4, avec une AI et plusieurs autres fonctionnalités. \ No newline at end of file +Bot discord fait pour fonctionner sur des machines type Raspberry Pi 4, avec une AI et plusieurs autres fonctionnalités. + +## Utilisation + +Tout est paramètrable dans `settings.json`. Vous devez au moins y ajouter le token de vore bot et un model .gguf Llama. J'utilisais TinyLlama, mais Phi est sans doute mieux aujourd'hui. + +## Fonctionnement + +```mermaid +flowchart TD +lj{"Initialisation"} +init["Discord.py"] +c1["Commande 'uwu'"] +c2["Commande 'gif'"] +c3["Commande 'speak'"] +uwu["Uwuifie le texte"] +gif["Requête à Otaku API"] +speak["Llama"] +q["Queue"] +env["Envoie la réponse"] +lj --> init +init --> c1 +init --> c2 +init --> c3 +c1 --> q +c2 --> q +c3 --> q +q --> uwu +q --> gif +q --> speak +uwu --> env +gif --> env +speak --> env +``` \ No newline at end of file