mcproto

README

go-mcproto ⚒️

Implementation of the Minecraft Protocol in go (still in progress...)

Example ✨

This example initializes the connection between the client and the server, thus switching to the Play state, and listens for keepalive packets to which it responds

package main

import (
	"github.com/BRA1L0R/go-mcproto"
	"github.com/BRA1L0R/go-mcproto/packets/models"
)

func main() {
  client := mcproto.McProto{
    Host: "my.minecraftserver.com",
    Port: 25565,
    ProtocolVersion: 754, // 1.16.5
    Name: "QuickStart",
  }
  
  client.Initialize()
  
  for {
    packet, err := client.ReceivePacket()
    if err != nil {
      panic(err)
    }
    
    if packet.PacketID == 0x1F { // clientbound keepalive packetid
      receivedKeepalive := models.KeepAlivePacket{MinecraftPacket: packet}

      err := receivedKeepalive.DeserializeData(&receivedKeepalive)
      if err != nil {
        panic(err)
      }
      
      serverBoundKeepalive := new(models.KeepAlivePacket)
      serverBoundKeepalive.KeepAliveID = receivedKeepalive.KeepAliveID
      serverBoundKeepalive.PacketID = 0x10 // serverbound keepaliveid

      err = client.WritePacket(serverBoundKeepalive)
    }
  }
}

Documentation

Index

• type McProto
  • func (mc *McProto) GetCompressionTreshold() int32
  • func (mc *McProto) Initialize() error
  • func (mc *McProto) ReceivePacket() (packets.MinecraftPacket, error)
  • func (mc *McProto) WritePacket(packet MinecraftPacket) error
  • func (mc *McProto) WriteRawPacket(packet MinecraftPacket) error
• type MinecraftPacket

Types

type McProto

type McProto struct {
	Host            string
	Port            uint16
	Name            string
	ProtocolVersion int32
	// contains filtered or unexported fields
}

func (*McProto) GetCompressionTreshold

func (mc *McProto) GetCompressionTreshold() int32

func (*McProto) Initialize

func (mc *McProto) Initialize() error

Initializes the connection to the server by sending the handshake packet and the login packet

Server Host, Port and Username are defined in the McProto object

func (*McProto) ReceivePacket

func (mc *McProto) ReceivePacket() (packets.MinecraftPacket, error)

func (*McProto) WritePacket

func (mc *McProto) WritePacket(packet MinecraftPacket) error

WritePacket calls SerializeData and then calls WriteRawPacket

func (*McProto) WriteRawPacket

func (mc *McProto) WriteRawPacket(packet MinecraftPacket) error

WriteRawPacket takes a packet with PacketID and Data already filled out, and serializes it to a byte slice, which is subsequently written to the underlying connection

type MinecraftPacket

type MinecraftPacket interface {
	// SerializeData takes an interface pointer as input and serializes all the fields in the
	// data buffer. It can and will return an error in case of invalid data
	SerializeData(inter interface{}) error

	// Serialize takes compressionTreshold as an input, which can be negative in case of a disabled
	// compression, and serializes it into a byte slice
	Serialize(compressionTreshold int32) ([]byte, error)
}

MinecraftPacket defines the standard methods that a struct should have in order to be serializable by the library

You can actually create your own methods as long as they respect this standard