arkrcon

Documentation

Overview

Package ark provides the basic RCON commands for an ARK Surival Server

Index

• Variables
• type ARKChatMsg
• type ARKPlayer
• type ARKRcon
  • func NewARKRconConnection(address, password string) (*ARKRcon, error)
  • func (a *ARKRcon) BanPlayer(steam64 string) error
  • func (a *ARKRcon) Broadcast(message string) error
  • func (a *ARKRcon) DestroyAllEnemies() error
  • func (a *ARKRcon) DestroyWildDinos() error
  • func (a *ARKRcon) DoExit() error
  • func (a *ARKRcon) GetChat() (list []ARKChatMsg, err error)
  • func (a *ARKRcon) KickPlayer(steam64 string) error
  • func (a *ARKRcon) ListPlayers() (list []ARKPlayer, err error)
  • func (a *ARKRcon) Query(cmd string) (resp string, err error)
  • func (a *ARKRcon) RemoveWhitelist(steam64 string) error
  • func (a *ARKRcon) SaveWorld() error
  • func (a *ARKRcon) SendChatToID(steam64, message string) error
  • func (a *ARKRcon) SendChatToPlayer(player, message string) error
  • func (a *ARKRcon) SetMessageOfTheDay(motd string) error
  • func (a *ARKRcon) SetTimeOfDay(time string) error
  • func (a *ARKRcon) Slomo(multiplier int) error
  • func (a *ARKRcon) SpawnDino(blueprint string, x_off, y_off, z_off, level int) error
  • func (a *ARKRcon) UnbanPlayer(steam64 string) error
  • func (a *ARKRcon) WhitelistPlayer(steam64 string) error

Variables

var (
	NoConnection  = errors.New("No connection to RCON")
	EmptyResponse = errors.New("No Server Response")
	FailResponse  = errors.New("Server failed at executing request")
	EnvMissing    = errors.New("One or more environment Variables not set")
)

Types

type ARKChatMsg

type ARKChatMsg struct {
	Username      string
	Playername    string
	Message       string
	ServerMessage bool
}

type ARKPlayer

type ARKPlayer struct {
	Username string
	Steam64  string
}

type ARKRcon

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

func NewARKRconConnection

func NewARKRconConnection(address, password string) (*ARKRcon, error)

func (*ARKRcon) BanPlayer

func (a *ARKRcon) BanPlayer(steam64 string) error

func (*ARKRcon) Broadcast

func (a *ARKRcon) Broadcast(message string) error

func (*ARKRcon) DestroyAllEnemies

func (a *ARKRcon) DestroyAllEnemies() error

Same as DestroyWildDinos but also kills tamed Dinos

func (*ARKRcon) DestroyWildDinos

func (a *ARKRcon) DestroyWildDinos() error

Dinos eventually respawn

func (*ARKRcon) DoExit

func (a *ARKRcon) DoExit() error

func (*ARKRcon) GetChat

func (a *ARKRcon) GetChat() (list []ARKChatMsg, err error)

GetChat returns a list of chat messages since the last call to getchat or an empty list in case there were none

func (*ARKRcon) KickPlayer

func (a *ARKRcon) KickPlayer(steam64 string) error

func (*ARKRcon) ListPlayers

func (a *ARKRcon) ListPlayers() (list []ARKPlayer, err error)

ListPlayers returns a list of online players or an empty list

func (*ARKRcon) Query

func (a *ARKRcon) Query(cmd string) (resp string, err error)

func (*ARKRcon) RemoveWhitelist

func (a *ARKRcon) RemoveWhitelist(steam64 string) error

func (*ARKRcon) SaveWorld

func (a *ARKRcon) SaveWorld() error

func (*ARKRcon) SendChatToID

func (a *ARKRcon) SendChatToID(steam64, message string) error

func (*ARKRcon) SendChatToPlayer

func (a *ARKRcon) SendChatToPlayer(player, message string) error

func (*ARKRcon) SetMessageOfTheDay

func (a *ARKRcon) SetMessageOfTheDay(motd string) error

func (*ARKRcon) SetTimeOfDay

func (a *ARKRcon) SetTimeOfDay(time string) error

SetTimeOfDay expects the time format to be hh:mm

func (*ARKRcon) Slomo

func (a *ARKRcon) Slomo(multiplier int) error

Slomo modifier. Set to 1 to return to normal

func (*ARKRcon) SpawnDino

func (a *ARKRcon) SpawnDino(blueprint string, x_off, y_off, z_off, level int) error

func (*ARKRcon) UnbanPlayer

func (a *ARKRcon) UnbanPlayer(steam64 string) error

func (*ARKRcon) WhitelistPlayer

func (a *ARKRcon) WhitelistPlayer(steam64 string) error