Better Readme
This commit is contained in:
parent
19d3d03fa1
commit
8ff719f01e
1 changed files with 17 additions and 3 deletions
20
README.md
20
README.md
|
@ -2,6 +2,8 @@
|
||||||
|
|
||||||
## Setup and Run
|
## Setup and Run
|
||||||
|
|
||||||
|
### Locally
|
||||||
|
|
||||||
Requires Python `3.9.5`.
|
Requires Python `3.9.5`.
|
||||||
|
|
||||||
Install necessary packages:
|
Install necessary packages:
|
||||||
|
@ -13,11 +15,11 @@ python3 -m pip install -r requirements.txt
|
||||||
Rename `.envexample` file in `.env` inside `src` folder, then open the file and complete the fields, there is an explanation below:
|
Rename `.envexample` file in `.env` inside `src` folder, then open the file and complete the fields, there is an explanation below:
|
||||||
|
|
||||||
| Field | Explanation |
|
| Field | Explanation |
|
||||||
|----------------|-----------------------------------------------------------------------------------------------------------|
|
|----------------|-------------|
|
||||||
| `ACCESS_TOKEN` | Access token of the account you created for your bot that you can take [here](https://twitchtokengenerator.com/) (be sure you selected Bot Chat Token) |
|
| `ACCESS_TOKEN` | Access token of the account you created for your bot that you can take [here](https://twitchtokengenerator.com/) (be sure you selected Bot Chat Token) |
|
||||||
| `PREFIX` | Prefix you want to use for your bot |
|
| `PREFIX` | Prefix you want to use for your bot |
|
||||||
| `CHANNEL` | The name of the your Twitch channel you want the bot to run at (separate by comma) |
|
| `CHANNEL` | The name of the your Twitch channel you want the bot to run at (separate by comma) |
|
||||||
| `DISCORD` | Link to your discord server |
|
| `DISCORD` | Link to your discord server |
|
||||||
|
|
||||||
Start Bot:
|
Start Bot:
|
||||||
|
|
||||||
|
@ -26,7 +28,7 @@ cd src
|
||||||
python3 main.py
|
python3 main.py
|
||||||
```
|
```
|
||||||
|
|
||||||
## Use Docker
|
### With Docker
|
||||||
|
|
||||||
With a [docker-compose](https://gitlab.com/ConfrerieDuKassoulait/Bot-Tom/-/blob/main/docker-compose.yml) or in command line:
|
With a [docker-compose](https://gitlab.com/ConfrerieDuKassoulait/Bot-Tom/-/blob/main/docker-compose.yml) or in command line:
|
||||||
|
|
||||||
|
@ -39,3 +41,15 @@ docker run -d \
|
||||||
--CHANNEL="yourChannel(s)" \
|
--CHANNEL="yourChannel(s)" \
|
||||||
--DISCORD="yourDiscordLink"
|
--DISCORD="yourDiscordLink"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
Here the list of available commands by default:
|
||||||
|
|
||||||
|
| Command | Explanation |
|
||||||
|
|-----------|-------------|
|
||||||
|
| `discord` | Envoie le lien de ton serveur Discord |
|
||||||
|
| `add` | Ajoute une commande de la base de donnée du bot : `add` `omDeLaCommande` `messageDeLaCommande` |
|
||||||
|
| `remove` | Supprime une commande de la base de donnée du bot : `remove` `nomDeLaCommande` |
|
||||||
|
| `list` | Affiche la liste des commandes de la base de donnée du bot |
|
||||||
|
| `edit` | Modifie une commande de la base de donnée du bot : `add` `nomDeLaCommande` `nouveauMessageDeLaCommande` |
|
||||||
|
|
Loading…
Reference in a new issue