Update to 1.22.0 and improve server management with graceful shutdown, vs-cli utility for sending commands

Author: PepeCitron

Dockerfile

@@ -1,24 +1,25 @@
-FROM mcr.microsoft.com/dotnet/runtime:8.0
+FROM mcr.microsoft.com/dotnet/runtime:10.0
 
 # Env var
 ENV SERVER_BRANCH="stable" \
-    SERVER_VERSION="1.21.1" \
+    SERVER_VERSION="1.22.0" \
     SERVER_PORT="42420" \
     WORLDCONFIG_PROPICK_NODE_SEARCH_RADIUS="6" \
     UID="1000" \
     GID="1000"
 
 # Install dependencies
 RUN apt-get update && \
-    apt-get install --no-install-recommends -y wget netcat-traditional jq moreutils && \
+    apt-get install --no-install-recommends -y wget netcat-traditional jq moreutils screen && \
     apt-get clean autoclean && \
     apt-get autoremove -y && \
     rm -rf /var/lib/apt/lists/* && \
     mkdir /data && mkdir /data/server-file && \
     touch /data/server-file/.version
 
 # Add User
-RUN useradd -u $UID -U -m -s /bin/false vintagestory && usermod -G users vintagestory && \
+RUN userdel -r ubuntu 2>/dev/null || true && groupdel ubuntu 2>/dev/null || true && \
+    useradd -u $UID -U -m -s /bin/false vintagestory && usermod -G users vintagestory && \
     chown -R vintagestory:vintagestory /data
 
 # Expose ports
@@ -27,9 +28,15 @@ EXPOSE 42420
 # Healthcheck
 HEALTHCHECK --start-period=1m --interval=5s CMD nc -z  127.0.0.1 $SERVER_PORT
 
+STOPSIGNAL SIGTERM
+
 VOLUME ["/data/server-file"]
 
 COPY serverconfig.json /data/default-serverconfig.json
 
 COPY entry.sh /data/scripts/entry.sh
+
+COPY vs-cli.sh /usr/local/bin/vs-cli
+RUN chmod +x /usr/local/bin/vs-cli
+
 CMD ["bash", "/data/scripts/entry.sh"]

entry.sh

@@ -1,5 +1,13 @@
 #!/bin/sh
 
+# Graceful stop function
+graceful_stop() {
+  echo "Stopping server..."
+  su vintagestory -s /bin/sh -p -c "screen -S vsserver -X stuff '/stop\n'"
+  wait $SERVER_PID
+  exit 0
+}
+
 # Ensure User and Group IDs
 if [ ! "$(id -u vintagestory)" -eq "$UID" ]; then usermod -o -u "$UID" vintagestory ; fi
 if [ ! "$(id -g vintagestory)" -eq "$GID" ]; then groupmod -o -g "$GID" vintagestory ; fi
@@ -122,7 +130,22 @@ if [ -n "$WORLDCONFIG_ALLOW_LAND_CLAIMING" ]; then jq '.WorldConfig.WorldConfigu
 if [ -n "$WORLDCONFIG_CLASS_EXCLUSIVE_RECIPES" ]; then jq '.WorldConfig.WorldConfiguration.classExclusiveRecipes = ($val | test("true"))' --arg val "$WORLDCONFIG_CLASS_EXCLUSIVE_RECIPES" $serverconfig | sponge $serverconfig ; fi
 if [ -n "$WORLDCONFIG_AUCTION_HOUSE" ]; then jq '.WorldConfig.WorldConfiguration.auctionHouse = ($val | test("true"))' --arg val "$WORLDCONFIG_AUCTION_HOUSE" $serverconfig | sponge $serverconfig ; fi
 
+# FIFO pipe
+mkfifo /tmp/vsserver-log
+chmod 666 /tmp/vsserver-log
+
+# Trap signal
+trap graceful_stop SIGTERM
+
 # Start server
 echo "Launching server..."
 cd /data
-su vintagestory -s /bin/sh -p -c "dotnet VintagestoryServer.dll --dataPath /data/server-file"
+
+su vintagestory -s /bin/sh -p -c '
+  cat /tmp/vsserver-log &
+  screen -DmS vsserver sh -c "dotnet VintagestoryServer.dll --dataPath /data/server-file | tee /tmp/vsserver-log"
+' &
+
+SERVER_PID=$!
+
+wait $SERVER_PID

readme.md

@@ -127,12 +127,9 @@ services:
 
 # Help
 
-## Server console
+## Send command to the server console
 
-You need `stdin_open` and `tty` to true in docker compose file.
+To send a command to the server, you need to use vs-cli with docker exec
 
-To interact with the console, you need to attach to the container, replace <container_name> with your container name.
+```docker exec <container_name> vs-cli "<cmd>"```
 
-```docker attach <container_name>```
-
-Use Control-p Control-q to detach.

serverconfig.json

@@ -1,16 +1,20 @@
 {
   "FileEditWarning": "",
-  "ConfigVersion": "1.7",
+  "ConfigVersion": "1.10",
   "ServerName": "Vintage Story Server",
   "ServerUrl": null,
   "ServerDescription": null,
   "WelcomeMessage": "Welcome {0}, may you survive well and prosper",
   "Ip": null,
   "Port": 42420,
   "Upnp": false,
+  "UpnpInfiniteLifetime": false,
   "CompressPackets": true,
   "AdvertiseServer": true,
   "MaxClients": 16,
+  "MaxClientsInQueue": 0,
+  "WarnClientsAfterAfkSeconds": 0,
+  "KickClientsAfterAfkSeconds": 0,
   "PassTimeWhenEmpty": false,
   "MasterserverUrl": "http://masterserver.vintagestory.at/api/v1/servers/",
   "ModDbUrl": "https://mods.vintagestory.at/",
@@ -23,8 +27,8 @@
   "ServerLanguage": "en",
   "MaxChunkRadius": 12,
   "TickTime": 33.333332,
-  "SpawnCapPlayerScaling": 0.75,
-  "BlockTickChunkRange": 4,
+  "SpawnCapPlayerScaling": 0.5,
+  "BlockTickChunkRange": 5,
   "MaxMainThreadBlockTicks": 10000,
   "RandomBlockTicksPerChunk": 16,
   "BlockTickInterval": 300,
@@ -201,12 +205,13 @@
       "Code": "sumod",
       "PrivilegeLevel": 200,
       "Name": "Survival Moderator",
-      "Description": "Can use/place/break blocks everywhere (priv level 200), create/manage player groups, chat, kick/ban players and do serverwide announcements. Can claim an area of up to 4 chunks.",
+      "Description": "Can use/place/break blocks everywhere (priv level 200), create/manage own/other player groups, chat, kick/ban players and do serverwide announcements. Can claim an area of up to 4 chunks.",
       "DefaultSpawn": null,
       "ForcedSpawn": null,
       "Privileges": [
         "controlplayergroups",
         "manageplayergroups",
+        "manageotherplayergroups",
         "chat",
         "areamodify",
         "build",
@@ -237,12 +242,13 @@
       "Code": "crmod",
       "PrivilegeLevel": 500,
       "Name": "Creative Moderator",
-      "Description": "Can use/place/break blocks everywhere (priv level 500), create/manage player groups, chat, kick/ban players, fly and set his own or other players game modes (= allows fly and change of move speed). Can claim an area of up to 40 chunks.",
+      "Description": "Can use/place/break blocks everywhere (priv level 500), create/manage own/other player groups, chat, kick/ban players, fly and set his own or other players game modes (= allows fly and change of move speed). Can claim an area of up to 40 chunks.",
       "DefaultSpawn": null,
       "ForcedSpawn": null,
       "Privileges": [
         "controlplayergroups",
         "manageplayergroups",
+        "manageotherplayergroups",
         "chat",
         "areamodify",
         "build",
@@ -308,6 +314,7 @@
         "controlplayergroups",
         "manageplayergroups",
         "selfkill",
+        "manageotherplayergroups",
         "worldedit"
       ],
       "RuntimePrivileges": [],
@@ -330,30 +337,34 @@
   ],
   "AntiAbuse": 0,
   "WorldConfig": {
-    "Seed": "",
+    "Seed": null,
     "SaveFileLocation": "/data/server-file/Saves/default.vcdbs",
     "WorldName": "A new world",
     "AllowCreativeMode": true,
     "PlayStyle": "surviveandbuild",
-    "PlayStyleLangCode": "preset-surviveandbuild",
+    "PlayStyleLangCode": "surviveandbuild-bands",
     "WorldType": "standard",
-    "WorldConfiguration": null,
-    "MapSizeY": 256,
-    "CreatedByPlayerName": "",
-    "DisabledMods": [],
+    "WorldConfiguration": {
+      "propickNodeSearchRadius": "6"
+    },
+    "MapSizeY": null,
+    "CreatedByPlayerName": null,
+    "DisabledMods": null,
     "RepairMode": false
   },
   "NextPlayerGroupUid": 10,
   "GroupChatHistorySize": 20,
   "MaxOwnedGroupChannelsPerUser": 10,
   "OnlyWhitelisted": false,
+  "WhitelistMode": 1,
   "VerifyPlayerAuth": true,
   "DefaultSpawn": null,
   "AllowPvP": true,
   "AllowFireSpread": true,
   "AllowFallingBlocks": true,
   "HostedMode": false,
   "HostedModeAllowMods": false,
+  "VhIdentifier": null,
   "StartupCommands": null,
   "RepairMode": false,
   "AnalyzeMode": false,
@@ -362,8 +373,13 @@
   "ChatRateLimitMs": 1000,
   "DieBelowDiskSpaceMb": 400,
   "ModIdBlackList": null,
+  "ModIdWhiteList": null,
   "LogBlockBreakPlace": false,
   "LogFileSplitAfterLine": 500000,
   "DieAboveErrorCount": 100000,
+  "LoginFloodProtection": false,
+  "TemporaryIpBlockList": false,
+  "DisableModSafetyCheck": false,
+  "DisableAutoRemap": false,
   "DieAboveMemoryUsageMb": 50000
 }

vs-cli.sh

@@ -0,0 +1,7 @@
+#!/bin/sh
+if [ -z "$1" ]; then
+  echo "Usage: $0 <command>"
+  exit 1
+fi
+
+su vintagestory -s /bin/sh -c "screen -S vsserver -X stuff \"$(printf '%s' "$1")\n\""