Interactive config editor (#396)

# Description

This provides a basic in-game config editor using the command `server config` and selecting configurations until you find what you want to edit.

## Changes

- `server config` initiates the interactive prompts
- configs re-validate when changes are made now
- better flattening of config files into dot-syntax.
- Fixed "locked" fields, they were in an old format.
- Updated helpfile. Converted helpfile to `.md` format.

## Notes

- Does not accept partial entry to match names - may be worth adding
- Does not accept numeric menu selections - may be worth adding

## Example

```
[☾ 10:03PM HP:60/60 MP:32/32]:server config


   1. FilePaths         - ...
   2. GamePlay          - ...
   3. Integrations      - ...
   4. LootGoblin        - ...
   5. Memory            - ...
   6. Modules           - ...
   7. Network           - ...
   8. Roles             - ...
   9. Scripting         - ...
  10. Server            - ...
  11. SpecialRooms      - ...
  12. TextFormats       - ...
  13. Timing            - ...
  14. Translation       - ...
  15. Validation        - ...


.: Choose a config option, or "quit": gameplay

   [gameplay]

   1. AllowItemBuffRemoval - false
   2. ConsistentAttackMessages - true
   3. ContainerSizeMax  - 10
   4. Death             - ...
   5. LivesMax          - 3
   6. LivesOnLevelUp    - 1
   7. LivesStart        - 3
   8. MaxAltCharacters  - 3
   9. MobConverseChance - 3
  10. PVP               - limited
  11. PVPMinimumLevel   - 15
  12. PricePerLife      - 1000000
  13. ShopRestockRate   - 6 hours
  14. XPScale           - 100


.: Choose a config option, or "quit": death

   [gameplay.death]

   1. AlwaysDropBackpack - false
   2. CorpseDecayTime   - 1 hour
   3. CorpsesEnabled    - true
   4. EquipmentDropChance - 0.25
   5. PermaDeath        - false
   6. ProtectionLevels  - 5
   7. XPPenalty         - none


.: Choose a config option, or "quit": permadeath
.: New value for GamePlay.Death.PermaDeath [false] true

GamePlay.Death.PermaDeath has been set to: true

```

Author: Volte6

_datafiles/config.yaml

@@ -77,13 +77,11 @@ Server:
   #   It is a good idea to lock configs related to folder/file paths to prevent
   #   accidental changes that could break the game.
   Locked:
-  - DataFiles
-  - PublicHtml
-  - AdminHtml
-  - NextRoomId
-  - Seed
-  - OnLoginCommands
-  - BannedNames
+  - FilePaths
+  - Server.NextRoomId
+  - Server.Seed
+  - Server.OnLoginCommands
+  - Server.BannedNames
 
 ################################################################################
 #

_datafiles/world/default/templates/admincommands/help/command.server.md

@@ -0,0 +1,20 @@
+# Help for ~server~ (admin command)
+
+The ~server~ command can be used in the following ways:
+
+## Usage:
+
+  ~server reload-ansi~  
+  Reloads aliases from the ansi alias file
+
+  ~server stats~  
+  Get stats on the server
+
+  ~server set~  
+  Lists all server configuration settings
+
+  ~server set [name] [value]~  
+  Sets a configuration settings (and saves it)
+
+  ~server config~  
+  Initiates an interactive configuration editor

_datafiles/world/default/templates/admincommands/help/command.server.template

@@ -0,0 +1,20 @@
+# Help for ~server~ (admin command)
+
+The ~server~ command can be used in the following ways:
+
+## Usage:
+
+  ~server reload-ansi~  
+  Reloads aliases from the ansi alias file
+
+  ~server stats~  
+  Get stats on the server
+
+  ~server set~  
+  Lists all server configuration settings
+
+  ~server set [name] [value]~  
+  Sets a configuration settings (and saves it)
+
+  ~server config~  
+  Initiates an interactive configuration editor

_datafiles/world/empty/templates/admincommands/help/command.server.md

@@ -114,7 +114,7 @@ func (c *Config) DotPaths() map[string]any {
 
 func (c *Config) buildDotPaths(v reflect.Value, prefix string, result map[string]any) {
 	// If the value is a pointer, dereference it.
-	if v.Kind() == reflect.Ptr {
+	if v.Kind() == reflect.Interface || v.Kind() == reflect.Ptr {
 		if v.IsNil() {
 			return
 		}
@@ -317,7 +317,12 @@ func SetVal(propertyPath string, newVal string) error {
 		return err
 	}
 
-	return configData.OverlayOverrides(overrides)
+	if err = configData.OverlayOverrides(overrides); err != nil {
+		return err
+	}
+
+	configData.Validate()
+	return nil
 }
 
 func GetConfig() Config {

_datafiles/world/empty/templates/admincommands/help/command.server.template

@@ -1,6 +1,7 @@
 package usercommands
 
 import (
+	"errors"
 	"fmt"
 	"slices"
 	"sort"
@@ -18,6 +19,11 @@ import (
 
 var (
 	memoryReportCache = map[string]util.MemoryResult{}
+	errValueLocked    = errors.New("This config value is locked. You must edit the config file directly.")
+)
+
+const (
+	newValuePrompt = `New value for <ansi fg="6">%s</ansi>`
 )
 
 /*
@@ -33,6 +39,10 @@ func Server(rest string, user *users.UserRecord, room *rooms.Room, flags events.
 	}
 
 	args := util.SplitButRespectQuotes(rest)
+	if args[0] == "config" {
+		return server_Config(strings.TrimSpace(rest[1:]), user, room, flags)
+	}
+
 	if args[0] == "set" {
 
 		args = args[1:]
@@ -287,3 +297,228 @@ func Server(rest string, user *users.UserRecord, room *rooms.Room, flags events.
 
 	return true, nil
 }
+
+func server_Config(_ string, user *users.UserRecord, room *rooms.Room, flags events.EventFlag) (bool, error) {
+
+	// Get if already exists, otherwise create new
+	cmdPrompt, isNew := user.StartPrompt(`server config`, "")
+
+	if isNew {
+		user.SendText(``)
+		menuOptions, _ := getConfigOptions("")
+		tplTxt, _ := templates.Process("tables/numbered-list", menuOptions, user.UserId)
+		user.SendText(tplTxt)
+	}
+
+	configPrefix := ""
+	if selection, ok := cmdPrompt.Recall("config-selected"); ok {
+		configPrefix = selection.(string)
+	}
+
+	if configPrefix != "" {
+		allConfigData := configs.GetConfig().AllConfigData()
+		if configVal, ok := allConfigData[configPrefix]; ok {
+
+			if !isEditAllowed(configPrefix) {
+				user.SendText(errValueLocked.Error())
+				user.ClearPrompt()
+				return true, nil
+			}
+
+			question := cmdPrompt.Ask(fmt.Sprintf(newValuePrompt, configPrefix), []string{fmt.Sprintf("%v", configVal)}, fmt.Sprintf("%v", configVal))
+			if !question.Done {
+				return true, nil
+			}
+
+			user.ClearPrompt()
+
+			err := configs.SetVal(configPrefix, question.Response)
+			if err == nil {
+				allConfigData := configs.GetConfig().AllConfigData()
+				user.SendText(``)
+				user.SendText(fmt.Sprintf(`<ansi fg="6">%s</ansi> has been set to: <ansi fg="9">%s<ansi>`, configPrefix, allConfigData[configPrefix]))
+				user.SendText(``)
+				return true, nil
+			}
+			user.SendText(err.Error())
+			return true, nil
+		}
+	}
+
+	question := cmdPrompt.Ask(`Choose a config option, or "quit":`, []string{``}, ``)
+	if !question.Done {
+		return true, nil
+	}
+
+	if question.Response == "quit" {
+		user.SendText("Quitting...")
+		user.ClearPrompt()
+		return true, nil
+	}
+
+	fullPath := strings.ToLower(configPrefix)
+	if fullPath != `` {
+		fullPath += "."
+	}
+	fullPath += question.Response
+
+	if !isEditAllowed(fullPath) {
+		user.SendText(errValueLocked.Error())
+		question.RejectResponse()
+		return true, nil
+	}
+
+	menuOptions, ok := getConfigOptions(fullPath)
+	if !ok {
+		question.RejectResponse()
+		menuOptions, _ = getConfigOptions("")
+		fullPath = strings.ToLower(configPrefix)
+	} else {
+
+		if len(menuOptions) == 1 {
+			fullPath = menuOptions[0].Id.(string)
+
+			cmdPrompt.Store("config-selected", fullPath)
+
+			if !isEditAllowed(fullPath) {
+				user.SendText(errValueLocked.Error())
+				user.ClearPrompt()
+				return true, nil
+			}
+
+			allConfigData := configs.GetConfig().AllConfigData()
+			if configVal, ok := allConfigData[fullPath]; ok {
+
+				cmdPrompt.Ask(fmt.Sprintf(newValuePrompt, fullPath), []string{fmt.Sprintf("%v", configVal)}, fmt.Sprintf("%v", configVal))
+				return true, nil
+			}
+		}
+
+		cmdPrompt.Store("config-selected", fullPath)
+	}
+
+	if fullPath != "" {
+		user.SendText(``)
+		user.SendText(`   [<ansi fg="6">` + fullPath + `</ansi>]`)
+	}
+
+	tplTxt, _ := templates.Process("tables/numbered-list", menuOptions, user.UserId)
+	user.SendText(tplTxt)
+
+	question.RejectResponse()
+
+	return true, nil
+}
+
+func isEditAllowed(configPath string) bool {
+
+	configPath = strings.ToLower(configPath)
+
+	if strings.HasSuffix(configPath, "locked") {
+		return false
+	}
+
+	sc := configs.GetServerConfig()
+	for _, v := range sc.Locked {
+		if strings.HasPrefix(configPath, strings.ToLower(v)) {
+			return false
+		}
+	}
+
+	return true
+}
+
+func getConfigOptions(input string) ([]templates.NameDescription, bool) {
+
+	input = strings.ToLower(input)
+
+	configOptions := []templates.NameDescription{}
+
+	allConfigData := configs.GetConfig().AllConfigData()
+	pathLookup := map[string]string{}
+	for name, _ := range allConfigData {
+
+		lowerName := strings.ToLower(name)
+		pathLookup[lowerName] = name
+
+		builtPath := ""
+		for _, namePart := range strings.Split(name, ".") {
+			builtPath += namePart
+			if _, ok := pathLookup[builtPath]; !ok {
+				pathLookup[strings.ToLower(builtPath)] = builtPath
+			}
+			builtPath += "."
+		}
+	}
+
+	inputProperCase := input
+	if caseCheck, ok := pathLookup[input]; ok {
+
+		inputProperCase = caseCheck
+
+		// Is this a full config path?
+		if configVal, ok := allConfigData[inputProperCase]; ok {
+
+			configOptions = append(configOptions, templates.NameDescription{
+				Id:          inputProperCase,
+				Name:        inputProperCase,
+				Description: fmt.Sprintf("%v", configVal),
+			})
+
+			return configOptions, true
+
+		}
+
+	} else if input != "" {
+		return configOptions, false
+	}
+
+	// Find which partial path we are on and populate options
+	usedNames := map[string]struct{}{}
+	for fullConfigPath, configVal := range allConfigData {
+
+		if input != "" {
+			if len(fullConfigPath) <= len(input) || fullConfigPath[0:len(inputProperCase)] != inputProperCase {
+				continue
+			}
+		}
+
+		nextConfigPathSection := fullConfigPath
+		if len(inputProperCase) > 0 {
+			nextConfigPathSection = nextConfigPathSection[len(inputProperCase)+1:]
+		}
+
+		desc := "..."
+		if dotIdx := strings.Index(nextConfigPathSection, "."); dotIdx != -1 {
+			nextConfigPathSection = nextConfigPathSection[:dotIdx]
+		} else {
+			desc = fmt.Sprintf("%v", configVal)
+		}
+
+		if _, ok := usedNames[nextConfigPathSection]; ok {
+			continue
+		}
+
+		usedNames[nextConfigPathSection] = struct{}{}
+
+		pathWithSection := nextConfigPathSection
+		if len(inputProperCase) > 0 {
+			pathWithSection = inputProperCase + "." + pathWithSection
+		}
+
+		configOptions = append(configOptions, templates.NameDescription{
+			Id:          pathWithSection,
+			Name:        nextConfigPathSection,
+			Description: desc,
+		})
+
+	}
+
+	if len(configOptions) > 0 {
+		sort.Slice(configOptions, func(i, j int) bool {
+			return configOptions[i].Name < configOptions[j].Name
+		})
+	}
+
+	return configOptions, true
+}