Installation

Docker Compose

Download the configuration files:

mkdir twitchbot && cd twitchbot && \
wget https://raw.githubusercontent.com/Helltar/twitchviewer-bot/master/{.env.example,compose.yaml} && \
cp .env.example .env

Edit .env and fill in your values:

• CREATOR_ID: your Telegram user ID
• BOT_TOKEN: Telegram bot token (BotFather)
• BOT_USERNAME: Telegram bot username (BotFather)
• TWITCH_CLIENT_ID: Twitch app client ID (Twitch Developer Console)
• TWITCH_CLIENT_SECRET: Twitch app client secret (Twitch Developer Console)
• POSTGRESQL_* + DATABASE_*: PostgreSQL connection settings

Start the bot:

docker compose up -d

Note: compose.yaml includes a PostgreSQL container, so no external database is required. To use your own PostgreSQL instance instead, remove the postgres service from compose.yaml and point the POSTGRESQL_* / DATABASE_* values in .env to it.

Commands

/clip - record clips

• /clip - from all tracked channels
• /clip <channel> - from a specific channel (even if it isn't in your list)
• /clip <prefix>. - only from tracked channels whose name starts with <prefix>, e.g. /clip em.
• /clip !<prefix>. - from all tracked channels except those starting with <prefix>, e.g. /clip !em.

/screenshot - capture screenshots

• /screenshot - from all tracked channels
• /screenshot <channel> - from a specific channel

Other

• /add - Add channel to favorites
• /list - Show your favorite channels
• /cancel - Cancel your active background tasks

Notes

• The bot requires ffmpeg and streamlink (already included in the provided Docker image).