diff --git a/.gitignore b/.gitignore index 043883f..204b81c 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ venv-pg .idea/ output.log* msgid -tmppic.jpg \ No newline at end of file +tmppic.jpg +venv \ No newline at end of file diff --git a/README.md b/README.md index 7baff41..bb37d39 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,42 @@ Бот для telegram, который отправляет оповещения о начале стрима на твиче ==== -Надо поставить в virtualenv зависимости из requirements.txt, сформировать конфиг из config_python.py.tpl и запустить бота. \ No newline at end of file +# TL;DR + +Надо поставить в virtualenv зависимости из requirements.txt, сформировать конфиг из config_python.py.tpl и запустить бота. + +# Инструкция + +* Ставим virtualenv, активируем +* Ставим пакеты - `pip3 install -r requirements.txt` +* Настраиваем конфиг +* Запускаем скрипт. Важно: запускать его надо из той же папки, где лежит конфиг. Там же будет создаваться временный файл с айди сообщения и фото стрима + +# Настройка конфига + +* Отправляем в бота https://t.me/RawDataBot сообщение из канала, в который надо добавить бота +* Указываем айди канала в переменной `tgchat` (раздел message - forward_from_chat - id) +* Создаем бота на твиче - https://dev.twitch.tv/console +* Полученный appid указываем в переменной `appid`, а секрет в `appsecret` +* Указываем логин стримера в переменной `streamer` +* Указываем частоту проверки стрима в секундах в переменной `period`. Советую 300 секунд, т.к. количество зрителей и +фото стрима не будут обновляться чаще - ограничение твича + +# systemd unit для запуска бота + +```commandline +# /etc/systemd/system/twitch-bot.service +[Unit] +Description=Twitch bot notifier + +[Service] +Restart=always +RestartSec=30s +Type=simple +WorkingDir=/opt/tgbot-streamer +ExecStart=/bin/bash -c 'source /opt/twitch-tgbot/venv/bin/activate && /opt/twitch-tgbot/main.py --prod' + +[Install] +WantedBy=multi-user.target + +``` \ No newline at end of file