extinfo

extinfo

A Go package to query information ('extinfo') from a Sauerbraten game server.

Usage

Get the package:

$ go get github.com/sauerbraten/extinfo

Import the package:

import (
	"github.com/sauerbraten/extinfo"
)

Documentation

Detailed Documentation here.

Example

Here is code to get you the state of the PSL1 server:

package main

import (
	"fmt"
	"time"

	"github.com/sauerbraten/extinfo"
)

func main() {
	psl1, err := extinfo.NewServer("sauerleague.org", 10000, 3*time.Second)
	if err != nil {
		fmt.Println(err)
		return
	}

	basicInfo, err := psl1.GetBasicInfo()
	if err != nil {
		fmt.Print("Error getting basic information: ", err)
		return
	}

	fmt.Print("Basic Server Information:\n")
	fmt.Printf("Description:                %v\n", basicInfo.Description)
	fmt.Printf("Master Mode:                %v\n", basicInfo.MasterMode)
	fmt.Printf("Game Mode:                  %v\n", basicInfo.GameMode)
	fmt.Printf("Map:                        %v\n", basicInfo.Map)
	fmt.Printf("Clients:                    %v\n", basicInfo.NumberOfClients)
	fmt.Printf("Maximum Number of Clients:  %v\n", basicInfo.MaxNumberOfClients)
	fmt.Printf("Time Left (seconds):        %v\n", basicInfo.SecsLeft)
	fmt.Printf("Protocol Version:           %v\n", basicInfo.ProtocolVersion)
}

The output should be something like this:

Basic Server Information:
Description:                PSL.sauerleague.org
Master Mode:                auth
Game Mode:                  insta ctf
Map:                        garden
clients:                    14
Maximum Number of Clients:  23
Time Left (seconds):        262
Protocol Version:           259

GetClientInfo() and GetClientInfoRaw() work pretty much the same; here is an example to get the client information of the client with the cn 4 on PSL1:

...

func main() {
	psl1, err := extinfo.NewServer("sauerleague.org", 10000, 3*time.Second)
	if err != nil {
		fmt.Println(err)
		return
	}

	clientInfo, err := psl1.GetClientInfo(14)
	if err != nil {
		fmt.Print("Error getting client information: ", err)
		return
	}

	fmt.Print("Client Information:\n")
	fmt.Printf("Name:                       %v\n", clientInfo.Name)
	fmt.Printf("Client Number:              %v\n", clientInfo.ClientNum)
	fmt.Printf("Ping:                       %v\n", clientInfo.Ping)
	fmt.Printf("Team:                       %v\n", clientInfo.Team)
	fmt.Printf("Frags:                      %v\n", clientInfo.Frags)
	// here you could get more things like deaths, health, armour, the client state (dead/alive/spectator/...), and so on
	fmt.Printf("Privilege:                  %v\n", clientInfo.Privilege)
	fmt.Printf("IP:                         %v\n", clientInfo.IP)
}

Output would look like this:

Client Information:
Name:                       [tBMC]Rsn
Client Number:              14
Ping:                       45
Team:                       good
Frags:                      8
Privilege:                  none
IP:                         85.8.108.0

There is also GetTeamsScores() which returns all teams' scores (a TeamsScores containing a TeamScore (team score) for every team in the current game). Example code:

...

func main() {
	psl1, err := extinfo.NewServer("sauerleague.org", 10000, 3*time.Second)
	if err != nil {
		fmt.Println(err)
		return
	}

	scores, err := psl1.GetTeamScores()
	if err != nil {
		fmt.Print("Error getting teams' scores: ", err)
		return
	}

	fmt.Print("Team Scores:\n")

	fmt.Printf("Game Mode:                  %v\n", scores.GameMode)
	fmt.Printf("Time Left (seconds):        %v\n", scores.SecsLeft)
	fmt.Print("Scores:\n")

	for _, score := range scores.Scores {
		fmt.Printf("   Team:                    %v\n", score.Name)
		fmt.Printf("   Score:                   %v\n", score.Score)

		if scores.GameMode == "capture" || scores.GameMode == "regen capture" {
			fmt.Printf("   Bases:                   %v\n", score.Bases)
		}
	}
}

Output:

Team Scores:
Game Mode:                  insta ctf
Time Left (seconds):        114
Scores:
   Team:                    good
   Score:                   6
   Team:                    evil
   Score:                   4

More methods:

• GetUptime(): returns the amount of seconds the sauerbraten server is running
• GetAllClientInfo(): returns a ClientInfo for every client connected to the server
• GetTeamScoresRaw(): returns a TeamScoresRaw containing a TeamScore for every team in the current game