config.yml To reset the original configuration, delete config.yml and reload the plugin. The file will regenerate automatically.
Enable Twitch: If set to true, the Twitch client will automatically start.
Ignore Offline Streamers: If set to true, the plugin will only listen to the people who is currently streaming. This also includes chat messages.
Ignore Offline Events: If enabled, events from offline streamers will be ignored.
Show Chat: If enabled, your stream chat will be shown in-game to all players in the server.
Log Events: Determines whether all events will be logged. true means that all channel point rewards, cheers, subscriptions and gifts will be logged into the console. false means that they won't be logged.
In-game Alerts Mode: How will the game notify of an event. Valid options: chat, title, all, none. Choosing none will disable In-game alerts.
Colors: Allows you to customize every color of the title messages. See a list of valid options in the Bukkit API Docs.
twitch.yml
Channel Point Rewards: A list containing all channel point rewards that you want an action set up. See Reward Actions for more information. You need to follow this format: {REWARD_NAME}: {ACTION}, replacing {REWARD_NAME} with the exact reward name that is on Twitch and {ACTION} with the desired action to run.
Follow Rewards: A list with all the actions that will be executed when a channel gets a new follower.
Cheer Rewards: A list containing all cheer rewards that you want an action set up. See Reward Actions for more information. You need to follow this format: AMOUNT: {ACTION}, replacing AMOUNT with the minimal ammount of bits that will be needed to trigger the event and {ACTION} with the desired action to run.
Sub Rewards: A list containing all subscription rewards that you want an action set up. See Reward Actions for more information. You need to follow this format: TWITCH_PRIME/TIER1/TIER2/TIER3: {ACTION}. Replace {ACTION} with the desired action to run.
Gift Rewards: A list containing all subscription gifts rewards that you want an action set up. See Reward Actions for more information. You need to follow this format: AMOUNT: {ACTION}, replacing AMOUNT with the minimal ammount of subscriptions that will be needed to be gifted in order to trigger the event and {ACTION} with the desired action to run.
Raid Rewards: A list containing all raid rewards that you want an action set up. See Reward Actions for more information. You need to follow this format: AMOUNT: {ACTION}, replacing AMOUNT with the minimal ammount of raid viewers that will be needed to trigger the event and {ACTION} with the desired action to run.
Chat Blacklist: List of usernames of chat bots and other users that will be ignored for the in-game stream chat.
Mob Glow Override: Overrides the global value set in the config.yml file for Twitch events.
Display Name on Mob Override: Overrides the global value set in the config.yml file for Twitch events.
Colors Override: Overrides the global colors set in the config.yml file for Twitch events. See a list of valid options in the Bukkit API Docs.
For a better streaming experience, it is possible to translate the plugin's messages into your language by editing the
localization.yml file.
You should set up your events in your config file following this format:
TYPE_REWARDS must be replaced with the appropiate config key that is already on the file and EVENT with the channel points reward name, subscription tier or minimal amount of bits/subs/viewers. In case of follow events, the EVENT line should be ommited (see placeholders in
twitch.yml).
For your actions, you can use the {USER}, {TEXT} and {AMOUNT} fields to use data from your events inside of your actions. {USER} will be replaced with the chatter's username. {TEXT} will be replaced with the text input of the Channel Points Reward. {AMOUNT} will be replaced with the bits/subs/raided viewers amount.
CHANNEL_POINTS_REWARDS:
My reward:
your_favourite_streamer:
- SPAWN CREEPER 3 Steve
default:
- GIVE DIAMOND 1
Twitch Scopes The latest version of the plugin needs the following scopes to function propertly:
channel:read:redemptions: Needed to read channel point redemptions.
channel:read:subscriptions: Needed to listen for subscriptions and gifts.
moderator:read:followers: Needed to be able to listen for follows.
bits:read: Needed to listen for cheers.
chat:read and user:read:chat: Needed to show your stream chat in-game and use EventSub API.
user:bot and channel:bot: Needed to read stream chat messages
Permissions
TARGET ID: chatpointsttv.target Behaviour: Configured actions will trigger on all players with this permission.
BROADCAST ID: chatpointsttv.broadcast Behaviour: All players with this permission will get a banner message when an action is triggered.
MANAGE ID: chatpointsttv.manage Behaviour: Players with this permission will be allowed to run the /twitch command and link a Twitch account.