discovery

type Header struct {
	// PacketID is the ID of the packet.
	PacketID uint16
	// SenderID is the ID of the network that sent the packet.
	SenderID uint64
}

type ListenConfig struct {
	// NetworkID specifies the network ID for the NetherNet network being announced to the clients in the
	// same network. In NetherNet, it is explicitly defined as a string, but in LAN discovery it is sent as an uint8.
	NetworkID uint64

	// BroadcastAddress specifies the UDP broadcast address for sending request packets to the servers in
	// the same network. If nil, an *net.UDPAddr with net.IPv4bcast and port 7551 will be used.
	BroadcastAddress *net.UDPAddr

	// Log is used for logging messages at various levels.
	Log *slog.Logger
}

type Listener struct {
	// contains filtered or unexported fields
}

type MessagePacket struct {
	// RecipientID is the network ID to be signaled by MessagePacket. Note that this is
	// not the connection ID. The connection ID is included in the Data field and used only
	// during a single negotiation, whereas the network ID may be used across multiple connections.
	RecipientID uint64
	// Data is the actual data for signaling. It contains the string form of nethernet.Signal.
	Data string
}

type Packet interface {
	// ID uniquely returns the ID of the packet. It is one of the first byte
	// in the Header and used to identify which packet to decode in [Unmarshal].
	ID() uint16

	// Read reads/decodes the packet data from the [io.Reader].
	Read(r io.Reader) error
	// Write writes the packet data into the [io.Writer].
	Write(w io.Writer)
}

type RequestPacket struct{}

type ResponsePacket struct {
	// ApplicationData contains application-specific data for the packet. In Minecraft: Bedrock Edition, it is
	// typically structured as ServerData.
	ApplicationData []byte
}

type ServerData struct {
	// ServerName is the name of the server. It is typically the player name of the owner
	// hosting the server and is displayed below the LevelName in the world card.
	ServerName string
	// LevelName identifies the name of the world and appears at the top of ServerName in the world card.
	LevelName string
	// GameType is the default game mode of the world. Players receive this game mode when they
	// join. It remains unchanged during gameplay and may be updated the next time the world is hosted.
	GameType uint8
	// PlayerCount is the amount of players currently connected to the world. Worlds
	// with a player count of 0 or less are not displayed by clients, so it should at
	// least 1 even if the server reports 0 to prevent world cards not appearing for the server.
	PlayerCount int32
	// MaxPlayerCount is the maximum amount of players allowed to join the world.
	MaxPlayerCount int32
	// EditorWorld is a value dictates if the world was created as a project in Editor Mode.
	// When enabled, the server or world card is only visible to clients in Editor Mode.
	EditorWorld bool
	// Hardcore indicates that the world is in hardcore mode. When enabled, it is common to also set
	// GameType to Survival (0) as well to reproduce expected behavior.
	Hardcore bool
	// TransportLayer indicates the transport layer used by the server. In vanilla, this is typically
	// 2 for NetherNet. Other values are also supported but are currently not useful in LAN discovery
	// as it only allows connections over NetherNet. Therefore, the purposes or usage of this field is
	// currently unknown.
	TransportLayer uint8
	// ConnectionType indicates the connection type used alongside the transport layer.
	// In vanilla, this is typically 4 for using LAN as a signaling for NetherNet.
	// Other values are supported but are currently not useful in LAN discovery.
	ConnectionType uint8
}