mirror of
https://github.com/parnic/MMM-ShiftStats.git
synced 2025-11-07 03:31:56 -06:00
Show stats from your sports team tracked by Shift
baseball
baseballshift
basketball
digitalshift
football
footballshift
hockey
hockeyshift
lacrosse
lacrosseshift
magicmirror
magicmirror2
soccer
soccershift
sports
sports-stats
| .gitignore | ||
| LICENSE | ||
| MMM-ShiftStats.js | ||
| node_helper.js | ||
| package.json | ||
| README.md | ||
| screenshot.png | ||
| shiftstats.css | ||
MMM-ShiftStats
A MagicMirror² module used to display stats from any DigitalShift site (HockeyShift, SoccerShift, LacrosseShift, FootballShift, BasketballShift, and BaseballShift).
Installation
- Navigate into your MagicMirror's
modulesfolder and executegit clone https://github.com/parnic/MMM-ShiftStats.git. cd MMM-ShiftStats- Execute
npm installto install the node dependencies. - Add the module inside
config.jsplacing it where you prefer.
Config
| Option | Type | Description | Default |
|---|---|---|---|
| apiKey | string |
Your API key. If not supplied, the HockeyShift Android app's key is used by default. | |
| teamName | string |
(REQUIRED) The name of the team you want to track. | |
| sport | string |
(REQUIRED) The name of the sport you want to track (e.g. 'hockey', 'soccer'). |
|
| mode | string |
What mode the module should run in. Valid values: 'standings', 'games' |
'standings' |
| maxGames | number |
When in games mode, how many games should be shown (it will show this many most recent games). |
6 |
| teamNameClass | string |
CSS class to apply to displayed team names. | 'light' |
| updateInterval | number |
How frequently, in milliseconds, to update the info. | 12 * 60 * 60 * 1000 (every 12 hours) |
Here is an example of an entry in config.js
{
module: 'MMM-ShiftStats',
header: 'Standings',
position: 'top_left',
config: {
teamName: 'Bears',
sport: 'Hockey'
}
},
Screenshot
Notes
Pull requests are very welcome! If you'd like to see any additional functionality, don't hesitate to let me know.
Dependencies
This uses a Node.JS library I created for interfacing with DigitalShift sites: node-shiftstats, so feel free to check that out for more information.
