Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SpencerSharkey/gomc
⛏️minecraft golang library
https://github.com/SpencerSharkey/gomc
go go-library golang-library minecraft minecraft-api minecraft-query
Last synced: 14 days ago
JSON representation
⛏️minecraft golang library
- Host: GitHub
- URL: https://github.com/SpencerSharkey/gomc
- Owner: SpencerSharkey
- Created: 2017-11-02T05:42:08.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2020-06-08T20:05:37.000Z (over 4 years ago)
- Last Synced: 2024-06-19T23:29:31.887Z (6 months ago)
- Topics: go, go-library, golang-library, minecraft, minecraft-api, minecraft-query
- Language: Go
- Homepage:
- Size: 31.3 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome - SpencerSharkey/gomc - ⛏️minecraft golang library (Go)
- awesome - SpencerSharkey/gomc - ⛏️minecraft golang library (Go)
README
Minecraft Go
===
[](https://travis-ci.org/SpencerSharkey/gomc)
[](https://coveralls.io/github/SpencerSharkey/gomc?branch=master)
[](https://codeclimate.com/github/SpencerSharkey/gomc/maintainability)
[](http://hits.dwyl.io/SpencerSharkey/gomc)
## Introduction
Go (golang) library for Minecraft utilities.
The only functionality currently implemented is a query client compatible with the vanilla Minecraft [query protocol](http://wiki.vg/Query).
Planned packages:
* ~~query~~ [/query](https://github.com/SpencerSharkey/gomc/tree/master/query)
* rcon
**Note:** This package is being developed for use within the [spencersharkey/mcapi](https://github.com/spencersharkey/mcapi) application, aimed at exposing an HTTP client for various Minecraft-related utilities.
## "query" Package Documentation
### (*query.Request) Simple()
```golang
type SimpleResponse struct {
Hostname string `json:"hostname"`
GameType string `json:"gametype"`
Map string `json:"map"`
NumPlayers int `json:"numplayers"`
MaxPlayers int `json:"maxplayers"`
HostPort int16 `json:"hostport"`
HostIP string `json:"hostip"`
}
```
Simple request example:
```golang
req := query.NewRequest()
err := req.Connect("127.0.0.1:25565")
res, err := req.Simple()
```
```json
{
"hostname": "Revive Minecraft! http://revive.gg/chat",
"gametype": "SMP",
"map": "world",
"numplayers": 4,
"maxplayers": 128,
"hostport": 25565,
"hostip": "127.0.0.1"
}
```
### (*query.Request) Full()
*Note:* `FullResponse` embeds the `SimpleResponse` struct
```golang
type FullResponse struct {
SimpleResponse
Info map[string]string `json:"info"`
Players []string `json:"players"`
}
```
Full request example:
```golang
req := query.NewRequest()
err := req.Connect("127.0.0.1:25565")
res, err := req.Full()
```
```json
{
"hostname": "Revive Minecraft! http://revive.gg/chat",
"gametype": "SMP",
"map": "world",
"numplayers": 4,
"maxplayers": 128,
"hostport": 25565,
"hostip": "127.0.0.1",
"info": {
"game_id": "MINECRAFT",
"plugins": "",
"version": "1.12.2"
},
"players": [
"SpencerSharkey",
"RumBull",
"lonemajestyk",
"nakkirakki"
]
}
```