https://github.com/Tnze/go-mc

Collection of Go libraries for Minecraft
https://github.com/Tnze/go-mc

bot golang mca minecraft minecraft-client-bot minecraft-protocol minecraft-region nbt nbt-library nbt-parser rcon rcon-client rcon-protocol rcon-server snbt yggdrasil yggdrasil-minecraft-login

Last synced: about 1 month ago
JSON representation

Collection of Go libraries for Minecraft

• Host: GitHub
• URL: https://github.com/Tnze/go-mc
• Owner: Tnze
• License: mit
• Created: 2019-05-01T06:00:17.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-07T17:53:30.000Z (3 months ago)
• Last Synced: 2024-09-07T19:05:46.953Z (3 months ago)
• Topics: bot, golang, mca, minecraft, minecraft-client-bot, minecraft-protocol, minecraft-region, nbt, nbt-library, nbt-parser, rcon, rcon-client, rcon-protocol, rcon-server, snbt, yggdrasil, yggdrasil-minecraft-login
• Language: Go
• Homepage: https://go-mc.github.io/tutorial/
• Size: 49.1 MB
• Stars: 842
• Watchers: 16
• Forks: 114
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-minecraft - Go-MC

README

        
# Go-MC

![Version](https://img.shields.io/badge/Minecraft-1.21-blue.svg)

[![Go Reference](https://pkg.go.dev/badge/github.com/Tnze/go-mc.svg)](https://pkg.go.dev/github.com/Tnze/go-mc)

[![Go Report Card](https://goreportcard.com/badge/github.com/Tnze/go-mc)](https://goreportcard.com/report/github.com/Tnze/go-mc)

[![Discord](https://img.shields.io/discord/915805561138860063?label=Discord)](https://discord.gg/A4qh8BT8Ue)

### [教程 · Tutorial](https://go-mc.github.io/tutorial/)

### [文档 · Documents](https://pkg.go.dev/github.com/Tnze/go-mc)

Require Go version: 1.22

There's some library in Go support you to create your Minecraft client or server.  

这是一些Golang库，用于帮助你编写自己的Minecraft客户端或服务器。

- [x] 👍 Minecraft network protocol

- [x] 👍 Robot framework

- [x] 👍 Server framework

- [x] 👍 Dual role RCON protocol (Server & Client)

- [x] 👍 Chat Message (Support both Json and old `§` format)

- [x] 👍 NBT (Based on reflection)

- [x] 👌 SNBT ⇋ NBT

- [x] 👍 Regions & Chunks & Blocks

- [x] ⌛ Yggdrasil (Mojang login)

- [x] ⌛ Realms Server

> We don't promise that API is 100% backward compatible.

## Getting start

Go-MC tag the old version after new version released. For example,

if *1.19.4* is the latest Minecraft version, the newest go-mc tag will be *v1.19.3*.

To get the latest Go-MC that support *1.19.4*, usually you must use `go get -u github.com/Tnze/go-mc@master`.

Special cases are version like *1.19*, the Go-MC support it is tagged `v1.19.0` to avoid automatically upgrade.  

Examples:  

To get the latest version: `go get github.com/Tnze/go-mc@master`  

To get old versions (e.g. 1.18.2): `go get github.com/Tnze/[email protected]`

To get the first of each primary version: `go get github.com/Tnze/[email protected]`

### Run Examples

- Run `go run github.com/Tnze/go-mc/examples/mcping localhost` to ping and list the localhost mc server.

- Run `go run github.com/Tnze/go-mc/examples/daze` to join the local server at *localhost:25565* as player named Daze on the offline mode.