Unity Twitch Chat

Unity Twitch Chat

Это легкий и эффективный IRC-клиент Twitch.tv для Unity.

Короче говоря, это позволяет вам интегрировать Twitch Chat в ваши проекты Unity.
Основная цель — иметь возможность читать и отправлять сообщения чата максимально эффективно.

Пример сообщения в чате

Поддерживаемые функции

• Чтение и отправка сообщений чата
• Разбор смайлов и значков Twitch
• Дополнительный анонимный вход
• Автоматическая проверка ограничения скорости
• Нормализация цвета имени (аналогично родному чату Twitch)

Неподдерживаемые функции

• Специальные сообщения (шепот, подписка/переподписка, рейды, первые просмотры и т. д.)
• Биты аплодисментов, баллы канала, прогнозы и т. д.
• Модерация (бан, таймаут и т.д.)
• Сторонние расширения (FFZ, BTTV, 7TV и т. д.)
• и многое другое...

Другие ограничения

• Сборки WebGL не поддерживаются.

Установка

• Откройте диспетчер пакетов Unity (Окно -> Диспетчер пакетов)
• Нажмите кнопку + в левом верхнем углу
• Выберите Add package from git URL...
• Скопируйте и вставьте следующий URL-адрес и завершите нажатием кнопки Add
  

 https://github.com/lexonegit/Unity-Twitch-Chat.git?path=/Unity-Twitch-Chat/Assets/Package

Быстрый старт

1. Установите пакет Unity (см. выше)
2. Создайте новый пустой GameObject и добавьте компонент Twitch IRC .
3. В инспекторе укажите свои данные Twitch (OAuth, имя пользователя, канал).
   • Вы можете сгенерировать токен OAuth на https://twitchapps.com/tmi/.
   • Альтернативно вы можете включить Use Anonymous Login для использования без OAuth.
4. Убедитесь, что включены функции Connect IRC On Start и Join Channel On Start , и нажмите «Play». Теперь вы должны увидеть сообщения «JOIN» и т. д. в консоли.
5. Создайте новый скрипт с прослушивателем события IRC.OnChatMessage .
   • См. ListenerExample.cs для справки.
   • Слушатель получит объекты Chatter , которые содержат информацию о каждом сообщении чата, такую ​​как имя чата, сообщение, эмоции и т. д.

Возникли проблемы? Для лучшего понимания ознакомьтесь с включенным в комплект поставки примером проекта.

Пример проекта

Спавн болтовни в виде прыгающих коробок. Цвет коробки зависит от их основного значка.

Документация по API

IRC.cs

• void Connect() — подключается к Twitch IRC.
• void Disconnect() — отключение от Twitch IRC
• void SendChatMessage(string message) — отправляет сообщение чата на канал.
• void JoinChannel(stringchannel) — присоединиться к каналу Twitch.
• void LeaveChannel(string Channel) — покинуть канал Twitch.
• void Ping() — отправляет сообщение PING на IRC-сервер Twitch.
• event OnChatMessage — событие, которое вызывается при получении сообщения чата.
• event OnConnectionAlert — событие, которое вызывается при получении предупреждения о соединении.
• IRCTags ClientUserTags — возвращает теги пользователя клиента (значки, цвет имени и т. д.).

Чаттер.cs

• Color GetNameColor() — возвращает цвет имени собеседника.
• bool IsDisplayNameFontSafe() — возвращает true, если displayName является «безопасным для шрифтов», что означает, что оно содержит только символы: az, AZ, 0–9, _.
• bool containsEmote(string emoteId) — возвращает true, если сообщение в чате содержит указанную эмоцию (по идентификатору)
• bool HasBadge(string BadgeName) — возвращает true, если в болтовне есть указанный значок.

Лицензия

Лицензия MIT

Проекты, созданные с помощью Unity Twitch Chat

Intro Fighters, трансляция игры https://lexone.itch.io/introfighters

Ты сделал что-то крутое? Свяжитесь со мной (lexone на Discord), чтобы вас разместили здесь!