https://github.com/thomasjbradley/mmm-boardgamegeek-wincounts

Display win counts for a set of names from a single user on BoardGameGeek
https://github.com/thomasjbradley/mmm-boardgamegeek-wincounts

Last synced: 22 days ago
JSON representation

Display win counts for a set of names from a single user on BoardGameGeek

• Host: GitHub
• URL: https://github.com/thomasjbradley/mmm-boardgamegeek-wincounts
• Owner: thomasjbradley
• License: mit
• Created: 2023-10-08T13:52:03.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-01T16:25:10.000Z (10 months ago)
• Last Synced: 2024-04-14T22:12:05.186Z (7 months ago)
• Language: JavaScript
• Size: 14.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Board Game Geek Win Stats for MagicMirror

**Load all of the current year’s win stats from plays of a single BGG username & aggregate win totals from a list of provided plyer names.**

Built using the [Board Game Geek API](https://boardgamegeek.com/wiki/page/BGG_XML_API2).

---

## Instal the module

To install, clone this repo into the `~/MagicMirror/modules` directory. Then move into the folder and install the required dependencies.

```

cd ~/MagicMirror/modules

git clone https://github.com/thomasjbradley/MMM-BoardGameGeek-WinCounts

cd MMM-BoardGameGeek-WinCounts

npm install

```

## Set up the module

Set up the module by adding the following configuration block to the modules array in your `config/config.js` file:

```js

var config = {

    modules: [

        {

            module: 'MMM-BoardGameGeek-WinCounts',

            position: 'bottom_left',

            config: {

                username: "thomasjbradley", // The BGG user to grab play stats from

                names: ["Thomas", "Liz", "Edith"], // The filter of names from the plays to aggregate

            }

        }

    ]

}

```

## Config options

| Option         | Description                                                      |

| -------------- | ---------------------------------------------------------------- |

| username       | The BGG username to grab play stats from                         |

| names          | An array of player names to aggregate wins for                   |

| updateInterval | *Optional* How often to update the win stats; Default 15 minutes |