Unity Twitch Chat

Unity Twitch Chat

Dies ist ein leichter und effizienter Twitch.tv IRC-Client für Unity.

Kurz gesagt: Dies ermöglicht Ihnen die Integration von Twitch Chat in Ihre Unity-Projekte.
Das primäre Ziel besteht darin, Chatnachrichten möglichst effizient lesen und versenden zu können.

Beispiel für eine Chat-Nachricht

Unterstützte Funktionen

• Chatnachrichten lesen und versenden
• Analysieren von Twitch-Emotes und -Abzeichen
• Optionaler anonymer Login
• Automatische Ratenlimitprüfungen
• Normalisierung der Namensfarbe (ähnlich dem nativen Twitch-Chat)

Nicht unterstützte Funktionen

• Besondere Nachrichten (Flüstern, Sub/Resub, Raids, Erstzuschauer usw.)
• Anfeuerungsbits, Kanalpunkte, Vorhersagen usw
• Moderation (Verbot, Auszeit usw.)
• Erweiterungen von Drittanbietern (FFZ, BTTV, 7TV usw.)
• und mehr...

Andere Einschränkungen

• WebGL-Builds werden nicht unterstützt

Installation

• Öffnen Sie den Unity-Paketmanager (Fenster -> Paketmanager).
• Klicken Sie oben links auf die Schaltfläche + .
• Wählen Sie Add package from git URL... aus.
• Kopieren Sie die folgende URL, fügen Sie sie ein und klicken Sie abschließend auf Add
  

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

Schnellstart

1. Installieren Sie das Unity-Paket (siehe oben)
2. Erstellen Sie ein neues leeres GameObject und fügen Sie die Twitch IRC Komponente hinzu.
3. Legen Sie im Inspektor Ihre Twitch-Details fest (OAuth, Benutzername, Kanal).
   • Sie können ein OAuth-Token unter https://twitchapps.com/tmi/ generieren.
   • Alternativ können Sie Use Anonymous Login aktivieren, um ohne OAuth zu verwenden
4. Stellen Sie sicher, dass Connect IRC On Start und Join Channel On Start aktiviert sind, und drücken Sie „Play“. In der Konsole sollten nun JOIN-Meldungen usw. angezeigt werden.
5. Erstellen Sie ein neues Skript mit einem Listener für das IRC.OnChatMessage -Ereignis.
   • Siehe ListenerExample.cs als Referenz.
   • Der Listener erhält Chatter Objekte, die Informationen zu jeder Chat-Nachricht enthalten, z. B. Chatter-Name, Nachricht, Emotes usw.

Haben Sie Probleme? Schauen Sie sich zum besseren Verständnis das mitgelieferte Beispielprojekt an.

Beispielprojekt

Chatter als Sprungboxen erzeugen. Die Boxfarbe basiert auf ihrem primären Abzeichen.

API-Dokumentation

IRC.cs

• void Connect() – Verbindet sich mit Twitch IRC
• void Disconnect() – Trennt die Verbindung zum Twitch IRC
• void SendChatMessage(string message) – Sendet eine Chat-Nachricht an den Kanal
• void JoinChannel(stringchannel) – Treten Sie einem Twitch-Kanal bei
• void LeaveChannel(stringchannel) – Einen Twitch-Kanal verlassen
• void Ping() – Sendet eine PING-Nachricht an den Twitch IRC-Server
• event OnChatMessage – Ereignis, das aufgerufen wird, wenn eine Chat-Nachricht empfangen wird
• event OnConnectionAlert – Ereignis, das aufgerufen wird, wenn eine Verbindungswarnung empfangen wird
• IRCTags ClientUserTags – Gibt die Tags des Client-Benutzers zurück (Abzeichen, Namensfarbe usw.)

Chatter.cs

• Color GetNameColor() – Gibt die Farbe des Namens des Chatters zurück
• bool IsDisplayNameFontSafe() – Gibt true zurück, wenn displayName „fontsicher“ ist, was bedeutet, dass es nur folgende Zeichen enthält: az, AZ, 0-9, _
• bool ContainsEmote(string emoteId) – Gibt „true“ zurück, wenn die Nachricht des Chatters das angegebene Emote (nach ID) enthält.
• bool HasBadge(string BadgeName) – Gibt „true“ zurück, wenn der Chatter das angegebene Abzeichen hat

Lizenz

MIT-Lizenz

Mit Unity Twitch Chat erstellte Projekte

Intro Fighters, Stream-Overlay-Spiel https://lexone.itch.io/introfighters

Hast du etwas Cooles gemacht? Kontaktieren Sie mich (Lexone auf Discord), um hier vorgestellt zu werden!