Configuring

Configuring the MS Twitch Stream software is very easy. All options are self-explaining and additional help has been provided.

MS Twitch Stream Module / Component

MS Twitch Stream Module options

Setting Explanation Recommended
Twitch Username The Twitch username from the stream you want to display.
Player Muted Enable this option if you want to mute the player when the page loads. The user can unmute the player at any time. Yes
Player Autoplay Enable this option if you want the stream to start playing automaticly. Yes
Player Aspect Most streamers use the 16:9 ratio to stream their games. If your streamer does not and you want to remove the borders, try fiddling with this setting. Most of the time you can leave it on 16:9 16:9
Player Quality The initial quality of the game stream. Please take note of mobile users visiting your site so don't put this setting on original. Medium or high are fine aswell. High
Hide if offline Enable this option if you want the plugin to automaticly hide and show this module based on the online status of the streamer. You must have setup the plugin correctly. Yes

If you want to use the Hide if offline option, you should've setup the plugin correctly for it to work.




MS Twitch Chat Module

MS Twitch Chat Module options

Setting Explanation Recommended
Twitch Username The Twitch username of the streamer you want to display the live chat for.
Player Height Enter a height in pixels to force the module to display. The embed is an iframe which means it cannot determine its own height correctly. 464




MS Twitch Status Module

MS Twitch Status Module options

A correctly setup Status plugin is required for this module. How to setup

Setting Explanation Recommended
Additional Streamers Enter additional Twitch usernames to display them in the list. You may add as much as you like.
Site Uses Bootstrap? If your website does not use Bootstrap, it may require some styling. This will be injected if you choose no. Don't worry, it won't break your site! No
Show Offline Streamers Enable this option if you want to show offline streamers aswell. They will be put at the bottom of the list. No
Use Indicators Enable this option if you want a collored bullet based on the online status next to the username Yes
Link usernames? Enable this option if you want the username to link to the Twitch stream on the Twitch TV website No
Sort List Select a sorting method to sort the list of usernames None
All Users Offline Message Enter a message which displays whenever everyone is offline.
All Users Online Message Enter a message which displays whenever everyone is online.

You do not need to add all usernames you use on your website to Additional Streamers as they are automaticly added whenever they use the Hide if offline option in the module or menu item.




MS Twitch Status Plugin

MS Twitch Status Plugin options

Setting Explanation Recommended
Client ID In order to use the Hide if offline and MS Twitch Status Module you'll need a Twitch API key. This is called the Twitch Client ID. Find out below how to retrieve one
Cache (in seconds) Cache time in seconds. Use 0 for a realtime result, which can cause your site to slow down. Use 1 for near-realtime. 60
Retrieving a Twitch Client ID

You can request one from the Twitch website. You'll need a Twitch account.

  1. Login to your Twitch account at Twitch
  2. Go to your dashboard
  3. If you already created an application and you have a Client ID, you may use that one. If not, proceed to step 4
  4. Create a new application. Fill in your website's title as Application title
  5. Use http://localhost as Redirect URL, as we are not using it
  6. Select a category. It does not matter which one.
  7. Save the application, copy the Client ID and put the Client ID in the plugin's configuration.
  8. All done! Automaticly hiding and enabling should now work!

For more information or visuals, please see this article.