protocol

Documentation

Overview

package protocol describes the basic types needed to work with the Minecraft protocol this server is being developed for protocol version 498 (mc version 1.14.4)

Index

• Constants
• Variables
• type Packet
  • func ParseClientSettings(b []byte) (Packet, error)
  • func ParseEncryptionResponse(b []byte) (Packet, error)
  • func ParseHandshake(b []byte) (Packet, error)
  • func ParseLoginStart(b []byte) (Packet, error)
• type PacketParser
• type ParseMap
• type State

Constants

const (
	Handshaking = iota
	Login
	Play
	Status
)

const (
	Version_1_14_4 = 498
)

Variables

var DefaultParseMap = ParseMap{
	Handshaking: {
		0x00: ParseHandshake,
	},
	Login: {
		0x00: ParseLoginStart,
		0x01: ParseEncryptionResponse,
	},
	Play: {
		0x05: ParseClientSettings,
	},
}

DefaultParseMap maps the state and packet id to the parser for each serverbound packet

var (
	ErrWrongPacketType = errors.New("received wrong packet type")
)

Types

type Packet

type Packet interface {
	// ID returns the Packet ID. Since some packets can be both serverbound and clientbound with different IDs
	// it needs a sBound boolean to know which ID to return. If true, returns the serverbound ID.
	ID(sBound bool) codec.VarInt
	// Decode fills the packet fields by reading from the reader r
	Decode(r io.Reader) error
	// Encode writes packet data to writer w
	Encode(w io.Writer) error
}

Packet describes a Minecraft packet.

func ParseClientSettings

func ParseClientSettings(b []byte) (Packet, error)

func ParseEncryptionResponse

func ParseEncryptionResponse(b []byte) (Packet, error)

func ParseHandshake

func ParseHandshake(b []byte) (Packet, error)

func ParseLoginStart

func ParseLoginStart(b []byte) (Packet, error)

type PacketParser

type PacketParser func([]byte) (Packet, error)

PacketParser is a function that takes in packet data and returns a specific type of packet based on the id, conforming to the Packet interface

type ParseMap

type ParseMap map[State]map[codec.VarInt]PacketParser

NOTE: might implement using reflection.

type State

type State int

State represents the various connection states