Merge pull request 'Added README' (#2) from develop into main

Reviewed-on: #2

backup.go

@@ -7,7 +7,7 @@ import (
 	"time"
 )
 
-func backUp(cmd string, c UsrConfig) {
+func backUp(cmd string, c GoConfig) {
 	switch cmd {
 	case "full":
 		fmt.Println("Starting full server backup")

cli.go

@@ -19,7 +19,9 @@ func cliToolMode() {
 				startStopServer("stop", c)
 			}
 		case "help", "h", "--help", "-h":
-			fmt.Printf("Start Server: %s start\nStop Server: %s stop\nRun backup\n\tFull backup: %s backup full\n\tBackup saves: %s backup saves\n", os.Args[0], os.Args[0], os.Args[0], os.Args[0])
+			fmt.Printf("Start Server: %s start\nStop Server: %s stop\n", os.Args[0], os.Args[0])
+			fmt.Printf("Run backup\n\tFull backup: %s backup full", os.Args[0])
+			fmt.Printf("\n\tBackup saves: %s backup saves\n", os.Args[0])
 		case "download":
 			if len(os.Args) > 2 {
 				switch os.Args[2] {

config.go

@@ -9,30 +9,14 @@ import (
 	"gopkg.in/yaml.v3"
 )
 
-func DefCfg() *DefConfig {
-	c := &DefConfig{}
-	// server settings
-	c.Server.ServDir = "factorio"
-	c.Server.ServPort = 34197
-	c.Server.ServCfg = "factorio/data/server-settings.json"
-	c.Server.ServExec = "factorio/bin/x64/factorio"
-	c.Server.WorldFile = "factorio/saves/newworld.zip"
-	c.Factoryman.UseScreen = true
-	c.Factoryman.ScreenName = "factorio"
-	c.Factoryman.BackupDir = "factorio/backups"
-	c.Factoryman.UserName = ""
-	c.Factoryman.ApiToken = ""
-	return c
-}
-func readCfg(factCfg string) UsrConfig {
+func readCfg(factCfg string) GoConfig {
 	//read config file (YAML)
 	fileBytes, err := os.ReadFile(factCfg)
 	if err != nil {
-		fmt.Printf("Error reading config.yml file, using defaults\n")
-		return UsrConfig(*DefCfg())
+		log.Fatalf("Error reading config file: %v", err)
 	}
 	// return Struct
-	var config UsrConfig
+	var config GoConfig
 	err = yaml.Unmarshal(fileBytes, &config)
 	if err != nil {
 		log.Fatalf("Error unmarshalling YAML file: %v", err)
@@ -48,7 +32,7 @@ func isItReal(path string) bool { //check if path exists
 		return false
 	}
 }
-func verifyConfig(config UsrConfig) bool { // check each file/dir to see if it exists
+func verifyConfig(config GoConfig) bool { // check each file/dir to see if it exists
 	if !isItReal(config.Server.ServDir) { //check for Server directory
 		fmt.Printf("PATH NOT FOUND: %s", config.Server.ServDir)
 		return false

config.yml

@@ -1,6 +1,6 @@
 server:
   serverFolder: "factorio"
-  worldFile: "factorio/saves/newworld.zip"
+  worldFile: ""
   serverSettings: "factorio/data/server-settings.json"
   serverExec: "factorio/bin/x64/factorio"
   port: 34197

launchserver.go

@@ -7,7 +7,7 @@ import (
 	"os/exec"
 )
 
-func startStopServer(cmd string, con UsrConfig) {
+func startStopServer(cmd string, con GoConfig) {
 	switch cmd {
 	case "start":
 		x := fmt.Sprintf("%s --port %d --server-settings %s --start-server %s", con.Server.ServExec, con.Server.ServPort, con.Server.ServCfg, con.Server.WorldFile)

structs.go

@@ -1,7 +1,7 @@
 package main
 
 // config struct
-type UsrConfig struct {
+type GoConfig struct {
 	Server struct { // server specific settings
 		ServDir   string `yaml:"serverFolder"`
 		WorldFile string `yaml:"worldFile"`
@@ -19,24 +19,6 @@ type UsrConfig struct {
 	} `yaml:"factoryman"`
 }
 
-type DefConfig struct {
-	Server struct { // server specific settings
-		ServDir   string
-		WorldFile string
-		ServCfg   string
-		ServExec  string
-		ServPort  int
-	}
-
-	Factoryman struct { // factoryman settings
-		BackupDir  string
-		UseScreen  bool
-		ScreenName string
-		UserName   string
-		ApiToken   string
-	}
-}
-
 // JSON file from config
 type Mod struct {
 	Name    string `json:"name"`