Skip to content
This repository has been archived by the owner on May 6, 2019. It is now read-only.

Latest commit

 

History

History
57 lines (41 loc) · 2.72 KB

README.md

File metadata and controls

57 lines (41 loc) · 2.72 KB

Minecraft  Travis Coverage Status GoDoc Dependencies Go Report Card

Minecraft is a collection of SemVer-versioned Minecraft libraries written in Go. At the time of writing it contains the following Go packages:

  • profile, a binding for querying the public Mojang API for Minecraft profiles, supporting:
    • Lookup based on either Minecraft username or ID.
    • Fetching ID, current username, skin textures and history of prior usernames.
  • versions, a small package for fetching Mojang's listing of Minecraft versions and working with the reported version information; includes release dates of both official releases and the latest development snapshots.

Examples of usage can be found on the GoDoc reference pages linked above.

Installing

Use go get to download the packages to your workspace or update them:

$ go get -u github.com/PhilipBorgesen/minecraft/...

Running the tests

Use go test to run the entire test suite incl. integration tests:

$ go test -tags=integration github.com/PhilipBorgesen/minecraft/...

Known issues

The project has been used by the author to learn Go. With that said, it is not perfect:

  • Tests cannot be run in parallel due to dependence on global client variables.
  • profile.ErrMaxSizeExceeded should have been named MaxSizeExceededError to adhere to naming conventions. As an underlying design issue it did not need to be a type, a single error value would have been sufficient.

License

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