MMM-TwitchAlert

Keep updated on your favourite streamers with this neat module. You can see when streamers are live and what game they are playing at a glance.

Example

Prerequisites

This modules uses the free Twitch API. You will need to do some additional steps before the module runs.
Don't worry, this is easy and well documented if you have troubles!

Installation

1. cd modules from your MagicMirror folder
2. git clone https://github.com/WilliamFitzjohn/MMM-TwitchAlert.git

API Key

1. Navigate to https://dev.twitch.tv/login and login using your twitch account.
2. Go into your account settings and enable 2FA. It is required to get your API key.
3. Go to https://dev.twitch.tv/console and click Register Your Application under the Applications tab
   
   1. Set Name to something like MagicMirror
   2. Set OAuth Redirect URLs to http://localhost
   3. Set Category to Application Integration
   4. Click Create
4. Now open up your new application
   
5. Click New Secret and copy the Client ID and Client Secret into the MagicMirror config
   

Config

Add this to your MagicMirror config file

{
    module: "MMM-TwitchAlert",
    position: "bottom_left",
    config: {
        client_id: "INSERT_CLIENT_ID_HERE",
        client_secret: "INSERT_CLIENT_SECRET_HERE",
        // live_only: false,
        // show_live_badge: false,
        // update_interval: 3, //minutes
        // alignment: 'right'
        streamers: [
            "papashlomo",
            "xqcow",
            "ludwig",
        ],
    },
},

Config Arguments

Argument	Type	Description	Required	Default Value
client_id	string	Client ID of your application in the Twitch API	Yes	N/A
client_secret	string	Client Secret of your application in the Twitch API	Yes	N/A
streamers	string[]	List of streamers you wish to track	Yes	N/A
live_only	boolean	Only show live streamers on your mirror	No	true
show_live_badge	boolean	Show the "live" badge	No	true
show_streamer_image	boolean	Show the Image of the streamer	No	true
update_interval	integer	How many minutes between updating data (min = 1)	No	5
alignment	string	'left' or 'right' align the module	No	'left'