mcstatus

package module

Go to main page

Versions in this module

v1

v1.3.3

Nov 24, 2021

v1.3.2

Nov 23, 2021

v1.3.1

Nov 23, 2021

Changes in this version

+ type ColorName string

+ const ColorNameAqua

+ const ColorNameBlack

+ const ColorNameBlue

+ const ColorNameDarkAqua

+ const ColorNameDarkBlue

+ const ColorNameDarkGray

+ const ColorNameDarkGreen

+ const ColorNameDarkPurple

+ const ColorNameDarkRed

+ const ColorNameGold

+ const ColorNameGray

+ const ColorNameGreen

+ const ColorNameLightPurple

+ const ColorNameMinecoinGold

+ const ColorNameRed

+ const ColorNameWhite

+ const ColorNameYellow

type Description

+ Tree []FormatItem

+ func NewDescription(desc interface{}) (*Description, error)

+ type FormatItem struct

+ Bold bool

+ Color ColorName

+ Italic bool

+ Obfuscated bool

+ Strikethrough bool

+ Text string

+ Underline bool

v1.3.0

Nov 22, 2021

Changes in this version

+ var ErrUnknownVersion = errors.New("unsupported server Votifier version")

+ func SendVote(host string, port uint16, options VoteOptions) error

type Packet

+ func (p *Packet) ReadFloat32() (float32, error)

+ func (p *Packet) ReadFloat64() (float64, error)

+ func (p *Packet) ReadInt16BE() (int16, error)

+ func (p *Packet) ReadInt16LE() (int16, error)

+ func (p *Packet) ReadInt32BE() (int32, error)

+ func (p *Packet) ReadInt32LE() (int32, error)

+ func (p *Packet) ReadInt64BE() (int64, error)

+ func (p *Packet) ReadInt64LE() (int64, error)

+ func (p *Packet) ReadUInt16BE() (uint16, error)

+ func (p *Packet) ReadUInt16LE() (uint16, error)

+ func (p *Packet) ReadUInt32BE() (uint32, error)

+ func (p *Packet) ReadUInt32LE() (uint32, error)

+ func (p *Packet) ReadUInt64BE() (uint64, error)

+ func (p *Packet) ReadUInt64LE() (uint64, error)

+ func (p *Packet) ReadUInt8() (uint8, error)

+ func (p *Packet) WriteFloat32(val float32) error

+ func (p *Packet) WriteFloat64(val float64) error

+ func (p *Packet) WriteInt16BE(val int16) error

+ func (p *Packet) WriteInt16LE(val int16) error

+ func (p *Packet) WriteInt32BE(val int32) error

+ func (p *Packet) WriteInt32LE(val int32) error

+ func (p *Packet) WriteInt64BE(val int64) error

+ func (p *Packet) WriteInt64LE(val int64) error

+ func (p *Packet) WriteUInt16BE(val uint16) error

+ func (p *Packet) WriteUInt16LE(val uint16) error

+ func (p *Packet) WriteUInt32BE(val uint32) error

+ func (p *Packet) WriteUInt32LE(val uint32) error

+ func (p *Packet) WriteUInt64LE(val uint64) error

+ func (p *Packet) WriteUInt8(val uint8) error

+ func (p *Packet) WriteUint64BE(val uint64) error

+ type VoteOptions struct

+ ServiceName string

+ Timeout time.Duration

+ Timestamp time.Time

+ Token string

+ UUID string

+ Username string

v1.2.0

Nov 22, 2021

Changes in this version

+ type BedrockStatusOptions struct

+ ClientGUID int64

+ EnableSRV bool

+ Timeout time.Duration

+ type BedrockStatusResponse struct

+ Edition string

+ Gamemode string

+ GamemodeID int64

+ MOTDLine1 Description

+ MOTDLine2 Description

+ MaxPlayers int64

+ OnlinePlayers int64

+ PortIPv4 uint16

+ PortIPv6 uint16

+ ProtocolVersion int64

+ SRVResult *SRVRecord

+ ServerGUID int64

+ ServerID uint64

+ Version string

+ func StatusBedrock(host string, port uint16, options ...BedrockStatusOptions) (*BedrockStatusResponse, error)

type Description

+ func (d Description) Clean() string

+ type JavaStatusOptions struct

+ EnableSRV bool

+ ProtocolVersion int

+ Timeout time.Duration

v1.1.0

Nov 21, 2021

v1.0.0

Nov 21, 2021

Changes in this version

+ var ErrAlreadyLoggedIn = errors.New("RCON client is already logged in after a second login attempt was made")

+ var ErrEmptyBuffer = errors.New("packet does not contain enough data to read this type")

+ var ErrInvalidBoolean = errors.New("cannot ReadBoolean() as value is neither 0 or 1")

+ var ErrInvalidPassword = errors.New("incorrect RCON password")

+ var ErrNotConnected = errors.New("client attempted to send data but connection is non-existent")

+ var ErrNotLoggedIn = errors.New("RCON client attempted to send message before successful login")

+ var ErrUnexpectedResponse = errors.New("received an unexpected response from the server")

+ var ErrVarIntTooBig = errors.New("size of VarInt exceeds maximum data size")

+ type BasicQueryResponse struct

+ GameType string

+ HostIP string

+ HostPort uint16

+ MOTD Description

+ Map string

+ MaxPlayers uint64

+ OnlinePlayers uint64

+ func BasicQuery(host string, port uint16, options ...QueryOptions) (*BasicQueryResponse, error)

+ type Description struct

+ func (d Description) HTML() (string, error)

+ func (d Description) Raw() string

+ func (d Description) String() string

+ type Favicon struct

+ func (f Favicon) Exists() bool

+ func (f Favicon) Image() (image.Image, error)

+ func (f Favicon) SaveToFile(path string) error

+ func (f Favicon) String() string

+ type FullQueryResponse struct

+ Data map[string]string

+ Players []string

+ func FullQuery(host string, port uint16, options ...QueryOptions) (*FullQueryResponse, error)

+ type JavaStatusResponse struct

+ Description Description

+ Favicon Favicon

+ Players struct{ ... }

+ SRVResult *SRVRecord

+ Version struct{ ... }

+ func Status(host string, port uint16, options ...StatusOptions) (*JavaStatusResponse, error)

+ type Packet struct

+ func NewPacket() *Packet

+ func NewPacketFromReader(r io.Reader) *Packet

+ func (p *Packet) ReadAllBytes() ([]byte, error)

+ func (p *Packet) ReadBoolean() (bool, error)

+ func (p *Packet) ReadByte() (byte, error)

+ func (p *Packet) ReadBytes(length int) ([]byte, error)

+ func (p *Packet) ReadDouble() (float64, error)

+ func (p *Packet) ReadFloat() (float32, error)

+ func (p *Packet) ReadInt() (int32, error)

+ func (p *Packet) ReadIntLE() (int32, error)

+ func (p *Packet) ReadLong() (int64, error)

+ func (p *Packet) ReadLongLE() (int64, error)

+ func (p *Packet) ReadShort() (int16, error)

+ func (p *Packet) ReadShortLE() (int16, error)

+ func (p *Packet) ReadString() (string, error)

+ func (p *Packet) ReadUnsignedByte() (uint8, error)

+ func (p *Packet) ReadUnsignedInt() (uint32, error)

+ func (p *Packet) ReadUnsignedIntLE() (uint32, error)

+ func (p *Packet) ReadUnsignedLong() (uint64, error)

+ func (p *Packet) ReadUnsignedLongLE() (uint64, error)

+ func (p *Packet) ReadUnsignedShort() (uint16, error)

+ func (p *Packet) ReadUnsignedShortLE() (uint16, error)

+ func (p *Packet) ReadVarInt() (int32, error)

+ func (p *Packet) ReadVarLong() (int64, error)

+ func (p *Packet) WriteBoolean(val bool) error

+ func (p *Packet) WriteByte(val byte) error

+ func (p *Packet) WriteBytes(val []byte) error

+ func (p *Packet) WriteDouble(val float64) error

+ func (p *Packet) WriteFloat(val float32) error

+ func (p *Packet) WriteInt(val int32) error

+ func (p *Packet) WriteIntLE(val int32) error

+ func (p *Packet) WriteLength() error

+ func (p *Packet) WriteLong(val int64) error

+ func (p *Packet) WriteLongLE(val int64) error

+ func (p *Packet) WriteShort(val int16) error

+ func (p *Packet) WriteShortLE(val int16) error

+ func (p *Packet) WriteString(val string) error

+ func (p *Packet) WriteTo(w io.Writer) (int64, error)

+ func (p *Packet) WriteUnsignedByte(val uint8) error

+ func (p *Packet) WriteUnsignedInt(val uint32) error

+ func (p *Packet) WriteUnsignedIntLE(val uint32) error

+ func (p *Packet) WriteUnsignedLong(val uint64) error

+ func (p *Packet) WriteUnsignedLongLE(val uint64) error

+ func (p *Packet) WriteUnsignedShort(val uint16) error

+ func (p *Packet) WriteUnsignedShortLE(val uint16) error

+ func (p *Packet) WriteVarInt(val int32) error

+ func (p *Packet) WriteVarLong(val int64) error

+ type QueryOptions struct

+ SessionID int32

+ Timeout time.Duration

+ type RCON struct

+ Conn *net.Conn

+ Messages chan string

+ func NewRCON() *RCON

+ func (r *RCON) Close() error

+ func (r *RCON) Dial(host string, port uint16, options ...RCONOptions) error

+ func (r *RCON) Login(password string) error

+ func (r *RCON) Run(command string) error

+ type RCONOptions struct

+ Timeout time.Duration

+ type SRVRecord struct

+ Host string

+ Port uint16

+ type StatusOptions struct

+ EnableSRV bool

+ ProtocolVersion int

+ Timeout time.Duration

Other modules containing this package

github.com/PassTheMayo/mcstatus/v2

github.com/PassTheMayo/mcstatus/v3

github.com/PassTheMayo/mcstatus/v4

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