Add --list-fields

Author: hfern

fieldspec.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"fmt"
 	"github.com/hfern/goseq"
 )
 
@@ -41,32 +42,33 @@ var serverProperties = map[string]ServerMethod{
 type FieldProperty struct {
 	name string
 	size int
+	full string
 }
 
 var serverFieldProperties = map[string]FieldProperty{
-	"bots":          FieldProperty{name: "Bots", size: 5},
-	"duration":      FieldProperty{name: "Arrest In", size: 7},
-	"environment":   FieldProperty{name: "Env", size: 3},
+	"bots":          FieldProperty{name: "Bots", size: 5, full: "Number of Bots"},
+	"duration":      FieldProperty{name: "Arrest In", size: 7, full: "Will arrest in (The Ship)"},
+	"environment":   FieldProperty{name: "Env", size: 3, full: "Environment OS"},
 	"folder":        FieldProperty{name: "Folder", size: 10},
 	"game":          FieldProperty{name: "Game", size: 5},
 	"gameid":        FieldProperty{name: "GameID", size: 6},
 	"id":            FieldProperty{name: "ID", size: 5},
 	"keywords":      FieldProperty{name: "Keywords", size: 9},
 	"map":           FieldProperty{name: "Map", size: 10},
-	"maxplayers":    FieldProperty{name: "Max", size: 3},
+	"maxplayers":    FieldProperty{name: "Max", size: 3, full: "Maximum number of players allowed"},
 	"mode":          FieldProperty{name: "Mode", size: 4},
-	"name":          FieldProperty{name: "Name", size: 15},
-	"players":       FieldProperty{name: "Ply", size: 3},
+	"name":          FieldProperty{name: "Name", size: 15, full: "Name of Server"},
+	"players":       FieldProperty{name: "Ply", size: 3, full: "Number Players"},
 	"port":          FieldProperty{name: "Port", size: 5},
-	"servertype":    FieldProperty{name: "Type", size: 5},
+	"servertype":    FieldProperty{name: "Type", size: 5, full: "Hosting Type (eg dedicated)"},
 	"spectatorname": FieldProperty{name: "Spectator", size: 9},
 	"spectatorport": FieldProperty{name: "SpPort", size: 7},
 	"steamid":       FieldProperty{name: "SteamID", size: 10},
-	"vac":           FieldProperty{name: "VAC", size: 3},
+	"vac":           FieldProperty{name: "VAC", size: 3, full: "Is the server VAC protected?"},
 	"version":       FieldProperty{name: "Version", size: 5},
-	"visibility":    FieldProperty{name: "Pw.", size: 3},
-	"witnesses":     FieldProperty{name: "Witnesses", size: 10},
-	"ip":            FieldProperty{name: "IP Addr", size: 21},
+	"visibility":    FieldProperty{name: "Pw.", size: 3, full: "Is a password required to join?"},
+	"witnesses":     FieldProperty{name: "Witnesses", size: 10, full: "# Witnesses for The Ship."},
+	"ip":            FieldProperty{name: "IP Addr", size: 21, full: "IP Address of the Server"},
 }
 
 type FieldTransformer func(Any) Any
@@ -90,3 +92,33 @@ func transformEnvironment(in Any) Any {
 		return "_"
 	}
 }
+
+func printServerFieldProperties() {
+	fmt.Println("Server Fields:")
+
+	longest := 0
+	for field, _ := range serverFieldProperties {
+		if len(field) > longest {
+			longest = len(field)
+		}
+	}
+
+	for field, prop := range serverFieldProperties {
+
+		fmt.Print("    ", field)
+
+		for i := len(field); i < longest; i++ {
+			fmt.Print(" ")
+		}
+
+		desc := prop.name
+
+		if prop.full != "" {
+			desc = prop.full
+		}
+
+		fmt.Printf("    %s (size %d)\n", desc, prop.size)
+	}
+
+	fmt.Println()
+}

masterctx.go

@@ -32,6 +32,7 @@ type MasterQueryOptions struct {
 	// TODO(hunter): Add this
 	ListFilters bool `long:"list-filters" default:"false" description:"List known filters." group:"Lists"`
 	ListRegions bool `long:"list-regions" default:"false" description:"List Regions." group:"Lists"`
+	ListFields  bool `long:"list-fields" default:"false" description:"List Server Fields." group:"Lists"`
 }
 
 var masterOptions MasterQueryOptions
@@ -279,6 +280,7 @@ func printInfo() (done bool) {
 	}{
 		{printKnownFiltersInfo, masterOptions.ListFilters},
 		{printRegionInfo, masterOptions.ListRegions},
+		{printServerFieldProperties, masterOptions.ListFields},
 	}
 
 	for _, info := range infos {