Skip to content

Twitch Module

The plugin's Twitch module is controlled with the /twitch command followed by one of the next arguments:

Generates a Twitch Device Code and starts the linking process.

Example:

/twitch link

Unlinks all Twitch accounts and removes the stored credentials. You may pass an extra argument with a linked user name to unlink only that account.
To temporally disconnect from Twitch's API, use the stop command.

Example:

/twitch unlink
/twitch unlink exampleStreamer

Accounts

Displays a menu showing all connected accounts, with buttons to unlink accounts and stop/start the Twitch client.

Example:

/twitch accounts

Create Reward

Creates a new Channel Point Reward in your Twitch channel. Only rewards created by this command can be managed by the plugin, due to API Limitations.
If the command ran successfully, on the streamer's Twitch Dashboard a new Channel Point Reward will appear. Once created by the plugin it can be renamed and modified.

Example:

/twitch createreward exampleStreamer

Start

Starts the Twitch Client and connects automatically to the previous accounts using the saved credentials. If there are no saved accounts you will need to link an account.

Example:

/twitch start

Stop

Stops the Twitch Client. This will disconnect you from the Twitch API and stop any incoming events. Your current account credentials will be saved and used the next time the Twitch Client starts.

Example:

/twitch stop

Status

Displays an information message containing connection status, plugin version, accounts and live channels.

Example:

/twitch status

Reload

Restarts the plugin and reloads the configuration files.

Example:

/twitch reload

Test

Simulates a fake event. Useful for testing your configuration.

Channel Points

Sends a custom Channel Points Redemption event. You can input the chatter and streamer user names, as well as adding a user input message. Syntax: /twitch test channelpoints <chatter username> <streamer username> <reward name> [user input]

If you have a reward name that contains whitespaces you should enclose it with double quotes

Example:

/twitch test channelpoints exampleViewer exampleStreamer "Test Reward"
/twitch test channelpoints exampleViewer exampleStreamer "Another Test Reward" "Message with whitespaces"

Cheer

Sends a custom Cheer event. You can set a custom amount of Bits, as well as the cheerer and the streamer username. Syntax: /twitch test cheer <chatter username> <streamer username> <bits>

Example:

/twitch test cheer exampleViewer exampleStreamer 500

Follow

Sends a custom Follow event.
Syntax: /twitch test follow <chatter username> <streamer username>

Example:

/twitch test follow exampleViewer exampleStreamer

Raid

Sends a custom Raid Event with the specified amount of viewers.
Syntax: /twitch test raid <raider username> <streamer username> <viewer count> Example:

/twitch test raid exampleViewer exampleStreamer 20000

Subscription

Sends a custom subscription event with the specified tier and months. Syntax: /twitch test sub <viewer username> <streamer username> <subscription tier> <months> Example:

/twitch test sub exampleViewer exampleStreamer TIER1 5

Subscription Gift

Sends a test subscription gift event. Syntax: /twitch test subgift <viewer username> <streamer username> <subscription tier> <amount> Example:

/twitch test subgift exampleViewer exampleStreamer TIER1 10