Skip to content

ngoldack/bgg-go

Repository files navigation

bgg-go

CI Security Check codecov Go Report Card Go Reference

unofficial go library for boardgamegeek

IMPORTANT: This library is still in active development, do not consider it as stable! Documentation may be incomplete!

Installation

go get -u github.com/ngoldack/bgg-go

Usage

package main

import "github.com/ngoldack/bgg-go/bgg"

func main() {
    // Create a new client
    client := bgg.New()

    // Search for games with the name 'Chess' 
    results, err := client.Search("Chess", nil)
    if err != nil {
        panic(err)
    }

    // do something with the results
}

Roadmap

  • basic XML-API2 feature implementation
    • search
    • thing
    • user
    • collection
    • guilds
    • plays
    • hot
    • forums
    • threads
  • combined helper functions for easy searching with richer results

Contributing

See the Contributing.md