Tom/README.md

1.8 KiB

Simple Bot Twitch en Python utilisant la librairie TwitchIO.

Setup and Run

Locally

Requires Python 3.9.5.

Install necessary packages:

python3 -m pip install -r requirements.txt

Rename .envexample file in .env in root folder, then open the file and complete the fields, there is an explanation below:

Field Explanation
ACCESS_TOKEN Access token of the account you created for your bot that you can take here (be sure you selected Bot Chat Token)
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)

Start Bot:

cd src
python3 main.py

With Docker

With a docker-compose or in command line:

docker run -d \
    --name="TwitchBot" \
    registry.gitlab.com/confreriedukassoulait/bot-tom:latest \
    --ACCESS_TOKEN="yourAccessToken" \
    --PREFIX="yourPrefix" \
    --CHANNEL="yourChannel(s)" \
    -v /here/your/path/:/db

Features

Here the list of available commands by default:

Command Alias Explanation
add Ajoute une commande de la base de donnée du bot : add omDeLaCommande messageDeLaCommande
remove delete Supprime une commande de la base de donnée du bot : remove nomDeLaCommande
list commande.s / help Affiche la liste des commandes (base de donnée + intégré au bot)
edit Modifie une commande de la base de donnée du bot : add nomDeLaCommande nouveauMessageDeLaCommande