minecraft

package

v1.0.0 Latest Latest Go to latest Published: Jun 16, 2026 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/crystade/greet

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Minecraft
type MinecraftConfig
type MinecraftResult

Constants ¶

View Source

const (
	ErrMinecraftHandshakeTimeout  greet.ErrorCode = "handshake_timeout"
	ErrMinecraftHandshakeFailed   greet.ErrorCode = "handshake_failed"
	ErrMinecraftMalformedResponse greet.ErrorCode = "malformed_response"
)

View Source

const (
	VarIntSegmentBits = 0x7F
	VarIntContinueBit = 0x80
)

VarInt encoding constants.

View Source

const DefaultMinecraftPort = 25565

DefaultMinecraftPort is the well-known port for Minecraft Java Edition.

View Source

const HandshakePacketID = 0x00

Handshake packet ID is always 0x00.

View Source

const NextStateStatus = 1

NextStateStatus is the next-state value for status queries.

View Source

const ProtocolName = "minecraft"

ProtocolName is the registered name for the Minecraft protocol.

View Source

const StatusRequestPacketID = 0x00

StatusRequestPacketID is always 0x00 (empty payload).

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Minecraft ¶

type Minecraft struct{}

Minecraft implements a Minecraft Java Edition status probe. It is stateless — all configuration is passed via GreetOption.

func (*Minecraft) DefaultPort ¶

func (m *Minecraft) DefaultPort() int

func (*Minecraft) Description ¶

func (m *Minecraft) Description() string

func (*Minecraft) Greet ¶

func (m *Minecraft) Greet(ctx context.Context, host string, port int, opts ...greet.GreetOption) (*greet.GreetResult, error)

func (*Minecraft) Name ¶

func (m *Minecraft) Name() string

func (*Minecraft) ParseFlags ¶

func (m *Minecraft) ParseFlags(fs *flag.FlagSet) ([]greet.GreetOption, error)

func (*Minecraft) RegisterFlags ¶

func (m *Minecraft) RegisterFlags(fs *flag.FlagSet)

func (*Minecraft) Transport ¶

func (m *Minecraft) Transport() greet.Transport

type MinecraftConfig ¶

type MinecraftConfig struct {
	ProtocolVersion int // e.g. 775 for 26.1
}

MinecraftConfig holds protocol-specific configuration for Minecraft.

type MinecraftResult ¶

type MinecraftResult struct {
	Version    string
	MOTD       string
	Players    int
	MaxPlayers int
}

MinecraftResult holds the outcome of a Minecraft status query.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL