Skip to content

Initial Release

Choose a tag to compare

@seanmccabe seanmccabe released this 06 Jan 11:34

v1.0.0 - Initial Release

BGG Sync is a robust Home Assistant integration for BoardGameGeek. It allows you to track your collection size, monitor total plays, and log new plays directly from Home Assistant.

This integration is fully updated to support BoardGameGeek's new API Token requirements.

🚀 Features

  • 📊 Collection & Play Stats: Creates sensors for your total collection size and total logged plays.
  • 🎲 Track Specific Games: Monitor play counts for specific games (e.g., "Carcassonne Plays") by adding their BGG IDs.
  • 📝 Log Plays: A dedicated service bgg_sync.record_play allows you to log plays to your BGG account from automations or dashboards.
  • ➕ Dynamic Tracking: Use the bgg_sync.track_game service to add new games to your tracking list on the fly.
  • 🔐 Secure & Compliant:
    • Uses BGG API Tokens for reliable, read-only data fetching.
    • BGG Password is optional and only required if you enable the Play Logging feature.
  • 👥 Multi-Account: Track data for multiple BGG users in a single Home Assistant instance.

📦 Installation

HACS (Custom Repository)

  1. Open HACS in Home Assistant.
  2. Click the 3 dots in the top right corner -> Custom Repositories.
  3. Add the URL of this repository: https://github.com/seanmccabe/ha-bgg-sync
  4. Select Category: Integration.
  5. Click Add and then install "BGG Sync".
  6. Restart Home Assistant.

Manual

  1. Download the latest.zip from the releases page (or clone the repo).
  2. Copy the custom_components/bgg_sync folder to your Home Assistant config/custom_components/ directory.
  3. Restart Home Assistant.

⚙️ Configuration

  1. Go to Settings > Devices & Services > Add Integration.
  2. Search for BGG Sync.
  3. Enter your BGG Username and API Token (Get one here: BGG API Applications).
  4. (Optional) Check Enable Play Logging and enter your password if you want to record plays.

Full Changelog: https://github.com/seanmccabe/ha-bgg-sync/commits/v1.0.0