mcutils - Implementation of Minecraft protocols in Go
Informations
General
All protocols are implemented in Go, without any external dependency. All protocols should be supported on any platform/architecture as long as Go can compile them.
All protocols have been implemented using wiki.vg. All of them are 100% compliant with the standard described there.
This project also contains an helper in communication with tcp/udp, called pkg/networking.
This project has no dependency.
Supported protocols
All protocols implementations support SRV record resolving.
Rcon implementation supports fragmented response packets.
CLI
Install
go install github.com/xrjr/mcutils/cmd/mcutils
Usage
$ mcutils ping <hostname> <port>
Example : mcutils ping localhost 25565
$ mcutils query <basic|full> <hostname> <port>
Example : mcutils query basic localhost 25565
$ mcutils rcon <hostname> <port> <password> <command>
Example : mcutils rcon localhost 25575 mypassword "say hello"
How to use (simple way) ?
Ping
// Ping returns the server list ping infos (JSON-like object), and latency of a minecraft server.
properties, latency, err := ping.Ping("localhost", 25565)
Query
// QueryBasic returns the basic stat of a minecraft server.
basicStat, err := query.QueryBasic("localhost", 25565)
// QueryBasic returns the full stat of a minecraft server.
fullStat, err := query.QueryFull("localhost", 25565)
Rcon
// Rcon executes a command on a minecraft server, and returns the response of that command.
response, err := rcon.Rcon("localhost", 25575, "password", "command")
How to use (full control way) ?
Ping
pingclient := ping.NewClient("localhost", 25565)
// Connect opens the connection, and can raise an error for example if the server is unreachable
err := pingclient.Connect()
// Handshake is the base request of ping, the one that displays number of players, MOTD, etc...
// If all went well, hs contains a field Properties which contains a golang-usable JSON Object
hs, err := pingclient.Handshake()
// Ping is a request that basically do nothing and is just used for measuring the latency
// pong contains the latency in ms
pong, err := pingclient.Ping()
// Disconnect closes the connection
err = pingclient.Disconnect()
Query
queryclient := query.NewClient("localhost", 25565)
// Connect opens the connection, and can raise an error for example if the server is unreachable
err := queryclient.Connect()
// Handshake request is used to get the challenge token, needed for questing basic and full stat
challengeToken, err := queryclient.Handshake()
// BasicStat returns several informations about the server like number of players, maximum number of players, etc... in a fully predictable way
bs, err := queryclient.BasicStat(challengeToken)
// FullStat returns several informations (more than BasicStat) in a JSON format, plus the list of connected players
fs, err := queryclient.FullStat(challengeToken)
// Disconnect closes the connection
queryclient.Disconnect()
Rcon
rconclient := rcon.NewClient("localhost", 25575)
// Connect opens the connection, and can raise an error for example if the server is unreachable
err := rconclient.Connect()
// Authenticate request is used to authenticate the connection.
// If the authentication succeeds, ok will be true, and if it fails, ok will be false.
// err will be nil unless there is a communication problem with the server
ok, err := rconclient.Authenticate("password")
// Command will execute the given command on the server, and the output text will be returned in res
res, err := rconclient.Command("playerlist")
// Disconnect closes the connection
rconclient.Disconnect()
