README.md

HearthstoneGo

Unofficial library of accessing Hearthstone game data in Go

The HearthstoneGo library provides the developer easy access to the Blizzard Hearthstone API. It handels all of the official API calls and supply the developer all the information they need.

Get Getting Started

Installing

Given that you have working Golang environment. If not refer to here.

go get github.com/wltu/HearthstoneGo

Simple Example

The CLIENT_ID and CLIENT_SECRET is created for the Blizzard API. Please follow the instruction here to create your own to use the library.

package main

import (
	"fmt"
	"os"

	"github.com/wltu/HearthstoneGo/cmd/api"
)

func main() {
	fmt.Println("Hello World!")

	clientID := os.Getenv("CLIENT_ID")
	clientSecret := os.Getenv("CLIENT_SECRET")

	if client, ok := api.NewAPI("USA", clientID, clientSecret); ok {
		fmt.Println(client.ClientToken)

		// Search for single card.

		if card :=
			client.SearchCard("52119-arch-villain-rafaam"); card != nil {
			fmt.Println(client.CardImage(card, false))
			fmt.Println(client.GoldCardImage(card, false))
		}

		// Search for single card back.
		client.SearchCardBack("155-pizza-stone")

		// Search for a set of cards
		client.BeginCardCollectionSearch()

		// Set optional parameters.
		// Visit card_collection.go for more info.
		client.SetCardTextFilter("hydra")

		if cards :=
			client.EndCardCollectionSearch(); cards != nil {
			fmt.Println(client.CardCollectionImage(cards, false))
			fmt.Println(client.GoldCardCollectionImage(cards, false))
		}

		// Search for single battlegrounds card
		if card :=
			client.SearchBattlegroundsCard(
				"60040-zapp-slywick"); card != nil {
			fmt.Println(client.CardImage(card, true))
			fmt.Println(client.GoldCardImage(card, true))
		}

		// Search for set of battlegrouds cards
		client.BeginCardCollectionSearch()
		client.SetCardGameMode("battlegrounds")
		client.SetCardTiers([]int{
			6,
		})

		if cards :=
			client.EndCardCollectionSearch(); cards != nil {
			fmt.Println(client.CardCollectionImage(cards, true))
			fmt.Println(client.GoldCardCollectionImage(cards, true))
		}

		// Search  for a single card back
		if cardBack :=
			client.SearchCardBack(
				"155-pizza-stone"); cardBack != nil {
			fmt.Println(client.CardBackImage(cardBack))
		}

		// Search for a set of card backs
		client.BeginCardBackCollectionSearch()

		// Set optional parameters.
		// Visit card_back_collection.go for more info.
		client.SetCardBackCategory("esports")

		client.SetCardTextFilter("lookout")

		if cardBacks :=
			client.EndCardBackCollectionSearch(); cardBacks != nil {
			fmt.Println(client.CardBackCollectionImage(cardBacks))
		}

		// Search for deck
		id := "AAECAQcG+wyd8AKS+AKggAOblAPanQMMS6IE/web8wLR9QKD+wKe+wKz/AL1gAOXlAOalAOSnwMA"
		if deck := client.SearchDeck(id); deck != nil {
			fmt.Println(client.DeckImage(deck))
		}

	} else {
		fmt.Println("Error in setting up HearthstoneAPI Client!")
	}
}

Project Structure

This project follows loosely the proejct structure here.

Design Document

The rough design document for the project can be found here.