search

0m4r / MMM-SoccerLiveScore

Displays Soccer-Live-Scores on MagicMirror
MIT License
8 stars 6 forks source link

readme

MMM-SoccerLiveScore

This a module for the MagicMirror².
It displays live scores of your favorite soccer leagues and competitions.

Preview

Standing

Standing

Table

Table

Scorers

Scorers

Installation

  1. Navigate into your MagicMirror's modules folder and execute git clone https://github.com/0m4r/MMM-SoccerLiveScore.
  2. from the MMM-SoccerLiveScore folder run npm ci
  3. Prepare your configuration
  4. Restart your MagicMirror

Config

The entry in config.js can include the following options:

Option Description
token API Token, it can be obtained from https://www.football-data.org/pricing (a free plan is avaiable)
leagues List of league-ID's you want to display. If you put more than one league the module switches automatically between them. Type: Array
Example: [2000]
This value is REQUIRED
displayTime defines how long the information for a league in leagues is shown on the screen. This screen time is used to display standings, tables and scorers. For example, if you specify displayTime to 30 seconds and showTables=true, showStandings=trueand showScorers=true each information will be shown for about 10 seconds.

Default value: 20 * 1000
showNames Toggles teams names.

Default value: true
showLogos Toggles team logos.

Default value: true
showStandings displays the standings for the league

Default value: true
showTables displays the tables for the league (if available)

Default value: true
showScorers displays the scorers for the league (if available)

Default value: true
scrollVertical scroll the module vertically (up and down)

Default value: true

Here is an example of an entry in config.js

{
  module: 'MMM-SoccerLiveScore',
  header: 'Live-Scores',
  config: {
    leagues: [2019, 2021, 2000],
    displayTime: 60 * 1000,
    requestInterval: 2 * 60 * 1000, // 2 mins
    showNames: true,
    showLogos: true,
    showStandings: true,
    showTables: true,
    showScorers: true,
    scrollVertical: true,
    logostToInvert: [109], // some teams logo are not visible on dark background
    token: [YOUR_ROKEN_FROM_FOOTBALL_DATA_ORG],
    requestsAvailablePerMinute: [MAX_CALL_PER_MINUTE], // varies with subscription type to https://www.football-data.org/pricing
  }
},

Leagues

The available leages depeneds on the type of subscriptin you own for https://www.football-data.org/pricing.
All the avaialble leagues are listed here: https://docs.football-data.org/general/v4/lookup_tables.html#_league_codes (in the module configuration you must use the Competition Id)

Special Thanks