diff --git a/.gitignore b/.gitignore index a47c06c..f225197 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ *.pyc data __pycache__ +venv diff --git a/README.md b/README.md index 0991b0a..2bcd27d 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,38 @@ -Pour ajouter ce bot à votre serveur discord : -https://discord.com/api/oauth2/authorize?client_id=1110208055171367014&permissions=274877975552&scope=bot +BOT Discord de l'authentique Père Fouras sur votre channel discord, avec plus de 300 de ses fameuses énigmes à vous poser. -Merci à ChatGPT pour m'avoir aidé à porter mon vieux bot IRC en C++, en un bot discord en python - -Lien du vieux bot IRC que j'avais codé en 2016 : +Ce bot est une refonte totale d'un vieux bot IRC que j'avais développé en C++ en 2016 : https://git.epicsparrow.com/Anselme/SparrowBot/src/branch/master/app/fourasmodule.cpp -# How to run the bot +# Pour les utilisateurs -## Setup env var for the bot +`/fouras` pour demander une énigme +`/indice` pour demander un indice sur l'énigme courante -- Create a `.env` file at the root of the project -- Add the following content to the file: - - `DISCORD_TOKEN` : the token of the bot - - `GITEA_API_KEY` : the api key to interact with gitea - - `GUILD_ID` : the id of the guild where the bot offer slash commands +`/fouras_requete` pour demander une énigme précise +`/repete` pour que le père fouras répète l'énigme (pratique si vous avez la flemme de scroller quand il y a eu plein de messages) + +# Pour les admins + +## Comment ajouter le bot à un serveur +Un administrateur du serveur doit cliquer sur ce lien : +https://discord.com/api/oauth2/authorize?client_id=1110208055171367014&permissions=274877975552&scope=bot +# Pour les développeurs + +## Setup python ```bash -python -m main +python -m venv "venv" +source venv/bin/activate +pip install -r requirements.txt ``` +## Setup discord +Créer un bot et générer un TOKEN sur le portail développeurs : +https://discord.com/developers/applications -## EXPERIMENTAL GITEA API -Permission needed: -- repo: read -- issues: read & write \ No newline at end of file +## Setup l'environnement +Créer un fichier `.env` à la source du projet avec les entrées suivantes : +- `DISCORD_TOKEN` : the token of the bot +- `MAINTAINER_ID` : optional discord user id, if you want to receive the bug reports associated to your instance of the bot