Skip to content
/ MMM-NHL Public
forked from fewieden/MMM-NHL

National Hockey League Module for MagicMirror²

License

Notifications You must be signed in to change notification settings

parnic/MMM-NHL

 
 

Repository files navigation

MMM-NHL GitHub license Build status Code Climate Known Vulnerabilities

National Hockey League module for MagicMirror².

Examples

past games in progress team focus no color playoffs

Dependencies

  • An installation of MagicMirror².

Installation

Just clone the module into your modules directory:

cd ~/MagicMirror/modules
git clone https://github.com/parnic/MMM-NHL

Update

Just enter the module's directory and pull the update:

cd ~/MagicMirror/modules/MMM-NHL
git pull

Configuration

  • Configure your ~/MagicMirror/config/config.js:
    {
        module: 'MMM-NHL',
        position: 'top_right',
        config: {
            // Add your config options here, which have a different value than default.
        }
    },

Config Options

Option Default Description
colored false Remove black/white filter of logos.
focus_on false Display only matches with teams of this array e.g. ['VAN', 'MTL', 'BOS'].
matches 6 Max number of matches displaying simultaneously.
rotateInterval 20000 (20 secs) How often should be rotated the matches in the list.
reloadInterval 1800000 (30 mins) How often should the data be fetched.
daysInPast 1 How many days should a game be displayed after it is finished.
daysAhead 7 How many days should a game be displayed before it starts.
liveReloadInterval 60000 (1 min) How often should the data be fetched during a live game.
showNames true Should team names be displayed?
showLogos true Should team logos be displayed?
showPlayoffSeries true Should playoff series be displayed (if in playoffs)?
rollOver false Displays today's games and based on game status also yesterdays games or tomorrows games. Automatically overrides daysInPast and daysAhead to 1.

Global config

Option Default Description
locale undefined By default it is using your system settings. You can specify the locale in the global MagicMirror² config. Possible values are for e.g.: 'en-US' or 'de-DE'.

To set a global config you have to set the value in your config.js file inside the MagicMirror² project.

config

Developer

  • npm i - Install devDependecies.
  • npm run lint - Lint check JS and CSS files.
  • npm run lint:fix - Lint fix JS and CSS files.
  • npm run docs - Generates documentation.

About

National Hockey League Module for MagicMirror²

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 82.7%
  • Nunjucks 16.3%
  • CSS 1.0%