choffmann / MMM-YT-SubCount

📺 MagicMirror Module - Show the subscription from a Youtube Channel on the MagicMirror

MMM-YT-SubCount

This is a module for the MagicMirror².

This module show the number of Youtube Subscriber on the MagicMirror. All you need is a Google Developer Account to activate the Youtube API. The API is limited to 10.000 Quota. Here, one API call is one Quota.

The YouTube API rounded the value down. For example a subscriber count of 12,345 will shown as 12.3K. For more Information see here

Version 1.0.0

YouTube Subscriber Counter with profile image	YouTube Subscriber Counter without profile image

Installation

This module is pretty simple to set up. You simply need to clone the module into your modules folder (like other modules).

$ cd MagicMirror/modules
$ git clone https://github.com/choffmann/MMM-YT-SubCount.git

After you clone the repositories, you have to install the node modules

$ cd ./MMM-YT-SubCount
$ npm install

Get your API Key

To use this Module, you need to activate the YouTube API from the Google Developer Console, see Step 2. → API Keys Youtube Documentation

1. Go to the Google Developer Console with your Google Account or create a new.
2. After logging in, go to APIs & Services left in the Burger Menu.
3. Go to Library an search for YouTube Data API v3
4. Enable this API. You should be redirect to the overview.
5. Create an API Key in the Menu Credentails → + CREATE CREDENTAILS

YouTube Channel

To display the subscribtion, you need to define which channel you want to display. You can also display multiple channels. All you need is the Channel ID. You can find the Channel ID in the URL in YouTube.

Using the module

To use this module, add the following configuration block to the modules array in the config/config.js file:

var config = {
  modules: [
    {
      module: "MMM-YT-SubCount",
      header: "Youtube Counter",
      position: "top_right",
      config: {
        apiKey: "YOUR_API_KEY",
        showChannelImg: true,
        channelIds: [
          {
            id: "UC8uT9cgJorJPWu7ITLGo9Ww"
          },
          {
            id: "UCKuHFYu3smtrl2AwwMOXOlg"
          }
          // and so on...
        ]
      }
    }
  ]
};

Configuration options

Option	Description
apiKey	Required Your API Key goes here
channelIds	Required Put the Channel ids here in the Array { id: " CHANNEL_ID" },
showChannelImg	Optional Display the channel profile image Type: boolean Default true
updateInterval	Optional Refresh rate Type: int(milliseconds) Default 60000 milliseconds (1 minute)