Advertiser, APIkeys, QOL and improvements

.vscode/launch.json

@@ -29,6 +29,6 @@
             "console": "integratedTerminal",
             "showLog": false, // Hides some Go Debugger(Delve) log stuff that is not useful for debugging atm
             "args": ["--NoSteamCMD"]
-        }
+        },
     ]
 }

readme.md

@@ -4,7 +4,7 @@
 
 # Stationeers Server UI
 
-![Go](https://img.shields.io/badge/Go-1.24.2-blue?logo=go&logoColor=white)
+![Go](https://img.shields.io/badge/Go-1.25.0-blue?logo=go&logoColor=white)
 ![Version](https://img.shields.io/github/v/release/jacksonthemaster/StationeersServerUI?logo=github&logoColor=white)
 ![Issues](https://img.shields.io/github/issues/jacksonthemaster/StationeersServerUI?logo=github&logoColor=white)
 ![Stars](https://img.shields.io/github/stars/jacksonthemaster/StationeersServerUI?style=social&logo=github)
@@ -25,14 +25,8 @@
 
 <div align="center">
 
-### 🌟 Live UI Preview 🌟
+### 🌟 This is a WebUi, you don't need a graphical OS to run this 🌟
 
-Explore your fututre Stationeers Server UI in action—no setup required!
-And the "best part?" The Demo current is not on the V5 but V4, so if you are convinced by the Demo, it will only get better when you actually try it out!
-
-### Preview is not available any more, but will be available soon!
-
-[![v4 Live Preview - Stationeers UI](https://img.shields.io/badge/Live%20Preview-Stationeers%20Server%20UI-blueviolet?style=for-the-badge&logo=github)](https://jacksonthemaster.github.io/StationeersServerUI/server.html)
 [![Download latest Version](https://img.shields.io/badge/Download-Stationeers%20Server%20UI-orange?style=for-the-badge)](https://jacksonthemaster.github.io/StationeersServerUI)
 </div>
 

server.go

@@ -39,8 +39,7 @@ func main() {
 	logger.ConfigureConsole()
 	loader.ParseFlags()
 	loader.HandleSanityCheckFlag()
-	loader.SanityCheck(&wg)
-	wg.Wait()
+	loader.SanityCheck()
 	logger.Main.Info("Initializing resources...")
 	loader.InitVirtFS(v1uiFS)
 	logger.Install.Info("Starting setup...")
@@ -49,11 +48,9 @@ func main() {
 	setup.Install(&wg)
 	wg.Wait()
 	logger.Main.Debug("Initializing Backend...")
-	loader.InitBackend(&wg)
-	wg.Wait()
+	loader.InitBackend()
 	logger.Main.Debug("Initializing after start tasks...")
-	loader.AfterStartComplete(&wg)
-	wg.Wait()
+	loader.AfterStartComplete()
 	logger.Main.Debug("Starting webserver...")
 	web.StartWebServer(&wg)
 	logger.Main.Debug("Initializing SSUICLI...")

src/advertiser/advertiser.go

@@ -0,0 +1,180 @@
+package advertiser
+
+import (
+	"bytes"
+	"encoding/json"
+	"errors"
+	"net"
+	"net/http"
+	"runtime"
+	"strconv"
+	"time"
+
+	"github.com/JacksonTheMaster/StationeersServerUI/v5/src/config"
+	"github.com/JacksonTheMaster/StationeersServerUI/v5/src/logger"
+	"github.com/JacksonTheMaster/StationeersServerUI/v5/src/managers/detectionmgr"
+	"github.com/JacksonTheMaster/StationeersServerUI/v5/src/managers/gamemgr"
+)
+
+var StationeersAdvertisementEndpoint = config.GetStationeersServerPingEndpoint()
+
+const maxTransientErrors = 5
+const advertiserIntervalSeconds = 30
+
+type ServerAdMessage struct {
+	SessionId  int
+	Name       string
+	Password   bool
+	Version    string
+	Address    string
+	Port       string
+	Players    int
+	MaxPlayers int
+	Type       int
+}
+
+type ServerAdResponse struct {
+	SessionId int
+	Status    string
+}
+
+func getIpFromAdvertiserOverride(address string) (string, error) {
+	// If the address is "auto", we need to check our public IPv4 via ipify
+	if address == "auto" {
+		resp, err := http.Get("https://api4.ipify.org")
+		if err != nil {
+			return "", err
+		}
+		defer resp.Body.Close()
+		buf := new(bytes.Buffer)
+		buf.ReadFrom(resp.Body)
+		return buf.String(), nil
+	}
+	// If the address is an IP quad, return it as is
+	if ip := net.ParseIP(address); ip != nil {
+		if ip.To4() != nil {
+			return ip.To4().String(), nil
+		} else if ip.To16() != nil {
+			return "", errors.New("IPv6 addresses are not supported for advertiser override")
+		}
+	}
+	// If the address is a DNS name, resolve it
+	ips, err := net.LookupIP(address)
+	if err != nil {
+		return "", err
+	}
+	// Return the first resolved IPv4 address
+	for _, ip := range ips {
+		if ip.To4() != nil {
+			return ip.To4().String(), nil
+		}
+	}
+	// If the address is invalid, return an error
+	return "", errors.New("unable to resolve IP from advertiser override")
+}
+
+func StartAdvertiser() {
+	if config.GetServerVisible() {
+		logger.Advertiser.Warn("Server advertisement is enabled. Disable it in the config and restart SSUI to use manual advertisement. Skipping for now...")
+		return
+	}
+	go func() {
+		sessionId := -1
+		// Track accumulated transient errors and kill the advertiser if we exceed a threshold
+		transientErrors := 0
+		for {
+			// Only advertise if we are running
+			if gamemgr.InternalIsServerRunning() {
+				// If we have exceeded the max transient errors, exit the advertiser
+				if transientErrors >= maxTransientErrors {
+					logger.Advertiser.Errorf("ServerAdvertiser exceeded max transient errors (%d). Stopping advertiser...", maxTransientErrors)
+					return
+				}
+				// Get max players
+				maxplayers, err := strconv.Atoi(config.GetServerMaxPlayers())
+				if err != nil {
+					logger.Advertiser.Errorf("ServerAdvertiser failed to convert max players number to int: %s", config.GetServerMaxPlayers())
+					return
+				}
+				// Get connected players
+				detector := detectionmgr.GetDetector()
+				players := len(detectionmgr.GetPlayers(detector))
+				// Get platform
+				platform := 0
+				switch runtime.GOOS {
+				case "windows":
+					platform = 1
+				case "linux":
+					platform = 2
+				}
+				// Get IP address
+				ipAddress, err := getIpFromAdvertiserOverride(config.GetAdvertiserOverride())
+				if err != nil {
+					logger.Advertiser.Warnf("ServerAdvertiser failed to get IP address from config value '%s': %v", config.GetAdvertiserOverride(), err)
+					transientErrors++
+					time.Sleep(advertiserIntervalSeconds * time.Second)
+					continue
+				}
+				adMessage := ServerAdMessage{
+					SessionId:  sessionId,
+					Name:       config.GetServerName(),
+					Password:   config.GetServerPassword() != "",
+					Version:    config.GetExtractedGameVersion(),
+					Address:    ipAddress,
+					Port:       config.GetGamePort(),
+					Players:    players,
+					MaxPlayers: maxplayers,
+					Type:       platform,
+				}
+				body, err := json.Marshal(adMessage)
+				if err != nil {
+					logger.Advertiser.Warnf("ServerAdvertiser failed to Serialize to JSON from native Go struct type: %v", err)
+					transientErrors++
+					time.Sleep(advertiserIntervalSeconds * time.Second)
+					continue
+				}
+				// Send advertisement
+				resp, err := http.Post(StationeersAdvertisementEndpoint, "application/json", bytes.NewBuffer(body))
+				// Check for errors
+				if err != nil {
+					logger.Advertiser.Warnf("ServerAdvertiser failed to send request: %v", err)
+					transientErrors++
+					time.Sleep(advertiserIntervalSeconds * time.Second)
+					continue
+				}
+				// Check for non-200 status codes
+				if resp.StatusCode != 200 {
+					logger.Advertiser.Warnf("ServerAdvertiser received non-200 status: %d", resp.StatusCode)
+					transientErrors++
+					time.Sleep(advertiserIntervalSeconds * time.Second)
+					resp.Body.Close() // Close the response body
+					continue
+				}
+				// Read the response and update our sessionId if needed
+				adResponse := ServerAdResponse{}
+				err = json.NewDecoder(resp.Body).Decode(&adResponse)
+				resp.Body.Close()
+				if err != nil {
+					logger.Advertiser.Warnf("Failed to decode response body: %v", err)
+					transientErrors++
+					time.Sleep(advertiserIntervalSeconds * time.Second)
+					continue
+				}
+				if adResponse.Status != "Success" {
+					logger.Advertiser.Warnf("ServerAdvertiser received unexpected status: %s", adResponse.Status)
+					transientErrors++
+					time.Sleep(advertiserIntervalSeconds * time.Second)
+					continue
+				}
+				// Reset transient errors on success
+				sessionId = adResponse.SessionId
+				transientErrors = 0
+			} else {
+				// Reset sessionid for the next run
+				sessionId = -1
+			}
+			// Sleep for 30 seconds to follow the standard advertisement timer
+			time.Sleep(advertiserIntervalSeconds * time.Second)
+		}
+	}()
+}

src/config/config.go

@@ -51,10 +51,11 @@ type JsonConfig struct {
 	StartLocation    string `json:"StartLocation"`
 
 	// Logging and debug settings
-	Debug             *bool    `json:"Debug"`
-	CreateSSUILogFile *bool    `json:"CreateSSUILogFile"`
-	LogLevel          int      `json:"LogLevel"`
-	SubsystemFilters  []string `json:"subsystemFilters"`
+	Debug              *bool    `json:"Debug"`
+	CreateSSUILogFile  *bool    `json:"CreateSSUILogFile"`
+	LogLevel           int      `json:"LogLevel"`
+	SubsystemFilters   []string `json:"subsystemFilters"`
+	AdvertiserOverride string   `json:"AdvertiserOverride"`
 
 	// Authentication Settings
 	Users             map[string]string `json:"users"`       // Map of username to hashed password
@@ -296,6 +297,8 @@ func applyConfig(cfg *JsonConfig) {
 	// use Safebackups folder either way.
 	ConfiguredSafeBackupDir = filepath.Join("./saves/", SaveName, "Safebackups")
 
+	AdvertiserOverride = getString(cfg.AdvertiserOverride, "ADVERTISER_OVERRIDE", "")
+
 	safeSaveConfig()
 }
 
@@ -365,6 +368,7 @@ func safeSaveConfig() error {
 		AutoStartServerOnStartup:   &AutoStartServerOnStartup,
 		SSUIIdentifier:             SSUIIdentifier,
 		SSUIWebPort:                SSUIWebPort,
+		AdvertiserOverride:         AdvertiserOverride,
 	}
 
 	file, err := os.Create(ConfigPath)

src/config/getters.go

@@ -513,3 +513,20 @@ func GetIsDockerContainer() bool {
 	defer ConfigMu.RUnlock()
 	return IsDockerContainer
 }
+
+func GetIsGameServerRunning() bool {
+	ConfigMu.RLock()
+	defer ConfigMu.RUnlock()
+	return IsGameServerRunning
+}
+func GetAdvertiserOverride() string {
+	ConfigMu.RLock()
+	defer ConfigMu.RUnlock()
+	return AdvertiserOverride
+}
+
+func GetStationeersServerPingEndpoint() string {
+	ConfigMu.RLock()
+	defer ConfigMu.RUnlock()
+	return StationeersServerPingEndpoint
+}

src/config/setters.go

@@ -86,6 +86,14 @@ func SetWorldID(value string) error {
 	return nil
 }
 
+func SetIsGameServerRunning(value bool) error {
+	ConfigMu.Lock()
+	defer ConfigMu.Unlock()
+
+	IsGameServerRunning = value
+	return nil
+}
+
 // ALL SETTERS BELOW THIS LINE ARE UNUSED AT THE MOMENT
 // ALL SETTERS BELOW THIS LINE ARE UNUSED AT THE MOMENT
 // ALL SETTERS BELOW THIS LINE ARE UNUSED AT THE MOMENT
@@ -694,3 +702,11 @@ func SetAllowAutoGameServerUpdates(value bool) error {
 	AllowAutoGameServerUpdates = value
 	return safeSaveConfig()
 }
+
+func SetAdvertiserOverride(value string) error {
+	ConfigMu.Lock()
+	defer ConfigMu.Unlock()
+
+	AdvertiserOverride = value
+	return safeSaveConfig()
+}

src/config/vars.go

@@ -61,6 +61,7 @@ var (
 	LanguageSetting          string
 	AutoStartServerOnStartup bool
 	SSUIIdentifier           string
+	AdvertiserOverride       string
 )
 
 // Runtime only variables
@@ -71,6 +72,7 @@ var (
 	SkipSteamCMD         bool   // ONLY RUNTIME
 	IsDockerContainer    bool   // ONLY RUNTIME
 	NoSanityCheck        bool   // ONLY RUNTIME
+	IsGameServerRunning  bool   // ONLY RUNTIME
 )
 
 // Discord integration
@@ -129,20 +131,21 @@ var (
 
 // File paths
 var (
-	TLSCertPath              = "./UIMod/tls/cert.pem"
-	TLSKeyPath               = "./UIMod/tls/key.pem"
-	ConfigPath               = "./UIMod/config/config.json"
-	CustomDetectionsFilePath = "./UIMod/config/customdetections.json"
-	LogFolder                = "./UIMod/logs/"
-	UIModFolder              = "./UIMod/"
-	TwoBoxFormFolder         = "./UIMod/twoboxform/"
-	ConfigHtmlPath           = "./UIMod/ui/config.html"
-	DetectionManagerHtmlPath = "./UIMod/ui/detectionmanager.html"
-	TwoBoxFormHtmlPath       = "./UIMod/twoboxform/twoboxform.html"
-	IndexHtmlPath            = "./UIMod/ui/index.html"
-	SSCMWebDir               = "./UIMod/sscm/"
-	SSCMFilePath             = "./BepInEx/plugins/SSCM/SSCM.socket"
-	SSCMPluginDir            = "./BepInEx/plugins/SSCM/"
+	TLSCertPath                   = "./UIMod/tls/cert.pem"
+	TLSKeyPath                    = "./UIMod/tls/key.pem"
+	ConfigPath                    = "./UIMod/config/config.json"
+	CustomDetectionsFilePath      = "./UIMod/config/customdetections.json"
+	LogFolder                     = "./UIMod/logs/"
+	UIModFolder                   = "./UIMod/"
+	TwoBoxFormFolder              = "./UIMod/twoboxform/"
+	ConfigHtmlPath                = "./UIMod/ui/config.html"
+	DetectionManagerHtmlPath      = "./UIMod/ui/detectionmanager.html"
+	TwoBoxFormHtmlPath            = "./UIMod/twoboxform/twoboxform.html"
+	IndexHtmlPath                 = "./UIMod/ui/index.html"
+	SSCMWebDir                    = "./UIMod/sscm/"
+	SSCMFilePath                  = "./BepInEx/plugins/SSCM/SSCM.socket"
+	SSCMPluginDir                 = "./BepInEx/plugins/SSCM/"
+	StationeersServerPingEndpoint = "http://40.82.200.175:8081/Ping"
 )
 
 // Bundled Assets

src/core/loader/afterstart.go

@@ -1,18 +1,14 @@
 package loader
 
 import (
-	"sync"
-
 	"github.com/JacksonTheMaster/StationeersServerUI/v5/src/config"
 	"github.com/JacksonTheMaster/StationeersServerUI/v5/src/discordrpc"
 	"github.com/JacksonTheMaster/StationeersServerUI/v5/src/logger"
 	"github.com/JacksonTheMaster/StationeersServerUI/v5/src/managers/gamemgr"
 	"github.com/JacksonTheMaster/StationeersServerUI/v5/src/setup"
 )
 
-func AfterStartComplete(wg *sync.WaitGroup) {
-	wg.Add(1)
-	defer wg.Done()
+func AfterStartComplete() {
 	config.SetSaveConfig() // Save config after startup through setters
 	err := setup.CleanUpOldUIModFolderFiles()
 	if err != nil {