Шатауты и рейды¶

Шатауты и рейды — страница, на которой настраивается, кому бот сам делает /shoutout:

друзьям канала из списка — когда они пишут в чат во время эфира;
рейдерам — сразу после рейда.

Здесь же настраиваются цветные объявления в чат к этим шатаутам и виден журнал: что бот отправил и что Twitch не принял.

Нужна помощь разработчика?

Напишите mrgorkiy в Telegram. Укажите страницу, ожидаемый результат, что произошло и шаги для повторения. Можно приложить скриншот или короткое видео. Перед отправкой закройте токены, коды подтверждения и приватные ссылки OBS.

Что нужно для работы¶

Шатаут отправляется одним из двух способов, подойдёт любой:

Подключённый Twitch владельца — шатаут уходит от имени владельца.
PulseCasterBot — модератор канала (/mod PulseCasterBot в чате).

Сначала бот пробует аккаунт владельца, потом бота. Если не подходит ни один способ, в шапке страницы видно Нет прав на шатаут, а включить шатауты и объявления нельзя. Кнопка Подключить Twitch ведёт на выдачу прав.

Twitch принимает шатаут только от канала, который сейчас в эфире, и только если на стриме есть хотя бы один зритель. Поэтому все шатауты делаются во время эфира.

Как устроена страница¶

В шапке — от чьего имени уходит шатаут и идёт ли эфир. Ниже — последняя ошибка, если она была, и сводка: сколько каналов в списке, включены ли шатауты по первому сообщению и рейдерам, сколько шатаутов было за 7 дней и сколько из них Twitch не принял. Плитки сводки открывают нужную вкладку.

Вкладка	Что в ней
Каналы	список друзей канала: добавить, найти, убрать
Когда шатаутить	шатаут по первому сообщению, шатаут рейдерам, очередь и лимиты Twitch
Объявления	объявление к шатауту по первому сообщению и объявление при рейде
Журнал	отправленные и неудавшиеся шатауты и объявления с причиной отказа
Команды чата	переключатель команды `!шатаут` и её алиасов

Изменения на вкладках Когда шатаутить и Объявления сохраняются кнопкой Сохранить внизу экрана. Бот подхватывает их в течение полуминуты. Список каналов и переключатели из общего каталога сохраняются сразу.

Каналы¶

В список добавляют ники Twitch или ссылки на каналы. Можно вставить сразу несколько — через пробел, запятую или с новой строки:

jlehubec, twitch.tv/some_streamer
@another_friend

После добавления страница показывает, сколько каналов добавлено, какие уже были в списке и какие не подошли. Неподошедшие ники остаются в поле, их можно сразу исправить. Ник Twitch — от 3 до 25 символов: латиница, цифры и _. Собственный канал добавить нельзя. В списке может быть до 500 каналов.

Под каждым ником видно, когда бот в последний раз успешно сделал этому каналу шатаут, и кто добавил его командой из чата.

Список работает в трёх местах:

шатаут по первому сообщению делается только каналам из списка;
шатаут рейдерам с режимом Только каналам из списка — только им;
каналы из списка проходят порог по зрителям для шатаута рейдерам и для объявления при рейде всегда.

Модераторы и владелец могут менять список прямо в чате:

!шатаут username

Команда добавляет канал, повторная — убирает. Если отправить её ответом на сообщение, бот возьмёт ник из ответа.

Когда шатаутить¶

По первому сообщению¶

Настройка	Что означает
Делать шатаут по первому сообщению	канал из списка пишет в чат — бот делает ему `/shoutout`
Раз за стрим	каждый стрим — новый шатаут, даже если стримов два в день
Раз в сутки	по московскому времени: на втором стриме за день шатаута уже не будет

Если друг написал до начала стрима, шатаут уйдёт, когда он напишет уже во время эфира.

Рейдерам¶

Настройка	Что означает
Автоматически отмечать рейдеров	канал, который пришёл рейдом, получает шатаут; он встаёт в начало очереди
Только каналам из списка	шатаут получают только рейдеры из списка
Шатаутить рейды от	минимум зрителей в рейде; `0` — любой рейд

Первые два переключателя — те же, что в общих настройках на вкладке Прочее.

Очередь и лимиты Twitch¶

Twitch разрешает каналу один шатаут в 2 минуты, а одному и тому же стримеру — раз в 60 минут. Поэтому бот складывает шатауты в очередь и отправляет по одному.

Настройка	Что означает
Пауза между шатаутами	от `120` до `300` секунд; меньше 2 минут Twitch не позволяет
Не шатаутить в начале стрима	первые `N` минут шатауты копятся и уходят по очереди, когда время выйдет; касается и рейдеров

Пауза отсчитывается от прошлого шатаута, даже если очередь между ними опустела. Если Twitch всё же отказал из-за кулдауна — например, стример только что сделал шатаут вручную, — бот повторит попытку один раз в конце очереди. Если и вторая попытка не прошла, запись появится в журнале.

Объявления¶

Объявление — цветное сообщение Twitch в чате, как команда /announce. Его отправляет PulseCasterBot (нужны права модератора и scope moderator:manage:announcements), а если не получилось — аккаунт владельца.

К шатауту по первому сообщению¶

Уходит сразу после удачного шатаута по первому сообщению: Twitch показывает карточку канала, а бот добавляет текст с игрой. Если шатаут не прошёл или шатаут по первому сообщению выключен, объявления не будет.

Стандартные тексты:

Загляните на канал {name}: там недавно показывали {game} — twitch.tv/{login};
без игры: Загляните на канал {name} — twitch.tv/{login}.

Переменные: {name} — ник, {game} — игра, {title} — название стрима, {login} — логин, {url} — ссылка на канал.

При рейде¶

Уходит сразу после рейда, без очереди шатаутов, и работает отдельно от шатаута рейдеру. Одному рейдеру — один раз за стрим.

Настройка	Что означает
Отправлять объявление при рейде	включает объявление
Для каких рейдов	`Все рейды` (с порогом по зрителям) или `Только из списка`
Рейды от	минимум зрителей; каналы из списка проходят всегда

Переменные: {raider} — ник рейдера, {game}, {title}, {viewers} — сколько зрителей пришло, {login}, {url}.

Общее для обоих объявлений¶

У каждого объявления свой цвет (цвет канала, синий, зелёный, оранжевый, фиолетовый) и два текста: основной и запасной — на случай, когда игру узнать не удалось. Под каждым текстом — предпросмотр с примером. Перенос строки превращается в пробел, текст обрезается до 500 символов (лимит Twitch).

Откуда берётся игра:

Текущая категория канала в Twitch.
Если там Just Chatting (Общение) или пусто, а канал тоже подключён к PulseCaster, — игра, в которую там дольше всего играли на стриме за последние сутки.
Иначе уходит запасной текст.

Журнал¶

Журнал показывает шатауты и объявления — свежие сверху — и для неудавшихся объясняет причину:

Причина	Что делать
Twitch принимает шатаут только во время эфира	шатаут ушёл, когда стрим уже закончился или на стриме не было зрителей
Нет прав на шатаут	переподключите Twitch владельца или выполните `/mod PulseCasterBot`
Канал не найден в Twitch	проверьте ник в списке
Кулдаун Twitch	шатаут этому стримеру уже был меньше 60 минут назад или шатауты шли слишком часто

Последняя ошибка дублируется в шапке страницы.

Если что-то не работает¶

Симптом	Где смотреть сначала
Шатаут не пришёл другу	идёт ли эфир, есть ли ник в списке, включён ли шатаут по первому сообщению, не было ли шатаута раньше за этот стрим или сутки
Шатаут пришёл с задержкой	пауза между шатаутами и `Не шатаутить в начале стрима`; рейдеры идут первыми
Рейдер не получил шатаут	переключатель `Автоматически отмечать рейдеров`, порог по зрителям и режим `Только каналам из списка`
Объявление не появилось	журнал; права PulseCasterBot на объявления или подключённый Twitch владельца
В журнале «кулдаун»	Twitch не даёт делать шатаут одному стримеру чаще раза в час