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. 新しい空のゲームオブジェクトを作成し、 Twitch IRCコンポーネントを追加します。
3. インスペクターで、Twitch の詳細 (OAuth、ユーザー名、チャンネル) を設定します。
   • OAuth トークンは https://twitchapps.com/tmi/ で生成できます。
   • あるいは、 Use Anonymous Login有効にして、OAuth なしで使用することもできます。
4. Connect IRC On StartとJoin Channel On Startが有効になっていることを確認して、再生を押します。コンソールに JOIN メッセージなどが表示されるはずです。
5. IRC.OnChatMessageイベントのリスナーを持つ新しいスクリプトを作成します。
   • 参考として、ListenerExample.cs を参照してください。
   • リスナーは、Chatter 名、メッセージ、エモートなど、各チャット メッセージに関する情報を含むChatterオブジェクトを受け取ります。

問題がありますか?より深く理解するには、付属の ExampleProject を確認してください。

プロジェクト例

おしゃべりを跳び箱として生成します。ボックスの色は主なバッジに基づいています。

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 メッセージを Twitch IRC サーバーに送信します
• event OnChatMessage - チャット メッセージを受信したときに呼び出されるイベント
• event OnConnectionAlert - 接続アラートを受信したときに呼び出されるイベント
• IRCTags ClientUserTags - クライアント ユーザーのタグ (バッジ、名前の色など) を返します。

Chatter.cs

• Color GetNameColor() - おしゃべり者の名前の色を返します。
• bool IsDisplayNameFontSafe() - DisplayName が「フォント セーフ」である場合、つまり a ～ Z、AZ、0 ～ 9、_ の文字のみが含まれる場合に true を返します。
• bool ContainsEmote(string emoteId) - チャットのメッセージに指定されたエモート (ID による) が含まれている場合に true を返します。
• bool HasBadge(string badName) - チャットに指定されたバッジがある場合は true を返します

ライセンス

MITライセンス

Unity Twitch Chatで作成されたプロジェクト

イントロファイターズ、ストリームオーバーレイゲーム https://lexone.itch.io/introfighters

何か素敵なものを作りましたか？ここで紹介してもらうには、私 (Discord の lexone) に連絡してください。