Using TwiWorks
This section contains various guides on how to use TwiWorks' features. You can find the main feature categories of TwiWorks using the sidebar or the cards below.
📄️ Additional Events
In version 2.0+, OnMessage and OnCheer are also bindable by this system. Event discriptions have been included accordingly. Furthermore, OnRitual was removed in 2.0+.
📄️ Chat 101
The most used type of interaction your game will have with users will probably be using the Channel Chat. In order to use this, we have created a whole suite of nodes allowing you to do anything from receiving chat messages, to moderating the chat. Let's go over a few important ones.
📄️ Command System
TwiWorks also offers a built-in system for commands. These commands can be set up by opening up your Project Settings (Edit -> Project Settings), and adding Commands to the Commands section in the TwiWorks settings (Plugins > TwiWorks). Every command needs a name, optionally a description (if you want auto generated help messages), and optionally parameters. These parameters will need a name, a description if you want the help message, and a delimiter to find out where the parameter ends and the next one will start (this will generally be a space character (" ")). Each parameter also has a checkbox to toggle if it should show up in the auto-generated help menu.
📄️ Emote Quickstart
When working with Twitch, you'll likely want to download emotes at some point. TwiWorks exposes an easy-to-use way of getting the logged in user's emotes, and allows you to download them into a Texture2D that you can then show in your UI.
📄️ Reference
This page lists an overview of all the events and nodes exposed by TwiWorks, current as of the 2.0 release. It also includes a short description of what they do, as well as the OAuth scope(s) required for their usage. For more information on their usage, please refer to the built-in help text and/or the relevant documentation pages.