Перейти к содержанию
Noko

Установка

Следуйте этим шагам для правильной установки скрипта в вашего бота.

Этапы установки

Раздел с заголовком «Этапы установки»

  1. Скачайте модуль и распакуйте папку

    Получите папку модуля (обычно в формате .zip или .rar) с официального источника. Используйте инструмент вроде WinRAR или 7-Zip для извлечения папки скрипта на ваш компьютер.

  2. Создание ключей API Twitch

    • Вход на платформу разработчиков Twitch
      Перейдите на: Разработчик чтобы войти или создать аккаунт для доступа к консоли разработчика.

    • Доступ к консоли разработчика
      После входа перейдите в консоль приложений: Консоль

    • Создание вашего приложения
      Нажмите “Создать приложение” или перейдите по ссылке: Создать приложение
      Заполните следующие поля:
      • Имя (название вашего приложения, например: BotTwitch)
      • URL перенаправления OAuth: http://localhost
      • Категория: Application Integration
      • Тип клиента: Confidential

    • Получение ключей
      После создания приложения нажмите “Управление” рядом с вашим приложением.
      Скопируйте ваш Client ID
      Нажмите “Новый секрет” для генерации Client Secret и скопируйте его
      На следующем этапе мы должны будем добавить их в файл .env (twitchClientID & twitchClientSecret)

  3. Настройте переменные окружения

    Откройте файл .env, предоставленный со скриптом, и добавьте/измените необходимые переменные окружения для правильной работы модуля.

    • twitchClientID : Ключ client ID API Twitch (См. шаг 2)
    • twitchClientSecret : Секретный ключ API Twitch (См. шаг 2)
    • twitchUserAccount : ⚠️ Точный никнейм стримера на Twitch
    • twitchIDAccount : ID аккаунта Twitch (Оставьте пустым, заполнится автоматически)
    • twitchChannelPostLive : ID канала, куда будут отправляться уведомления о стримах
    • twitchRoleViewerID : ID роли зрителей (Обычно роль участника для уведомления всего сервера или созданная вами роль, чтобы участники могли выбрать её для получения уведомлений о новых стримах!)
    • twitchChannelFollowerID: ID голосового чата, который будет обновлен с учетом количества подписчиков. Оставьте поле пустым, если не хотите обновлять голосовой чат.

  4. Скопируйте/переместите файлы/код в ваш проект

    Скопируйте следующие файлы в соответствующие папки вашего проекта Discord-бота:

    • utils/twitch-notification.js : в папку с утилитами
    • utils/environment.js : в папку с утилитами

    Также скопируйте код инициализации модуля в ваш основной файл index.js. В этом файле мы добавили prisma, напрямую связанную с объектом “client” - добавьте этот код в ваш файл или настройте его в соответствии с тем, как вы используете prisma.

    ❗ Создайте папку Images/screen-live/, она будет использоваться как буфер для хранения изображений. После окончания стрима содержимое папки будет удалено. В папке Images/ добавьте изображение начала стрима (online.png) и изображение окончания стрима (offline.png), предпочтительно в разрешении 1920*1080 пикселей.

  5. Обновите схему базы данных

    Добавьте модель данных для получения уведомлений о стримах Twitch в ваш файл prisma/schema.prisma и выполните необходимые миграции для применения изменений в вашей базе данных. Выполните следующую команду:

    Окно терминала
    npx prisma generate
    

    npx prisma migrate dev --name add_twitch_notification

  6. Установите зависимости

    Убедитесь, что необходимые зависимости установлены, проверив ваш package.json и выполнив:

    Окно терминала
    npm install

  7. Перезапустите бота

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

Советы

Раздел с заголовком «Советы»
  • В файле utils/twitch-notification.js вы можете изменить время в минутах для проверки перед тем, как стрим будет помечен как завершённый. Измените переменную attemptReconnectMax, которая в настоящее время установлена на 10 минут.