MMM-PGA

A MagicMirror² module to display PGA leaderboards, tournaments, and rankings.

A configurable leaderboard can be shown with scores for your favorite golfers.

• NOTE: from version 2.1.1, an API key is no longer needed!
• NOTE: Running npm install (or npm ci) during installation and upgrade is is now recommended in the documentation (though not strictly necessary unless the main MagicMirror² code is changed to eliminate the moment-timezone dependency)

Preview

Installing the Module

cd ~/MagicMirror/modules
git clone https://github.com/dathbe/MMM-PGA
cd MMM-PGA
npm install --omit=dev

Dependencies:

• moment-timezone

Note: running npm install is not strictly necessary unless the main MagicMirror² code is changed to eliminate the moment-timezone dependency.

Updating the Module

cd ~/MagicMirror/modules/MMM-PGA
git pull
npm install --omit=dev

Configuration

Add an MMM-PGA module to the modules array in the ~/MagicMirror/config/config.js file. The following example config shows a minimal configuration option. More options are described below.

{
  module: 'MMM-PGA',
  position: "top_left",
  config: {
    showLogo: true,
    showFlags: true,
  }
},

Option	Description
For Leaderboards
showBoards	Whether to show the Leaderboard and favorites for and active tournament. If set to false the module will just show the current tournament. See Upcoming tournament screen shot above. Type: bool Default value: true
numLeaderboard	The number of places to show on the leaderboard Type: int Default value: 5
maxLeaderboard	The maximum number of players to show on the leaderboard. For example if numLeaderboard is set to 5 and maxLeaderboard is set to 10 * If there are currently 9 players in the top 5 with ties then 9 players will be displayed * If there are 12 players in the top 3 only 10 players will be shown and the last two players tied for 3rd will not be displayed. The order of the players is determined by the Data provider(ESPN) Type: int Default value: 10
includeTies	Whether to include more than numLeaderboard players due to ties. If false only numLeaderboard players will be shown and maxLeaderboard will be irrelevant. Type: bool Default value: true
showFlags	Shows the flag of the player's country next to the player in the leaderboards Type: bool Default value: true
showLocation	Whether to show the location of the tournament in the tournament details header. (Also affects Upcoming tournament view.) Type: bool Default value: true
showPurse	Whether to show the purse information in the tournament details header. (Also affects Upcoming tournament view.) Type: bool Default value: true
header	The header text to display when a leaderboard is showing. Type: string Default value: PGA TOURNAMENT
showBroadcast	Whether to show the broadcast channel for the tournament. Type: bool Default value: true
For Favorites Boards
favorites	Array of favorite players to display on one or more boards. Each favorite board has a headerName and a favoriteList array of player ids. See below for details. Players in the favorite board object will be displayed on the board if they are playing in the current tournament. Favorite boards will rotate along with the overall leaderboard. Type: array Default value: [] (empty)
remoteFavoritesFile	Location of a remote File to use for favorites. The format of the file is a json file with exactly what you would set in the favorites configuration. If this option is set any favorites defined in the config will be ignored. Examples: - 'utilities/favorites.json' (Local file. File path is relative to MMM-PGA folder, so this example would point to ~/MagicMirror/modules/MMM-PGA/utilities/favorites.json.) - 'https://dl.dropboxusercontent.com/s/7my######/favorites.json' (File stored in Dropbox) Type: string Default value: null
header	Works the same as on Leaderboards (see above).
For Rankings
showFedex	Whether to show FedEx Cup standings when a tournament is not active. If set to true the module will rotate between the upcoming tournaments and selected rankings. Type: bool Default value: true
showOWGR	Whether to show Official World Golf Rankings when a tournament is not active. If set to true the module will rotate between the upcoming tournaments and selected rankings. Type: bool Default value: true
numRankings	The number of players to show in the Fedex Cup and OWGR rankings. The number should be set between 1 and 50. Type: int Default value: 5
For Upcoming Tournaments
numTournaments	Number of upcoming tournaments to show when there is not an active tournment in progress or showBoards is set false. Type: int Default value: 3
showLocation	Works the same as on Leaderboards (see above).
showPurse	Works the same as on Leaderboards (see above).
General Display Options
showLogo	Shows the PGA logo in the header Type: bool Default value: false
largerFont	Whether to display larger fonts for the module. If set to false it will use the xsmall style defined by MagicMirror². If set to true it will use the small style defined by MagicMirror². Type: bool Default value: false
colored	Whether to display colors within the module in, for example, the scores and icons. Type: bool Default value: true
rotateInterval	Time (in milliseconds) to display a card from the module before rotating to the next card (only matters if there is more than one card to display). Type: int Default value: 30 * 1000 (30 seconds)
animationSpeed	Animation time to fade in and out, in milliseconds, when rotating between cards. Type: int Default value: 750

Screenshots

Upcoming Tournament View

Fedex Cup Standings

OWGR

Leaderboard View

Working with Favorites

Setting Favorites

If you want to add favorites to your config, it will be in the following format:

{
  module: 'MMM-PGA',
  position: "top_left",
  config: {
    favorites: [
      {
        "headerName": "My Favorites",
        "favoriteList": ["462", "5467", "4848", "6798", "9478", "3470"]
      },
      {
        "headerName": "Some Other Favs",
        "favoriteList": ["5467", "9025", "4412121", "4848"]
      }
    ],
  }
},	

You can also use a remoteFavoritesFile, either locally on using a url. The format of the file is essentially the same as setting the favorites option directly. An example file can be found at utilities/favorites.json.

Getting the IDs of Your Favorite Players

You can look up a player on ESPN's website. The easiest way is as follows:

1. Goto to https://www.espn.com/golf/leaderboard
2. Find the player you want to add to your favorites
3. Right-click on the player's name and open the link in a new tab (or just hover over the name and the destination url may appear at the bottom of your browser window, depending on your browser settings)
4. The id will show up in the url. For example the url for Scottie Scheffler is https://www.espn.com/golf/player/_/id/9478/scottie-scheffler. His player ID is be 9478

A players.md file is also included with a list of players along with their associated id. But this list will not be updated, so many newer players will not be listed.

Updating Favorites

You can send a post request to the MMM-PGA module that will cause it to reload the favorites information from any remote file using the following command:

curl -X POST http://localhost:8080/MMM-PGA-UpdateFavs

You can use localhost if running the command from the host where the mirror is installed or you can replace localhost with the ip address/hostname of your mirror and run it from any machine on your network. Make sure to configure your mirror to allow calls from other nmachine if doing this.

There is an example python script you can adapt, which will check if a specified favorites file has changed and, if so, send the appropriate post. You could run this script in cron and it will automatifcally update my mirror every time the file changes.

You can always just restart the mirror and it will reload the favorites on startup. (It would not be particularly difficult to add a timer to the module to check for updates to the file. Open an issue if you think this is something that should be added.)

Contributing

If you find any problems, bugs or have questions, please open a GitHub issue in this repository.

Pull requests are of course also very welcome 🙂

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Developer commands

You will need to first install the dev dependencies:

cd ~/MagicMirror/modules/MMM-PGA
git switch development
npm install

Please create all PRs against the development branch for testing and eventual merging into master.

• node --run lint - Run linting checks.
• node --run lint:fix - Fix automatically fixable linting errors.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Thank You

Special thank you to mcl8on and mumblebaj, who created the original versions of this module and did most of the work.