vrage

Aug 9, 2026

Changes in this version

type APIAdmin

+ func (a *APIAdmin) KickPlayer(steamID uint64) (APIResponseWithoutData, error)

+ func (a *APIAdmin) KickedPlayers() (APIResponseWithData[APIAdminKickedPlayersData], error)

+ func (a *APIAdmin) UnkickPlayer(steamID uint64) (APIResponseWithoutData, error)

+ type APIAdminBannedPlayer struct

+ DisplayName string

+ SteamID uint64

+ type APIAdminKickedPlayer struct

+ DisplayName string

+ SteamID uint64

+ Time int64

+ func (p APIAdminKickedPlayer) CanJoin() bool

+ type APIAdminKickedPlayersData struct

+ KickedPlayers []APIAdminKickedPlayer

type HTTPClient

+ func (c *HTTPClient) DeleteV1AdminKickedPlayersSteamID(steamID uint64) (*http.Response, error)

+ func (c *HTTPClient) GetV1AdminKickedPlayers() (*http.Response, error)

+ func (c *HTTPClient) PostV1AdminKickedPlayersSteamID(steamID uint64) (*http.Response, error)

Aug 9, 2026

Changes in this version

type APIAdmin

+ func (a *APIAdmin) BanPlayer(steamID uint64) (APIResponseWithoutData, error)

+ func (a *APIAdmin) BannedPlayers() (APIResponseWithData[APIAdminBannedPlayersData], error)

+ func (a *APIAdmin) UnbanPlayer(steamID uint64) (APIResponseWithoutData, error)

+ type APIAdminBannedPlayersData struct

+ BannedPlayers []struct{ ... }

type HTTPClient

+ func (c *HTTPClient) DeleteV1AdminBannedPlayersSteamID(steamID uint64) (*http.Response, error)

+ func (c *HTTPClient) GetV1AdminBannedPlayers() (*http.Response, error)

+ func (c *HTTPClient) PostV1AdminBannedPlayersSteamID(steamID uint64) (*http.Response, error)

Aug 9, 2026

Changes in this version

type APIAdmin

+ func (a *APIAdmin) DemotePlayer(steamID string) (APIResponseWithoutData, error)

+ func (a *APIAdmin) PromotePlayer(steamID string) (APIResponseWithoutData, error)

+ type APIMeta struct

+ APIVersion string

+ QueryTime float64

+ type APIResponseWithData struct

+ Data T

+ Meta APIMeta

+ type APIResponseWithoutData struct

+ Meta APIMeta

type HTTPClient

+ func (c *HTTPClient) DeleteV1AdminPromotedPlayersSteamID(steamID string) (*http.Response, error)

+ func (c *HTTPClient) PostV1AdminPromotedPlayersSteamID(steamID string) (*http.Response, error)

Aug 5, 2026

Changes in this version

+ var ErrAPIUnexpectedBody = errors.New("unexpected response body from the server")

+ var ErrAPIUnexpectedCode = errors.New("unexpected status code from the server")

type HTTPClient

+ func (c *HTTPClient) DoErr(method httpMethod, endpoint string, jsonPayload jsonMap, headers httpHeaders) (*http.Response, error)

Aug 5, 2026

Changes in this version

+ var ErrAPIUnexpectedResponse = errors.New("unexpected response from the server")

+ func IsResponseSuccessful(resp *http.Response) bool

type APIServer

+ func (s *APIServer) Stop() error

Aug 3, 2026

Changes in this version

type APIServer

+ func (s *APIServer) Ping() (BaseResponse[APIServerPingData], error)

+ func (s *APIServer) Status() (BaseResponse[APIServerStatusData], error)

+ type APIServerPingData struct

+ Result string

type APIServerStatusData

+ ServerID int64

+ SimulationCPULoad float64

type HTTPClient

+ func (c *HTTPClient) DeleteV1Server() (*http.Response, error)

+ func (c *HTTPClient) GetV1ServerPing() (*http.Response, error)

+ func (c *HTTPClient) GetV1ServerStatus() (*http.Response, error)

Aug 2, 2026

Changes in this version

+ type APIAdmin struct

+ type APIServer struct

+ func (s *APIServer) PingV1() (BaseResponse[APIServerPingV1Data], error)

+ func (s *APIServer) StatusV1() (BaseResponse[APIServerStatusData], error)

+ type APISession struct

+ type HTTPClient struct

+ func (c *HTTPClient) Do(method httpMethod, endpoint string, jsonPayload jsonMap, headers httpHeaders) (*http.Response, error)

+ func (c *HTTPClient) V1ServerPing() (*http.Response, error)

+ func (c *HTTPClient) V1ServerStatus() (*http.Response, error)

Aug 2, 2026

Changes in this version

+ const DefaultBaseEndpoint

+ var ErrAPIConnectionFailed = errors.New(...)

+ var ErrAPIInvalidSecurityKey = errors.New("server returned StatusForbidden: security key is invalid or missing")

+ var ErrAPIRequestTimeout = errors.New("request timed out: the server did not respond in time")

+ var ErrConfigIncompatible = errors.New("invalid config: conflicting settings")

+ var ErrConfigIncomplete = errors.New("invalid config: missing required fields")

+ var ErrConfigInvalid = errors.New("invalid config: field validation failed")

+ type APIServerPingV1Data struct

+ Result string

+ type APIServerStatusData struct

+ Game string

+ IsReady bool

+ PirateUsedPCU int

+ Players int

+ ServerId int64

+ ServerName string

+ SimSpeed float64

+ SimulationCpuLoad float64

+ TotalTime int

+ UsedPCU int

+ Version string

+ WorldName string

+ type ApiServerStatusResponse = BaseResponse[APIServerStatusData]

+ type BaseResponse struct

+ Data T

+ Meta Meta

type Client

+ Admin apiAdmin

+ HTTP httpClient

+ Server apiServer

+ Session apiSession

type ClientConfig

+ BaseEndpoint *string

+ type Meta struct

+ APIVersion string

+ QueryTime float64

Aug 1, 2026

Changes in this version

type ClientConfig

+ HTTPClient *http.Client

Aug 1, 2026

Changes in this version

type ClientConfig

+ func (c *ClientConfig) SetDefaults()

Aug 1, 2026

Changes in this version

+ const DefaultContentType

+ const DefaultPort

+ const Repository

+ var ErrConnectionFailed = errors.New(...)

+ var ErrInvalidSecurityKey = errors.New("server returned StatusForbidden: security key is invalid or missing")

+ var ErrRequestTimeout = errors.New("request timed out: the server did not respond in time")

+ var Version string = func() string { ... }()

+ func ToPtr[T any](value T) *T

type ClientConfig

+ UseHTTPS bool

+ func (c *ClientConfig) Validate() error

Jul 30, 2026

Changes in this version

type ClientConfig

+ RemoteApiIP string

+ RemoteApiPort int

+ RemoteSecurityKey string

Jul 30, 2026

Changes in this version

+ const DefaultAPIEndpoint

+ const DefaultTimeout

+ var ErrInvalidConfig = errors.New("invalid client configuration: missing required fields")

Jul 29, 2026

Changes in this version

type Client

+ func (c *Client) Config() ClientConfig

Jul 29, 2026

Changes in this version

+ type Client struct

+ Sender *Sender

+ func NewClient(config ClientConfig) *Client

+ type ClientConfig struct

+ APIEndpoint string

+ BaseURL string

+ HttpClient *http.Client

+ SecurityKey string

+ Timeout time.Duration

+ func GetConfig(c *Client) ClientConfig

+ type Sender struct