Changes in scripts/usr/local/lib/7dtd/serverconfig.sh [20:24]

File:

• scripts/usr/local/lib/7dtd/serverconfig.sh (modified) (11 diffs)

scripts/usr/local/lib/7dtd/serverconfig.sh

@@ -1 +1 @@
 #!/bin/bash
-# Version 5
 
 # Provides functions to query and validate values for serverconfig.xml
+
+#################################
+## Definition of options
 
 serverconfig_ServerPort_QueryName() {
@@ -684 +686 @@
 
 
-############
+#################################
+## Edit option functions
+
+configEditServer() {
+        local CV
+        
+        echo "Server"
+        echo "--------------------------------"
+        for CV in \
+                        ServerName ServerPassword ServerIsPublic ServerPort ServerMaxPlayerCount \
+                        DisableNAT \
+                        ; do
+                $1 $CV
+        done
+        echo
+}
+
+configEditRemoteControl() {
+        local CV
+        
+        echo "Remote control"
+        echo "--------------------------------"
+        for CV in \
+                        ControlPanelEnabled ControlPanelPort ControlPanelPassword \
+                        TelnetPort TelnetPassword \
+                        ; do
+                if [ "$CV" = "TelnetPort" ]; then
+                        echo
+                        echo "NOTE: Telnet will always be enabled for management purposes!"
+                        echo "Make sure you block external access to this port!"
+                        echo
+                fi
+                $1 $CV
+        done
+        echo
+}
+
+configEditGameType() {
+        local CV
+        
+        echo "Game type"
+        echo "--------------------------------"
+        for CV in \
+                        GameName GameWorld GameMode \
+                        ; do
+                $1 $CV
+        done
+        echo
+}
+
+configEditGameTypeSpecific() {
+        local CV
+        
+        echo "Options for specific game types"
+        echo "--------------------------------"
+        for CV in \
+                        DayCount FragLimit MatchLength RebuildMap \
+                        ; do
+                $1 $CV
+        done
+        echo
+}
+
+configEditGeneric() {
+        local CV
+        
+        echo "Generic options"
+        echo "--------------------------------"
+        for CV in \
+                        ShowAllPlayersOnMap FriendlyFire BuildCreate \
+                        BlockDurabilityModifier \
+                        ; do
+                $1 $CV
+        done
+        echo
+}
+
+configEditDropLoot() {
+        local CV
+        
+        echo "Drop and Loot"
+        echo "--------------------------------"
+        for CV in \
+                        DropOnDeath DropOnQuit \
+                        LootAbundance LootRespawnDays AirDropFrequency \
+                        ; do
+                $1 $CV
+        done
+        echo
+}
+
+configEditTimes() {
+        local CV
+        
+        echo "Times / Durations"
+        echo "--------------------------------"
+        for CV in \
+                        CraftTimer LootTimer \
+                        DayNightLength NightPercentage \
+                        ; do
+                $1 $CV
+        done
+        echo
+}
+
+configEditDifficulty() {
+        local CV
+        
+        echo "Difficulty"
+        echo "--------------------------------"
+        for CV in \
+                        GameDifficulty ZombiesRun \
+                        PlayerDamageGiven PlayerDamageRecieved EnemySenseMemory EnemySpawnMode EnemyDifficulty \
+                        ; do
+                $1 $CV
+        done
+        echo
+}
+
+configEditLandClaim() {
+        local CV
+        
+        echo "Land claim options"
+        echo "--------------------------------"
+        for CV in \
+                        LandClaimSize LandClaimDeadZone LandClaimExpiryTime LandClaimDecayMode \
+                        LandClaimOnlineDurabilityModifier LandClaimOfflineDurabilityModifier \
+                        ; do
+                $1 $CV
+        done
+        echo
+}
+
+configEditAll() {
+        configEditServer "$1"
+        configEditRemoteControl "$1"
+        configEditGameType "$1"
+        configEditGameTypeSpecific "$1"
+        configEditGeneric "$1"
+        configEditDropLoot "$1"
+        configEditTimes "$1"
+        configEditDifficulty "$1"
+        configEditLandClaim "$1"
+}
+
+
+
+
+
+#################################
+## Generic worker functions
+
+
+# List all defined config editing parts
+# Returns:
+#   List of config funcs
+listConfigEditFuncs() {
+        local CV
+        for CV in $(declare -F | cut -d\  -f3 | grep "^configEdit.*$"); do
+                CV=${CV#configEdit}
+                printf "%s " "$CV"
+        done
+}
+
+
+# List all defined config options
+# Returns:
+#   List of defined config options
 listConfigValues() {
         local CV
@@ -695 +864 @@
 
 
-#  1: Option name
-#  2: Value
+# Validate the given value for the given option
+# Params:
+#   1: Option name
+#   2: Value
+# Returns:
+#   0/1: invalid/valid
 isValidOptionValue() {
         local TYPE=$(serverconfig_$1_Type)
@@ -747 +920 @@
 }
 
-#  1: Option name
-#  2: Target variable
+# Query for the value of a single config option
+# Will be stored in $configCurrent_$1
+# Params:
+#   1: Option name
 configQueryValue() {
         local TYPE=$(serverconfig_$1_Type)
@@ -806 +981 @@
         fi
         prompt=$(printf "%s:" "$prompt")
-        prompt=$(printf "%-*s " 35 "$prompt")
+        prompt=$(printf "%-*s " 40 "$prompt")
 
         while : ; do
@@ -822 +997 @@
                 export $currentValName="${config_allowed_values[$currentValName-1]}"
         fi
-}
-
+        echo
+}
+
+# Set parameters for current instance that have forced values:
+#  - TelnetEnabled must be set so that management scripts can work
+#  - AdminFileName is made to point to the local instance admins.xml
+#  - SaveGameFolder is made to point to the instance folder
+# Params:
 #   1: Instance name
 configSetAutoParameters() {
@@ -831 +1012 @@
 }
 
-configEditAll() {
-        local CV
-        for CV in \
-                        ServerName ServerPort ServerIsPublic ServerPassword ServerMaxPlayerCount \
-                        DisableNAT \
-                        ControlPanelEnabled ControlPanelPort ControlPanelPassword \
-                        TelnetPort TelnetPassword \
-                        GameWorld GameName GameMode \
-                        ShowAllPlayersOnMap FriendlyFire BuildCreate \
-                        DayCount FragLimit MatchLength RebuildMap \
-                        DropOnDeath DropOnQuit \
-                        LootAbundance LootRespawnDays AirDropFrequency \
-                        CraftTimer LootTimer \
-                        DayNightLength NightPercentage \
-                        GameDifficulty ZombiesRun \
-                        PlayerDamageGiven PlayerDamageRecieved EnemySenseMemory EnemySpawnMode EnemyDifficulty \
-                        BlockDurabilityModifier \
-                        LandClaimSize LandClaimDeadZone LandClaimExpiryTime LandClaimDecayMode \
-                        LandClaimOnlineDurabilityModifier LandClaimOfflineDurabilityModifier \
-                        ; do
-                configQueryValue $CV
-                echo
-        done
-}
-
-printCurrentConfig() {
-        local CV
-        for CV in $(listConfigValues); do
-                local currentValName=configCurrent_$CV
-                printf "%-20s = %s\n" "$CV" "${!currentValName}"
-        done
-}
-
+
+# Print defined config value
+# Params:
+#   1: Config option
+printConfigValue() {
+        local currentValName=configCurrent_$1
+        printf "%-25s = %s\n" "$(serverconfig_$1_QueryName)" "${!currentValName}"
+}
+
+# Query for an instance name (will be saved in $INSTANCE)
 readInstanceName() {
         until [ $(isValidInstanceName "$INSTANCE") -eq 1 ]; do
@@ -877 +1035 @@
 }
 
+# Undefine the current config values
 unsetAllConfigValues() {
         local CV
@@ -885 +1044 @@
 }
 
+# Load all config values from the config.xml of the given instance
+# Params:
 #   1: Instance name
 loadCurrentConfigValues() {
@@ -899 +1060 @@
 }
 
+# Save all config values to the config.xml of the given instance
+# Params:
 #   1: Instance name
 saveCurrentConfigValues() {
@@ -923 +1086 @@
 }
 
+# Check if the config template exists
+# Returns:
+#   0/1: no/yes
 configTemplateExists() {
         if [ -f $SDTD_BASE/templates/config.xml ]; then