dathost

README

dathost-go

Go Unofficial API Library for dathost game servers

https://dathost.readme.io/reference/get_game_servers

Documentation

Index

• type CS2Settings
• type CS2SettingsForm
• type CreateGameServerRequest
  • func (cgsr *CreateGameServerRequest) ToFormData(b *bytes.Buffer) string
• type DatHostClientv01
  • func NewDathostClientv01(username, password string) DatHostClientv01
• type GameServer
• type GameServerMetrics
• type GetLastLineFromConsoleResponse
• type MapPlayed
• type PlayerOnlineGraph
• type Ports
• type StartGameServerBody
  • func (sgsb *StartGameServerBody) ToFormData() *url.Values

Types

type CS2Settings

type CS2Settings struct {
	Slots                        int      `json:"slots"`
	SteamGameServerLoginToken    string   `json:"steam_game_server_login_token"`
	Rcon                         string   `json:"rcon"`
	Password                     string   `json:"password"`
	MapsSource                   string   `json:"maps_source"`
	Mapgroup                     string   `json:"mapgroup"`
	MapgroupStartMap             string   `json:"mapgroup_start_map"`
	WorkshopCollectionID         string   `json:"workshop_collection_id"`
	WorkshopCollectionStartMapID string   `json:"workshop_collection_start_map_id"`
	WorkshopSingleMapID          string   `json:"workshop_single_map_id"`
	Insecure                     bool     `json:"insecure"`
	EnableGotv                   bool     `json:"enable_gotv"`
	EnableGotvSecondary          bool     `json:"enable_gotv_secondary"`
	DisableBots                  bool     `json:"disable_bots"`
	GameMode                     string   `json:"game_mode"`
	EnableMetamod                bool     `json:"enable_metamod"`
	MetamodPlugins               []string `json:"metamod_plugins"`
}

type CS2SettingsForm

type CS2SettingsForm struct {
	// CS2
	SteamGameServerLoginToken    string
	DisableBots                  bool
	EnableGOTV                   bool
	EnableGOTVSecondary          bool
	GameMode                     string // competitive
	Insecure                     bool
	MapsSource                   string // mapgroup
	MapGroup                     string
	MapGroupStartMap             string
	WorkshopCollectionID         string
	WorkshopCollectionStartMapID string
	WorkshopSingleMapID          string
	Password                     string
	RCON                         string
	Slots                        int
}

type CreateGameServerRequest

type CreateGameServerRequest struct {
	AddedVoiceServer  string
	AutoStop          bool
	AutoStopMinutes   int
	Confirmed         bool // ?
	CustomDomain      string
	DeleteProtection  bool
	EnableCoreDump    bool
	EnableMySQL       bool
	EnableSyntropy    bool
	Game              string // cs2. required
	Location          string // https://dathost.net/reference/server-locations-mapping
	ManualSortOrder   int
	MaxDiskUsageGb    int
	Name              string // required.
	PreferDedicated   bool
	RebootOnCrash     bool
	ScheduledCommands string // ?
	ServerImage       string // default is "default", or "ubuntu-20.04"
	UserData          string // custom metadata
	CS2Settings       CS2SettingsForm
}

func (*CreateGameServerRequest) ToFormData

func (cgsr *CreateGameServerRequest) ToFormData(b *bytes.Buffer) string

type DatHostClientv01

type DatHostClientv01 interface {
	// General APIs
	ListGameServers() ([]GameServer, error)
	CreateGameServer(req CreateGameServerRequest) (*GameServer, error)
	DeleteGameServer(id string) error
	GetGameServer(id string) (*GameServer, error)
	UpdateGameServer(id string, req CreateGameServerRequest) error
	GetGameServerMetrics(id string) (*GameServerMetrics, error)

	// Actions API
	DuplicateGameServer(id string) (*GameServer, error)
	ResetGameServer(id string) error
	StartGameServer(id string, data StartGameServerBody) error
	StopGameServer(id string) error
	SyncFilesGameServer(id string) error

	// // Console API
	GetLastLineFromConsole(id string, maxLines int) (*GetLastLineFromConsoleResponse, error)
	SendCommandToConsole(id string, command string) error
}

DatHostClientv01 Client API v0.1

func NewDathostClientv01

func NewDathostClientv01(username, password string) DatHostClientv01

type GameServer

type GameServer struct {
	ID                                string      `json:"id"`
	CreatedAt                         int         `json:"created_at"`
	Name                              string      `json:"name"`
	UserData                          any         `json:"user_data"`
	Game                              string      `json:"game"`
	Location                          string      `json:"location"`
	PlayersOnline                     int         `json:"players_online"`
	Status                            []any       `json:"status"` // ?
	Booting                           bool        `json:"booting"`
	ServerError                       string      `json:"server_error"`
	IP                                string      `json:"ip"`
	RawIP                             string      `json:"raw_ip"`
	PrivateIP                         any         `json:"private_ip"` // ?
	MatchID                           any         `json:"match_id"`   // ?
	On                                bool        `json:"on"`
	Ports                             Ports       `json:"ports"`
	Confirmed                         bool        `json:"confirmed"`
	MaxDiskUsageGb                    int         `json:"max_disk_usage_gb"`
	CostPerHour                       float64     `json:"cost_per_hour"`
	MaxCostPerHour                    float64     `json:"max_cost_per_hour"`
	MonthCredits                      float64     `json:"month_credits"`
	MonthResetAt                      int         `json:"month_reset_at"`
	MaxCostPerMonth                   float64     `json:"max_cost_per_month"`
	SubscriptionCycleMonths           int         `json:"subscription_cycle_months"`
	SubscriptionState                 string      `json:"subscription_state"`
	SubscriptionRenewalFailedAttempts int         `json:"subscription_renewal_failed_attempts"`
	SubscriptionRenewalNextAttemptAt  int         `json:"subscription_renewal_next_attempt_at"`
	CycleMonths1DiscountPercentage    int         `json:"cycle_months_1_discount_percentage"`
	CycleMonths3DiscountPercentage    int         `json:"cycle_months_3_discount_percentage"`
	CycleMonths12DiscountPercentage   int         `json:"cycle_months_12_discount_percentage"`
	FirstMonthDiscountPercentage      int         `json:"first_month_discount_percentage"`
	EnableMysql                       bool        `json:"enable_mysql"`
	Autostop                          bool        `json:"autostop"`
	AutostopMinutes                   int         `json:"autostop_minutes"`
	EnableCoreDump                    bool        `json:"enable_core_dump"`
	PreferDedicated                   bool        `json:"prefer_dedicated"`
	EnableSyntropy                    bool        `json:"enable_syntropy"`
	ServerImage                       string      `json:"server_image"`
	RebootOnCrash                     bool        `json:"reboot_on_crash"`
	ManualSortOrder                   int         `json:"manual_sort_order"`
	MysqlUsername                     string      `json:"mysql_username"`
	MysqlPassword                     string      `json:"mysql_password"`
	FtpPassword                       string      `json:"ftp_password"`
	DiskUsageBytes                    int         `json:"disk_usage_bytes"`
	DefaultFileLocations              any         `json:"default_file_locations"` // ?
	CustomDomain                      string      `json:"custom_domain"`
	ScheduledCommands                 []any       `json:"scheduled_commands"`      // ?
	AddedVoiceServer                  any         `json:"added_voice_server"`      // ?
	DuplicateSourceServer             any         `json:"duplicate_source_server"` // ?
	DeletionProtection                bool        `json:"deletion_protection"`
	OngoingMaintenance                bool        `json:"ongoing_maintenance"`
	ArkSettings                       any         `json:"ark_settings"` // ?
	Cs2Settings                       CS2Settings `json:"cs2_settings"`
	CsgoSettings                      any         `json:"csgo_settings"`            // ?
	EnshroudedSettings                any         `json:"enshrouded_settings"`      // ?
	PalworldSettings                  any         `json:"palworld_settings"`        // ?
	SonsoftheforestSettings           any         `json:"sonsoftheforest_settings"` // ?
	Teamfortress2Settings             any         `json:"teamfortress2_settings"`   // ?
	Teamspeak3Settings                any         `json:"teamspeak3_settings"`      // ?
	ValheimSettings                   any         `json:"valheim_settings"`         // ?
}

type GameServerMetrics

type GameServerMetrics struct {
	PlayersOnlineGraph []PlayerOnlineGraph `json:"players_online_graph"`
	PlayersOnline      []any               `json:"players_online"`   // TODO...
	AllTimePlayers     []any               `json:"all_time_players"` // TODO...
	MapsPlayed         []MapPlayed         `json:"maps_played"`
}

type GetLastLineFromConsoleResponse

type GetLastLineFromConsoleResponse struct {
	Lines []string `json:"lines"`
}

type MapPlayed

type MapPlayed struct {
	Map     string  `json:"map"`
	Seconds float64 `json:"seconds"`
}

type PlayerOnlineGraph

type PlayerOnlineGraph struct {
	Timestamp int `json:"timestamp"`
	Value     int `json:"value"`
}

type Ports

type Ports struct {
	Game          int `json:"game"`
	Gotv          int `json:"gotv"`
	GotvSecondary int `json:"gotv_secondary"`
}

type StartGameServerBody

type StartGameServerBody struct {
	AllowHostReassignment bool
}

func (*StartGameServerBody) ToFormData

func (sgsb *StartGameServerBody) ToFormData() *url.Values