plugin

Documentation

Index

• Constants
• Variables
• func Channels(p *Message) (channels []string)
• func IsRegister(p *Message) bool
• func IsUnregister(p *Message) bool
• func LegacyRegister(p *Message) bool
• func LegacyUnregister(p *Message) bool
• func McBrand(p *Message) bool
• func ReadBrandMessage(data []byte) string
• func TransformLegacyToModernChannel(name string) string
• type Message
  • func ConstructChannelsPacket(protocol proto.Protocol, channels ...string) *Message
  • func RewriteMinecraftBrand(message *Message, protocol proto.Protocol) *Message
  • func (p *Message) Decode(c *proto.PacketContext, r io.Reader) (err error)
  • func (p *Message) Encode(c *proto.PacketContext, wr io.Writer) (err error)

Constants

const (
	BrandChannelLegacy      string = "MC|Brand"
	BrandChannel            string = "minecraft:brand"
	RegisterChannelLegacy   string = "REGISTER"
	RegisterChannel         string = "minecraft:register"
	UnregisterChannelLegacy string = "UNREGISTER"
	UnregisterChannel       string = "minecraft:unregister"
)

Variables

var InvalidIdentifierRegex = regexp.MustCompile(`[^a-z0-9\\-_]*`)

Functions

func Channels

func Channels(p *Message) (channels []string)

Channels fetches all the channels in a register or unregister plugin message.

func IsRegister

func IsRegister(p *Message) bool

IsRegister determines whether this plugin message is being used to register plugin channels.

func IsUnregister

func IsUnregister(p *Message) bool

IsUnregister determines whether this plugin message is being used to unregister plugin channels.

func LegacyRegister

func LegacyRegister(p *Message) bool

LegacyRegister determines whether this plugin message is a legacy (<1.13) registration plugin message.

func LegacyUnregister

func LegacyUnregister(p *Message) bool

LegacyUnregister determines whether this plugin message is a legacy (<1.13) un-registration plugin message.

func McBrand

func McBrand(p *Message) bool

McBrand determines whether this is a brand plugin message. This is shown on the client.

func ReadBrandMessage

func ReadBrandMessage(data []byte) string

ReadBrandMessage reads the brand message from the given packet data. The returned string will be empty if the data is invalid.

Some clients (mostly poorly-implemented bots) do not send validly-formed brand messages. In order to accommodate their broken behavior, we'll first try to read in the 1.8 format, and if that fails, treat it as a 1.7-format message (which has no prefixed length). (The message the proxy sends will be in the correct format depending on the protocol.)

func TransformLegacyToModernChannel

func TransformLegacyToModernChannel(name string) string

TransformLegacyToModernChannel transforms a plugin message channel from a "legacy" (<1.13) form to a modern one.

Types

type Message

type Message struct {
	Channel string
	Data    []byte
}

Message is a Minecraft plugin message packet.

func ConstructChannelsPacket

func ConstructChannelsPacket(protocol proto.Protocol, channels ...string) *Message

ConstructChannelsPacket constructs a channel (un)register packet. channels must not be empty! Note that the Message's Retained field remains nil.

func RewriteMinecraftBrand

func RewriteMinecraftBrand(message *Message, protocol proto.Protocol) *Message

RewriteMinecraftBrand rewrites the brand message to indicate the presence of the proxy.

func (*Message) Decode

func (p *Message) Decode(c *proto.PacketContext, r io.Reader) (err error)

func (*Message) Encode

func (p *Message) Encode(c *proto.PacketContext, wr io.Writer) (err error)