valheim

Documentation

Index

• type Client
  • func NewClient(address string) Client
  • func (c Client) CountPlayers(ctx context.Context) (int, error)
  • func (c Client) Info() (*a2s.ServerInfo, error)
  • func (c Client) Players(ctx context.Context) (int, []string, error)
  • func (c Client) Setup() (Client, error)

Types

type Client

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

Client for talking to Valheim servers

func NewClient

func NewClient(address string) Client

New client for the provided address

func (Client) CountPlayers

func (c Client) CountPlayers(ctx context.Context) (int, error)

CountPlayers on the Server right now

func (Client) Info

func (c Client) Info() (*a2s.ServerInfo, error)

Info returns an a2s ServerInfo response

func (Client) Players

func (c Client) Players(ctx context.Context) (int, []string, error)

Players on the server right now NOTE: Valheim currently does not provide the player names, so the list of players is left empty

func (Client) Setup

func (c Client) Setup() (Client, error)

Setup establishes the initial connection and authenticates the session