liter

package module

Go to main page

Versions in this module

v0

v0.3.3

Feb 7, 2024

v0.3.2

Feb 2, 2024

Changes in this version

type Chat

+ Bold OptBool

+ ClickEvent *ClickEvent

+ Color string

+ Font string

+ HoverEvent *HoverEvent

+ Insertion string

+ Italic OptBool

+ Keybind string

+ Obfuscated OptBool

+ Score *ScoreComponent

+ Strikethrough OptBool

+ Text string

+ Translate string

+ Underlined OptBool

+ With []*Chat

+ func (c *Chat) Type() ChatType

v0.3.1

Oct 24, 2023

v0.3.0

Oct 24, 2023

v0.2.7

Oct 22, 2023

v0.2.6

Oct 22, 2023

Changes in this version

type Conn

+ func (c *Conn) Compressed() bool

+ func (c *Conn) SetThreshold(threshold int)

+ func (c *Conn) Threshold() int

+ type LoginSetCompressionPkt struct

+ Threshold VarInt

+ func (p *LoginSetCompressionPkt) DecodeFrom(r *PacketReader) (err error)

+ func (p LoginSetCompressionPkt) Encode(b *PacketBuilder)

type PacketBuilder

+ func (p *PacketBuilder) WriteCompressedTo(w io.Writer, threshold int) (n int64, err error)

v0.2.5

Oct 18, 2023

Changes in this version

type Tag

+ Entries []VarInt

+ Name Identifier

v0.2.4

Oct 18, 2023

Changes in this version

+ type LoginAcknowledgedPkt struct

+ func (p *LoginAcknowledgedPkt) DecodeFrom(r *PacketReader) (err error)

+ func (p LoginAcknowledgedPkt) Encode(b *PacketBuilder)

+ func (p LoginAcknowledgedPkt) String() string

+ type LoginEncryptionRequestPkt struct

+ PublicKey *rsa.PublicKey

+ ServerID string

+ VerifyToken ByteArray

+ func (p *LoginEncryptionRequestPkt) DecodeFrom(r *PacketReader) (err error)

+ func (p LoginEncryptionRequestPkt) Encode(b *PacketBuilder)

+ type LoginEncryptionResponsePkt struct

+ SharedSecret ByteArray

+ VerifyToken ByteArray

+ func (p *LoginEncryptionResponsePkt) DecodeFrom(r *PacketReader) (err error)

+ func (p LoginEncryptionResponsePkt) Encode(b *PacketBuilder)

+ type LoginStartPkt struct

+ HasSign bool

+ Id Optional[UUID]

+ Name string

+ PublicKey ByteArray

+ Sign ByteArray

+ Timestamp Long

+ func (p *LoginStartPkt) DecodeFrom(r *PacketReader) (err error)

+ func (p LoginStartPkt) Encode(b *PacketBuilder)

+ func (p LoginStartPkt) String() string

+ type LoginSuccessPkt struct

+ Properties []*Property

+ UUID UUID

+ Username string

+ func (p *LoginSuccessPkt) DecodeFrom(r *PacketReader) (err error)

+ func (p *LoginSuccessPkt) Encode(b *PacketBuilder)

type Property

+ Sign string

+ func (p *Property) DecodeFrom(r *PacketReader) (err error)

+ func (p *Property) Encode(b *PacketBuilder)

v0.2.3

Oct 17, 2023

Changes in this version

type PlayerProfile

+ func (p *PlayerProfile) GetProp(name string) (t *Property)

+ func (p *PlayerProfile) GetSkin(cli *http.Client) (skin *Skin, err error)

type Property

+ func (p *Property) UnmarshalJSONValue(ptr any) (err error)

+ type Skin struct

+ Etag string

+ func (s *Skin) Head() image.Image

v0.2.2

Oct 13, 2023

v0.2.1

Oct 13, 2023

Changes in this version

+ var ErrPlayerNameInvalid = errors.New("Player name is invalid")

+ var ErrPlayerNotExists = errors.New("Player not exists on the server")

v0.2.0

Oct 3, 2023

Changes in this version

type AuthClient

+ func (cli *AuthClient) GetPlayerInfo(name string) (player PlayerInfo, err error)

+ func (cli *AuthClient) GetPlayerProfile(id UUID) (profile *PlayerProfile, err error)

+ type Chat struct

+ Extra []*Component

+ func NewChatFromString(s string) (c *Chat)

+ func (c *Chat) MarshalJSON() (buf []byte, err error)

+ func (c *Chat) Plain() string

+ func (c *Chat) UnmarshalJSON(buf []byte) (err error)

+ type ChatType int

+ const KeybindChat

+ const ScoreChat

+ const TextChat

+ const TranslateChat

+ type ClickAction string

+ const ChangePage

+ const CopyToClipboard

+ const OpenUrl

+ const RunCommand

+ const SuggestCommand

+ type ClickEvent struct

+ Action ClickAction

+ Value any

+ type Component struct

+ Bold OptBool

+ ClickEvent *ClickEvent

+ Color string

+ Font string

+ HoverEvent *HoverEvent

+ Insertion string

+ Italic OptBool

+ Keybind string

+ Obfuscated OptBool

+ Score *ScoreComponent

+ Strikethrough OptBool

+ Text string

+ Translate string

+ Underlined OptBool

+ With []*Component

+ func (c *Component) MarshalJSON() (buf []byte, err error)

+ func (c *Component) Plain() string

+ func (c *Component) Type() ChatType

+ func (c *Component) UnmarshalJSON(buf []byte) (err error)

+ type DisconnectPkt struct

+ Reason *Chat

+ func (p *DisconnectPkt) DecodeFrom(r *PacketReader) (err error)

+ func (p DisconnectPkt) Encode(b *PacketBuilder)

+ type HoverAction string

+ const ShowEntity

+ const ShowItem

+ const ShowText

+ type HoverEvent struct

+ Action HoverAction

+ Content any

+ type LoginStartPacket struct

+ HasSign bool

+ Id Optional[UUID]

+ Name string

+ PublicKey ByteArray

+ Sign ByteArray

+ Timestamp Long

+ func (p *LoginStartPacket) DecodeFrom(r *PacketReader) (err error)

+ func (p LoginStartPacket) Encode(b *PacketBuilder)

+ func (p LoginStartPacket) String() string

+ type OptBool int

+ const FALSE

+ const TRUE

+ func (b *OptBool) UnmarshalJSON(buf []byte) (err error)

+ func (b OptBool) Bool() bool

+ func (b OptBool) IsDefined() bool

+ func (b OptBool) MarshalJSON() (buf []byte, err error)

+ func (b OptBool) String() string

+ func (b OptBool) ToBool(def bool) bool

type PacketBuilder

+ func (p *PacketBuilder) Chat(v *Chat) *PacketBuilder

type PacketReader

+ func (p *PacketReader) Chat() (c *Chat, err error)

type PingResponsePkt

+ Payload int64

+ type PlayerInfo struct

+ Id UUID

+ Name string

+ type PlayerProfile struct

+ Id UUID

+ Name string

+ ProfileActions []string

+ Properties []Property

+ type PlayerStatus struct

+ Max int

+ Online int

+ Sample []PlayerInfo

+ type Property struct

+ Name string

+ Value any

+ type ProtocolVersion struct

+ Name string

+ Protocol int

+ type ScoreComponent struct

+ Name string

+ Objective string

+ Value int

+ type StatusResponsePayload struct

+ Description *Chat

+ Players PlayerStatus

+ Version ProtocolVersion

v0.1.5

Oct 2, 2023

v0.1.4

Oct 2, 2023

Changes in this version

+ var ErrNoRecordFound = errors.New("No DNS record was found")

v0.1.3

Oct 2, 2023

v0.1.2

Oct 1, 2023

v0.1.1

Oct 1, 2023

Changes in this version

+ var ErrOldHandshake = errors.New("Old client(<=1.6) handshake received")

v0.1.0

Oct 1, 2023

Changes in this version

+ const DefaultApiServer

+ const DefaultAuthServer

+ const DefaultPort

+ const DefaultSessionServer

+ const NextLoginState

+ const NextPingState

+ const V1_10_2

+ const V1_11

+ const V1_11_2

+ const V1_12

+ const V1_12_1

+ const V1_12_2

+ const V1_13_2

+ const V1_14_4

+ const V1_15_2

+ const V1_16_3

+ const V1_16_5

+ const V1_17

+ const V1_17_1

+ const V1_18_1

+ const V1_18_2

+ const V1_19

+ const V1_19_2

+ const V1_19_3

+ const V1_19_4

+ const V1_20

+ const V1_7_5

+ const V1_8_9

+ const V1_9_4

+ const V_HIGHEST

+ const V_LOWEST

+ const V_UNSET

+ var DefaultAuthClient = &AuthClient

+ var ErrParserIdNotExists = errors.New("liter.CommandNode: parser id is not exists")

+ var ErrParserInstanceNotExists = errors.New("liter.CommandNode: command parser instance not exists")

+ var PlayerNotExistsErr = errors.New("Player not exists on the server")

+ var VarIntTooBig = errors.New("VarInt is too big")

+ var VarLongTooBig = errors.New("VarLong is too big")

+ func GetProtocolName(p int) string

+ func IsProtocolSupport(p int) bool

+ func RegisterCmdEncoder(p CmdPropEncoder) (ok bool)

+ func ResloveAddr(target string) (addr *net.TCPAddr, err error)

+ func ResloveAddrWithContext(ctx context.Context, target string) (addr *net.TCPAddr, err error)

+ func ToNearestProtocol(p int) int

+ func UnregisterCmdEncoder(p CmdPropEncoder) (ok bool)

+ type AccessData struct

+ AccessToken string

+ ClientToken string

+ type Angle = UByte

+ type AuthClient struct

+ ApiServer string

+ AuthServer string

+ Client *http.Client

+ SessionServer string

+ func (cli *AuthClient) Auth(data AuthData) (res *AuthResponse, err error)

+ func (cli *AuthClient) GetPlayerUUID(name string) (_ string, _ uuid.UUID, err error)

+ func (cli *AuthClient) Invalidate(data AccessData) (err error)

+ func (cli *AuthClient) Refresh(data AccessData) (res *RefreshResponse, err error)

+ func (cli *AuthClient) Signout(data LoginData) (err error)

+ func (cli *AuthClient) Validate(data AccessData) (err error)

+ type AuthData struct

+ ClientToken string

+ type AuthResponse struct

+ AccessToken string

+ AvailableProfiles []Profile

+ ClientToken string

+ SelectedProfile Profile

+ User UserData

+ type BitSet []uint64

+ func NewBitSet() (s *BitSet)

+ func NewBitSetWith(size int) (s *BitSet)

+ func (s *BitSet) Clear()

+ func (s *BitSet) Close(index int)

+ func (s *BitSet) DecodeFrom(r *PacketReader) (err error)

+ func (s *BitSet) Get(index int) (value bool)

+ func (s *BitSet) Open(index int)

+ func (s *BitSet) Set(index int, value bool)

+ func (s BitSet) Encode(p *PacketBuilder)

+ type Bool = bool

+ type Byte = int8

+ const NumPropMax

+ const NumPropMin

+ type ByteArray = []byte

+ type ChunkSection struct

+ Biomes PalettedContainer

+ BlockCount Short

+ BlockStates PalettedContainer

+ func (c *ChunkSection) DecodeFrom(r *PacketReader) (err error)

+ func (c *ChunkSection) Encode(b *PacketBuilder)

+ type CmdFlag Byte

+ const CmdExec

+ const CmdRedirect

+ const CmdSuggest

+ const CmdTypeArg

+ const CmdTypeLiteral

+ const CmdTypeMask

+ const CmdTypeRoot

+ type CmdPropEncoder interface

+ Decode func(r *PacketReader) (value any, err error)

+ Encode func(b *PacketBuilder, value any) (err error)

+ Id func() VarInt

+ String func() String

+ type CommandNode struct

+ Children []VarInt

+ Flags CmdFlag

+ Name Optional[String]

+ ParserId Optional[VarInt]

+ ParserStrId Optional[String]

+ Properties any

+ RedirectNode Optional[VarInt]

+ SuggestionsType Optional[String]

+ func (c *CommandNode) DecodeFrom(r *PacketReader) (err error)

+ func (c *CommandNode) Encode(b *PacketBuilder)

+ func (c *CommandNode) GetParser() (CmdPropEncoder, error)

+ func (c *CommandNode) GetParserId() (VarInt, error)

+ func (c *CommandNode) GetParserStrId() (String, error)

+ func (c *CommandNode) HasFlag(f CmdFlag) bool

+ func (c *CommandNode) Type() CmdFlag

+ func (c *CommandNode) Vaild() bool

+ type Conn struct

+ func Dial(target string) (c *Conn, err error)

+ func DialWithContext(ctx context.Context, target string) (c *Conn, err error)

+ func WrapConn(c net.Conn) *Conn

+ func (c *Conn) Close() (err error)

+ func (c *Conn) LocalAddr() net.Addr

+ func (c *Conn) Protocol() int

+ func (c *Conn) RawConn() net.Conn

+ func (c *Conn) Recv() (r *PacketReader, err error)

+ func (c *Conn) RecvHandshakePkt() (pkt *HandshakePkt, err error)

+ func (c *Conn) RecvPkt(id int32, pkt Decodable) (err error)

+ func (c *Conn) RemoteAddr() net.Addr

+ func (c *Conn) Send(p *PacketBuilder) (err error)

+ func (c *Conn) SendHandshakePkt(pkt *HandshakePkt) (err error)

+ func (c *Conn) SendPkt(id int32, values ...any) (err error)

+ type Context struct

+ func NewContext(conn *Conn) *Context

+ type Decodable interface

+ DecodeFrom func(r *PacketReader) (err error)

+ type DirectPalette struct

+ type Double = float64

+ type EmptyCmdPropEncoder struct

+ func NewEmptyCmdPropEncoder(id VarInt, sid string) *EmptyCmdPropEncoder

+ func (p *EmptyCmdPropEncoder) Decode(r *PacketReader) (value any, err error)

+ func (p *EmptyCmdPropEncoder) Encode(b *PacketBuilder, value any) (err error)

+ func (p *EmptyCmdPropEncoder) Id() VarInt

+ func (p *EmptyCmdPropEncoder) String() String

+ type Encodable interface

+ Encode func(p *PacketBuilder)

+ type Float = float32

+ type HandshakePkt struct

+ Addition string

+ Addr string

+ NextState VarInt

+ Port uint16

+ Protocol int

+ func (p *HandshakePkt) Decode(r *PacketReader) (err error)

+ func (p HandshakePkt) EncodeTo(b *PacketBuilder)

+ func (p HandshakePkt) String() string

+ type HttpStatusError struct

+ Code int

+ func (e *HttpStatusError) Error() string

+ type Identifier = String

+ type IndirectPalette struct

+ Palette []VarInt

+ type Int = int32

+ type LoginData struct

+ Password string

+ Username string

+ type Long = int64

+ type NumRangeProp struct

+ func (p *NumRangeProp[T]) Clear()

+ func (p *NumRangeProp[T]) HasMax() bool

+ func (p *NumRangeProp[T]) HasMin() bool

+ func (p *NumRangeProp[T]) InRange(v T) bool

+ func (p *NumRangeProp[T]) Max() T

+ func (p *NumRangeProp[T]) Min() T

+ func (p *NumRangeProp[T]) SetMax(max T) *NumRangeProp[T]

+ func (p *NumRangeProp[T]) SetMin(min T) *NumRangeProp[T]

+ type Object = map[string]any

+ type Optional struct

+ Ok bool

+ V T

+ func (o *Optional[T]) Set(v T)

+ func (o Optional[T]) Assert() (v T)

+ func (o Optional[T]) Encode(b *PacketBuilder)

+ type Packet interface

+ type PacketBuilder struct

+ func NewPacket(protocol int, id VarInt) (p *PacketBuilder)

+ func (p *PacketBuilder) Bool(v bool) *PacketBuilder

+ func (p *PacketBuilder) Byte(v Byte) *PacketBuilder

+ func (p *PacketBuilder) ByteArray(buf []byte) *PacketBuilder

+ func (p *PacketBuilder) Bytes() (buf []byte)

+ func (p *PacketBuilder) Data() []byte

+ func (p *PacketBuilder) Double(v Double) *PacketBuilder

+ func (p *PacketBuilder) Encode(v any)

+ func (p *PacketBuilder) Float(v Float) *PacketBuilder

+ func (p *PacketBuilder) Id() VarInt

+ func (p *PacketBuilder) Int(v Int) *PacketBuilder

+ func (p *PacketBuilder) JSON(v any) *PacketBuilder

+ func (p *PacketBuilder) Len() int

+ func (p *PacketBuilder) Long(v Long) *PacketBuilder

+ func (p *PacketBuilder) Protocol() int

+ func (p *PacketBuilder) Reset(protocol int, id VarInt) *PacketBuilder

+ func (p *PacketBuilder) Short(v Short) *PacketBuilder

+ func (p *PacketBuilder) String(v String) *PacketBuilder

+ func (p *PacketBuilder) UByte(v UByte) *PacketBuilder

+ func (p *PacketBuilder) UShort(v UShort) *PacketBuilder

+ func (p *PacketBuilder) UUID(v UUID) *PacketBuilder

+ func (p *PacketBuilder) VarInt(v VarInt) *PacketBuilder

+ func (p *PacketBuilder) VarLong(v VarLong) *PacketBuilder

+ func (p *PacketBuilder) WriteTo(w io.Writer) (n int64, err error)

+ type PacketReader struct

+ func ReadPacket(protocol int, r io.Reader) (p *PacketReader, err error)

+ func ReadPacketFromBytes(protocol int, buf []byte) (p *PacketReader)

+ func (p *PacketReader) Bool() (v bool, ok bool)

+ func (p *PacketReader) Byte() (v Byte, ok bool)

+ func (p *PacketReader) ByteArray(buf []byte) (ok bool)

+ func (p *PacketReader) Bytes() []byte

+ func (p *PacketReader) Double() (v Double, ok bool)

+ func (p *PacketReader) Float() (v Float, ok bool)

+ func (p *PacketReader) Id() VarInt

+ func (p *PacketReader) Int() (v Int, ok bool)

+ func (p *PacketReader) JSON(ptr any) (err error)

+ func (p *PacketReader) Long() (v Long, ok bool)

+ func (p *PacketReader) Offset() int

+ func (p *PacketReader) Protocol() int

+ func (p *PacketReader) ReadAll() (buf []byte)

+ func (p *PacketReader) Remain() int

+ func (p *PacketReader) Short() (v Short, ok bool)

+ func (p *PacketReader) String() (v String, ok bool)

+ func (p *PacketReader) UByte() (v UByte, ok bool)

+ func (p *PacketReader) UShort() (v UShort, ok bool)

+ func (p *PacketReader) UUID() (v UUID, ok bool)

+ func (p *PacketReader) Uint16() (v uint16, ok bool)

+ func (p *PacketReader) Uint32() (v uint32, ok bool)

+ func (p *PacketReader) Uint64() (v uint64, ok bool)

+ func (p *PacketReader) Uint8() (v uint8, ok bool)

+ func (p *PacketReader) VarInt() (v VarInt, ok bool)

+ func (p *PacketReader) VarLong() (v VarLong, ok bool)

+ type PalettedContainer struct

+ BitsPerEntry UByte

+ DataArray []Long

+ Palette any

+ func (c *PalettedContainer) DecodeFrom(r *PacketReader) (err error)

+ func (c PalettedContainer) Encode(b *PacketBuilder)

+ type PingRequestPkt struct

+ Payload int64

+ func (p *PingRequestPkt) DecodeFrom(r *PacketReader) (err error)

+ func (p PingRequestPkt) Encode(b *PacketBuilder)

+ func (p PingRequestPkt) String() string

+ type PingResponsePkt PingRequestPkt

+ func (p *PingResponsePkt) DecodeFrom(r *PacketReader) (err error)

+ func (p PingResponsePkt) Encode(b *PacketBuilder)

+ func (p PingResponsePkt) String() string

+ type PktIdAssertError struct

+ Got int32

+ Require int32

+ func (e *PktIdAssertError) Error() string

+ type Position struct

+ X int

+ Y int

+ Z int

+ func PositionFromLong(n Long) (p Position)

+ func (p *Position) DecodeFrom(r *PacketReader) (err error)

+ func (p Position) AsLong() (n Long)

+ func (p Position) Encode(b *PacketBuilder)

+ type Profile struct

+ Id uuid.UUID

+ Name string

+ type Prop struct

+ Key string

+ Value string

+ type Props []Prop

+ type RefreshResponse struct

+ AccessToken string

+ ClientToken string

+ SelectedProfile Profile

+ User UserData

+ type Short = int16

+ type SingleValuedPalette struct

+ Value VarInt

+ type StatusRequestPkt struct

+ func (p *StatusRequestPkt) DecodeFrom(r *PacketReader) (err error)

+ func (p StatusRequestPkt) Encode(b *PacketBuilder)

+ func (p StatusRequestPkt) String() string

+ type StatusResponsePkt struct

+ Payload Object

+ func (p *StatusResponsePkt) DecodeFrom(r *PacketReader) (err error)

+ func (p StatusResponsePkt) Encode(b *PacketBuilder)

+ func (p StatusResponsePkt) String() string

+ type String = string

+ type Tag struct

+ func (c *Tag) DecodeFrom(r *PacketReader) (err error)

+ func (c Tag) Encode(b *PacketBuilder)

+ type UByte = uint8

+ type UShort = uint16

+ type UUID = uuid.UUID

+ type UserData struct

+ Id string

+ Properties Props

+ Username string

+ type VarInt int32

+ type VarLong int64

+ type YggError struct

+ Cause string

+ Code int

+ ErrorMessage string

+ ErrorShort string

+ func (e *YggError) Error() (s string)

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