Warning: This plugin requires you to open and or forward a port to your Minecraft server. Do not purchase this plugin if you can not achieve this!
There is a bit of setup involved before you can start enjoying the benefits this plugin brings. Follow a guide to get started:
1. We will need to create a Twitch Developer Application that the plugin will use to authenticate your Twitch account. Navigate to "https://dev.twitch.tv/console/apps" and click on "Register Your Application".
2. Before we continue you will need to select a TCP port that the plugin will listen on. The default is 8008, but select another available port if you need to. Ensure all traffic can reach your server on that port by opening and or forwarding your selected port to your server's machine.
3. Fill out the "Register Your Application" form with the following details:
Name: A unique name you choose for your application
4. You will be presented with "Applications" page, find your application and click "Manage".
5. Here we have all the details the plugin's config.yml needs to run correctly. As we have not generated a config.yml yet, we need to run the plugin for the first time. Place your downloaded TwitchConvergence.jar into your server's plugins folder, then start your server. TwitchConvergence will make a config.yml and a data file inside the plugins/TwitchConvergence folder. Navigate to that folder and open the config.yml for editing. Look back to the details page and fill out the information accordingly (you most likely have to click "New Secret" to view the secret).
6. It is strongly recommended that you go through the rest of the config.yml at this point and set all the settings to your liking.
7. Once your config is all filled out we can have the plugin reload it by issuing command "tc reload".
8. You may have noticed that even though your config.yml is set up you still have not authorized your twitch account for use with the plugin. To authorize a Twitch account, issue command "tc authorize". This will display a link you need to follow.
9. Once you have followed the link you will be presented with the Twitch Authorization Screen. Make sure you are authorizing the user's who channel you wish to use with the plugin. After you confirm this click the "Authorize" button.
10. That's it, your all done. TwitchConvergence is now fully functional. Have your viewers/players link their account by issuing the "tc link" command and following the instructions given to them, that way they can receive any rewards, ranks, and more that you have specified.
Enjoy = )
Notes: TwitchConvergence can only be idle for so long until Twitch will disconnect it for inactivity. This usually happens after about 12 hours or more of being idle. If it has been more than 12 hours and you are about to start streaming again, or you think the plugin has disconnected, it is a good idea to run the "tc reload" command to ensure you are connected to Twitch once more.