Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fewieden/MMM-NFL

National Football League Module for MagicMirror²
https://github.com/fewieden/MMM-NFL

american-football live magicmirror national-football-league nfl statistics voice-control

Last synced: about 2 months ago
JSON representation

National Football League Module for MagicMirror²

Host: GitHub
URL: https://github.com/fewieden/MMM-NFL
Owner: fewieden
License: mit
Created: 2016-08-18T09:27:05.000Z (about 8 years ago)
Default Branch: master
Last Pushed: 2023-10-08T06:00:50.000Z (12 months ago)
Last Synced: 2024-06-29T09:36:15.830Z (3 months ago)
Topics: american-football, live, magicmirror, national-football-league, nfl, statistics, voice-control
Language: JavaScript
Homepage:
Size: 998 KB
Stars: 27
Watchers: 14
Forks: 10
Open Issues: 4
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-mmm - **MMM-NFL**

README

        # MMM-NFL

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/fewieden/MMM-NFL/master/LICENSE) ![Build status](https://github.com/fewieden/MMM-NFL/workflows/build/badge.svg) [![Code Climate](https://codeclimate.com/github/fewieden/MMM-NFL/badges/gpa.svg?style=flat)](https://codeclimate.com/github/fewieden/MMM-NFL) [![Known Vulnerabilities](https://snyk.io/test/github/fewieden/mmm-nfl/badge.svg)](https://snyk.io/test/github/fewieden/mmm-nfl)

National Football League Module for MagicMirror²

## Example

![](.github/regular-season.png) ![](.github/post-season.png) ![](.github/statistic-modal.png) ![](.github/help-modal.png)

## Dependencies

* An installation of [MagicMirror²](https://github.com/MichMich/MagicMirror)

* npm

* [node-fetch](https://www.npmjs.com/package/node-fetch)

## Installation

1. Clone this repo into `~/MagicMirror/modules` directory.

1. Configure your `~/MagicMirror/config/config.js`:

    ```

    {

        module: 'MMM-NFL',

        position: 'top_right',

        config: {

            // all your config options, which are different than their default values

        }

    }

    ```

1. Run command `npm install --production` in `~/MagicMirror/modules/MMM-NFL` directory.

## 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.

![](.github/global.png)

## 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. `['NYG', 'DAL', 'NE']`. |

| `format` | `'ddd h:mm'` | In which format the date should be displayed. [All Options](http://momentjs.com/docs/#/displaying/format/) |

| `reloadInterval` | `1800000` (30 mins) | How often should the data be fetched. |

| `reverseTeams` | `false` | Flag to switch order of home and away team. |

| `tableSize` | `'small'` | Font size of table. Possible values: `'xsmall'`, `'small'`, `'medium'`, `'large'` and `'xlarge'` |

## OPTIONAL: Voice Control and Modal

This module supports voice control by [MMM-voice](https://github.com/fewieden/MMM-voice) and [MMM-Modal](https://github.com/fewieden/MMM-Modal).

In order to use this feature, it's required to install the voice and modal modules. There are no extra config options for voice control and modals needed.

### Mode

The voice control mode for this module is `FOOTBALL`

### List of all Voice Commands

* OPEN HELP -> Shows the information from the readme here with mode and all commands.

* CLOSE HELP -> Hides the help information.

* SHOW PASSING YARDS STATISTIC -> Shows statistic of players with most passing yards.

* SHOW RUSHING YARDS STATISTIC -> Shows statistic of players with most rushing yards.

* SHOW RECEIVING YARDS STATISTIC -> Shows statistic of players with most receiving yards.

* SHOW TACKLES STATISTIC -> Shows statistic of players with most tackles.

* SHOW SACKS STATISTIC -> Shows statistic of players with most sacks.

* SHOW KICKOFF YARDS STATISTIC -> Shows statistic of players with most kickoff yards.

* SHOW INTERCEPTIONS STATISTIC -> Shows statistic of players with most interceptions.

* SHOW PASSING TOUCHDOWNS STATISTIC -> Shows statistic of players with most passing touchdowns.

* SHOW QUARTERBACK RATING STATISTIC -> Shows statistic of quarterbacks with best rating.

* SHOW RUSHING TOUCHDOWNS STATISTIC -> Shows statistic of players with most rushing touchdowns.

* SHOW RECEPTIONS STATISTIC -> Shows statistic of players with most receptions.

* SHOW RECEIVING TOUCHDOWNS STATISTIC -> Shows statistic of players with most receiving touchdowns.

* SHOW TOTAL POINTS STATISTIC -> Shows statistic of players with most points.

* SHOW TOTAL TOUCHDOWNS STATISTIC -> Shows statistic of players with most touchdowns.

* SHOW PUNT YARDS STATISTIC -> Shows statistic of players with most punt yards.

* SHOW PASSES DEFENDED STATISTIC -> Shows statistic of players with most passes defended.

* HIDE STATISTIC -> Hide statistic informations

## Developer

* `npm run lint` - Lints JS and CSS files.