Skip to content

dsouzadrian/MMM-CricketScores

Repository files navigation

MMM-CricketScores

This a module for MagicMirror
https://magicmirror.builders/
https://github.com/MichMich/MagicMirror

This module display's cricket scores for ongoing live cricket matches

Screenshot

Installation

  1. Navigate into your MagicMirror modules folder and execute
    git clone https://github.com/dsouzadrian/MMM-CricketScores.git.
  2. Enter the new MMM-CricketScores directory and execute npm install.

Configuration

Option Description
numberOfResults The number of matches to be displayed at a time.
Defaults to 1
screenRefreshInterval The interval in seconds at which MMM-CricketScores iterates through all live matches. If numberOfReslts is defined as 2 - then 2 matches are displayed at one time. Additional results will be displayed next and we continue looping through.
Defaults to 10 seconds
focusTeam Determines which team is prioritized first. The team entered for this property will be pulled first in the list followed by others.
Defaults to none
apiKey API Key to retrieve cricket scores from https://www.livescore.com/en/cricket/. You can sign up for an API Key here : https://rapidapi.com/apidojo/api/livescore6/
After signing up, you must subscribe to the service to receive your api key.

Defaults to none
refreshInterval The interval at which the module is refreshed in minutes to retrieve results from the API. Beaware of API limits when setting this variable. The API Limit is 500 / month for the free subscription. Refreshing every 90 minutes will allow you to get updates for the whole month.
Defaults to 90 minutes

Example configuration

{
    module: 'MMM-CricketScores',
    position: 'right',
    config:{
        category: "cricket",
        numberOfResults : 1,
        screenRefreshInterval : 10,
        focusTeam: "India",
        apiKey: '21345', // refer to the apiKey description to get an apiKey
        refreshInterval: 90
    }
},

About

A Magic Mirror Module to display cricket scores

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published