Unity Twitch Chat

Unity Twitch Chat

這是一個輕量級且高效的 Unity Twitch.tv IRC 用戶端。

簡而言之，這允許您將 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、使用者名稱、頻道）
   • 您可以在 https://twitchapps.com/tmi/ 產生 OAuth 令牌
   • 或者，您可以啟用Use Anonymous Login以在沒有 OAuth 的情況下使用
4. 確保Connect IRC On Start和Join Channel On Start已啟用，然後按播放鍵 – 您現在應該在控制台中看到 JOIN 訊息等。
5. 建立一個具有IRC.OnChatMessage事件偵聽器的新腳本。
   • 請參閱 ListenerExample.cs 以供參考。
   • 偵聽器將接收Chatter對象，其中包含有關每個聊天訊息的信息，例如聊天者名稱、訊息、表情等...

有問題嗎？查看包含的範例項目以獲得更好的理解。

範例專案

生成物像跳箱一樣喋喋不休。盒子顏色基於其主要徽章。

API文件

IRC.cs

• void Connect() - 連接到 Twitch IRC
• void Disconnect() - 斷開與 Twitch IRC 的連接
• void SendChatMessage(string message) - 傳送聊天訊息
• void JoinChannel(string channel) - 加入 Twitch 頻道
• void LeaveChannel(string channel) - 離開 Twitch 頻道
• void Ping() - 傳送 PING 訊息
• event OnChatMessage - 收到聊天訊息時呼叫的事件
• event OnConnectionAlert - 收到連線警報時呼叫的事件
• IRCTags ClientUserTags - 傳回客戶端使用者的標籤（徽章、名稱顏色等）

Chatter.cs

• Color GetNameColor() - 傳回聊天者姓名的顏色
• bool IsDisplayNameFontSafe() - 如果 displayName 是“字體安全性”，則傳回 true，這表示它只包含字元：az、AZ、0-9、_
• bool ContainsEmote(string emoteId) - 如果聊天者的訊息包含指定的表情（按 id），則傳回 true
• bool HasBadge(string baddName) - 如果聊天者俱有指定的徽章，則傳回 true

執照

麻省理工學院許可證

使用Unity Twitch Chat製作的項目

Intro Fighters，串流疊加遊戲 https://lexone.itch.io/introfighters

你做了一些很酷的事情嗎？聯絡我（Discord 上的 lexone）以在此處獲得推薦！