Skip to content

Latest commit

 

History

History
68 lines (49 loc) · 4.48 KB

README.md

File metadata and controls

68 lines (49 loc) · 4.48 KB

MiniSharkBot

Twhich chat bot

Для работы бота необходим пакет .NET Runtime 6.0, досупный для скачивания на сайте выбрав свой тип системы в левом разделе "Run console apps."

Скачать бота можно либо по ссылке, либо в правой части в разделе Releases.

###Описание возможностей

  • Выполнение различных настраиваемых команд (!ds, !tg и т.д.)
  • Сообщения о событиях (бан пользователя, мут пользователя и т.д.)
  • Сообщения - уведомления в чат с установленной периодичностью
  • Перевод текста на русский с огромного количества языков

###Подготовка к запуску

Для подключения бота на свой канал необходимо:

  • Создать аккаунт на сайте twitch.tv либо использовать уже умеющийся
  • Получить токен авторизации на сайте
  • Внести данные в конфигурацию config/profile.json

###Настройка

Настройки для работы находятся в директории config. Список файлов конфигураций:

  • profile.json Содержит в себе настройки профиля

    • channel название канала
    • bot никнейм бота, зарегистрированого ранее
    • token токен авторизации полученный ранее
  • messages.json Содержит в себе сообщения о событиях

    • join_channel сообщение при входе бота на канал
    • user_banned сообщение при бане пользователя, в сообщении доступна переменная $user которая заменится именем забаненного пользователя
    • user_timedout сообщение при муте пользователя, в сообщении доступны переменные $user - заменится именем пользователя, отправленного в мут и $duration - длительность мута в секундах
  • commands.json Содержит в себе динамическое количество комманд для чата. Можно добавлять неограниченное количество. Каждая команда представляет собой обьект, содержащийся в массиве commands и содержащий в себе 2 поля:

    • command название команды, будет вызвано в чате с помощью знака '!' перед командой
    • message сообщение при выполнении команды, в сообщении доступна переменная $user которая заменится именем вызывающего команду пользователя
  • notifications.json Содержит в себе динамическое количество уведомлений для чата. Можно добавлять неограниченное количество. Каждое уведомление представляет собой обьект, содержащийся в массиве notifications и содержащий в себе 2 поля:

    • message сообщение уведомления
    • timeout пероидичность в секундах
  • services.json Содержит в себе настройку включения сервисов. true = включено, false = отключено

    • translation Перевод сообщений на русский язык

###Ошибки При возникновении ошибки - просьба писать на почту iburanuguloff@ya.ru желательно приложив скриншоты и максимально подробно описав ошибку.