Twitch Live Announcer (v.1.8.0)

A Spigot plugin that broadcasts a message when a Twitch streamer goes live or offline.

Prerequisites:

• Java 11+

• PlaceholderAPI (to use placeholderAPI features)

• Twitch API Key

Installation:

To install this plugin download it from spigot and put it in you plugin folder

Configuration files:

• config.yml

• messages.yml

Config walkthrough:

reload_time: 60

This is the time in seconds how often the plugin will check the status of the channels specified in the configuration

client_id: '' client_secret: ''

These are the most important settings of the plugin, here you have to specify you twitch token to be able to get information from the channels To get this token you have to go to this page After the login you will be presented to a page like this Here you have to click "Register your application", it will ask for a name, oauth redirect url, and category. As for the name and category you can insert whatever you like, in the oauth url you can put http://localhost as my application does not have necessity of this feature. After clicking create you will be brought back to the initial page, here you have to click 'manage' and a page like this will be shown You can see here you client ID, to generate your client secret you have to click 'New secret'

check_updated: true

If this is set to true, the plugin on startup will check if a new version is available on spigot, and notify that in the console

channels: []

This is the list of all the channels you want the plugin to check Example of working list:

channels:
  - 'ElSpreen'
  - 'Forsen'
  - 'Dream'

All these channels will be audited every "reload_time" to obtain information on their status (online, offline, stream type)

For this feature to work you need PlaceholderAPI

linked_users: []

This feature allow you to connect your minecraft player to his twitch channel Example:

linked_users:
  Dream_minecraft:
  - Dream_twitch_channel

After you link a player to his channel you can use the placeholder %tla_status% for example in tab to show the stream status of the player (Online/Offline - Customizable)

commands: ...

Here you can specify custom commands to execute when a stream status changes

Default values:

commands:
  enabled: false
  start:
    - 'tellraw @a {"text":"%channel% is now streaming","color":"gray"}'
  stop:
    - 'tellraw @a {"text":"%channel% is not streaming anymore","color":"gray"}'

In this example when the stream goes live a grey text with written '%channel% is now streaming' will be broadcasted to all players

Filters

Filtering stream game: In this section you can check for specific games streamed (this is a setting from the streamer end) Default values:

filter-stream-type:
  enabled: false
  games:
    - 'Minecraft'

Filtering stream title: Here you can check for a specified string in the title of the stream, useful if you want for example to set the online status of the live only if the title contains your server name

filter-stream-title:
  enabled: false
  text:
    - 'Minecraft server!'

placeholders: ...

These are the values of the placeholder that shows the stream information, they are the same shown by link feature

Default values:

placeholders:
  enabled: true
  live: '&c[Live]'
  offline: '&7[Offline]'

bungee: ...

This feature allows you to send the stream start stop message to all the servers on you bungeecord network (beta feature)

Disable streaming messages

When set to true the corresponding message broadcast will be disabled

disable-streaming-message: false
disable-not-streaming-message: false