Bot for Twitch

Find a file

Mylloon aafde87ee2 All checks were successful ci/woodpecker/manual/publish Pipeline was successful Details migration * gitlab -> forgejo * python 3.9 -> 3.11 * readme overhal * format python file * basic PIP convention		2024-01-24 18:04:10 +01:00
.forgejo	migration	2024-01-24 18:04:10 +01:00
src	migration	2024-01-24 18:04:10 +01:00
.envexample	moving env file to root folder and removing discord command	2021-08-02 13:37:19 +02:00
.gitignore	ignore vscode folder	2021-08-20 08:33:13 +02:00
docker-compose.yml	migration	2024-01-24 18:04:10 +01:00
Dockerfile	migration	2024-01-24 18:04:10 +01:00
LICENSE	Add year and author	2023-02-15 16:01:53 +01:00
README.md	migration	2024-01-24 18:04:10 +01:00
requirements.txt	migration	2024-01-24 18:04:10 +01:00

README.md

Tom, a twitch bot

Features

Here is the list of available commands by default:

Command	Alias	Explanation
`add`		Add command to the database (`add command_name command_message`)
`remove`	`delete`	Remove command from database (`remove command_name`)
`list`	`commande`, `commandes`, `help`	Print all available commands (internal and user-defined)
`edit`		Modify a database command (`edit command_name new_command_message`)

Setup with Docker

Via docker-compose

Via command line

docker run -d \
    --name="Bot-Tom" \
    git.mylloon.fr/confreriedukassoulait/tom:latest \
    --ACCESS_TOKEN="yourAccessToken" \
    --PREFIX="yourPrefix" \
    --CHANNEL="yourChannel(s)" \
    -v /here/your/path/:/opt/db

Setup Locally

Requires Python 3.11.6

Install dependencies

python3 -m pip install -r requirements.txt

Rename .envexample file in .env, then open the file and complete the fields

Field	Explanation
`ACCESS_TOKEN`	Access token of the bot account (be sure you selected `Bot Chat` Token)
`PREFIX`	Prefix used for your bot
`CHANNEL`	Twitch channel(s) where the bot will run (separate by comma)

Start bot
```
cd src; python3 main.py
```