docs: clarify the resolved value for %VAR% (#2490)

Dockerfile

@@ -42,7 +42,7 @@ RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=1.9.1 --var app=mc-server-runner --file {{.app}} \
   --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_HELPER_VERSION=1.36.5
+ARG MC_HELPER_VERSION=1.36.9
 ARG MC_HELPER_BASE_URL=https://github.com/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION}
 # used for cache busting local copy of mc-image-helper
 ARG MC_HELPER_REV=1

docs/configuration/jvm-options.md

@@ -62,11 +62,30 @@ you can use
 
 ## Enable Remote JMX for Profiling
 
-To enable remote JMX, such as for profiling with VisualVM or JMC, add the environment variable `ENABLE_JMX=true`, set `JMX_HOST` to the IP/host running the Docker container, and add a port forwarding of TCP port 7091, such as:
+To enable remote JMX, such as for profiling with VisualVM or JMC, set the environment variable `ENABLE_JMX` to "true", set `JMX_HOST` to the IP/host running the Docker container, and add a port forwarding of TCP port 7091, such as:
 
-```
--e ENABLE_JMX=true -e JMX_HOST=$HOSTNAME -p 7091:7091
-```
+!!! example
+
+    With `docker run`
+
+    ```
+    -e ENABLE_JMX=true -e JMX_HOST=$HOSTNAME -p 7091:7091
+    ```
+
+If needing to map to a different port, then also set the environment variable `JMX_PORT` to the desired host port.
+
+!!! example
+
+    With a compose file:
+    
+    ```yaml
+    environment:
+      ENABLE_JMX: true
+      JMX_HOST: ${HOSTNAME}
+      JMX_PORT: "7092"
+    ports:
+      - "7092:7092"
+    ```
 
 ## Enable Aikar's Flags
 

docs/configuration/server-properties.md

@@ -4,6 +4,37 @@ If you prefer to manually manage the `server.properties` file, set `OVERRIDE_SER
 
 > NOTE: to clear a server property, set the variable to an empty string, such as `-e RESOURCE_PACK=""`. A variables that maps to a server property that is unset, is ignored and the existing `server.property` is left unchanged. 
 
+## Placeholders
+
+When declaring a server properties via container environment variables, those values may contain placeholders that are processed when the `server.properties` file is updated. 
+
+The syntax of placeholders is DOS-style, `%VAR%`, to avoid being processed by Docker or the shell and the following options are available:
+
+`%VAR%` or `%env:VAR%`
+
+: Replaced with the resolved value or the environment variable `VAR`
+
+`%date:FMT%`
+
+: Formats the current date/time with the given `FMT` string processed by [Java's DateTimeFormatter](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/format/DateTimeFormatter.html).
+
+Any declared or resolved environment variable may be referenced, such as `VERSION` and `TYPE`. Additionally, [Modrinth](../types-and-platforms/mod-platforms/modrinth-modpacks.md) and [Auto CurseForge](../types-and-platforms/mod-platforms/auto-curseforge.md) modpacks will expose the environment variables `MODPACK_NAME` and `MODPACK_VERSION`. The originally declared version, such as "LATEST" or "SNAPSHOT", is available in the variable `DECLARED_VERSION` 
+
+!!! example
+
+    As a compose file environment entry:
+
+    ```yaml
+        MOTD: Running %MODPACK_NAME% version %env:MODPACK_VERSION%
+        LEVEL: world-%date:yyyy-MM-dd%
+    ```
+
+!!! warning
+
+    Placeholders are not supported when manually managing `server.properties`
+
+## Properties
+
 ### Message of the Day
 
 The message of the day, shown below each server entry in the client UI, can be changed with the `MOTD` environment variable, such as
@@ -24,6 +55,10 @@ renders
 
 ![](../img/motd-example.png)
 
+!!! note "Escape unicode"
+
+    For Minecraft versions less than 1.20, unicode characters in `server.properties` will be escaped as `\uXXXX`, by default. That behavior can be altered by setting `SERVER_PROPERTIES_ESCAPE_UNICODE` to "true" or "false".
+
 To produce a multi-line MOTD, embed a newline character as `\n` in the string, such as
 
     -e MOTD="Line one\nLine two"

examples/k8s/using-statefulset.yml

@@ -19,6 +19,7 @@ spec:
       containers:
         - name: mc
           image: itzg/minecraft-server
+          imagePullPolicy: Always
           env:
             - name: EULA
               value: "TRUE"

files/cf-exclude-include.json

@@ -11,6 +11,7 @@
     "defensive-measures",
     "ding",
     "dynamiclights-reforged",
+    "embeddium",
     "enchantment-descriptions",
     "entity-texture-features-fabric",
     "entityculling",

scripts/start-configuration

@@ -113,7 +113,8 @@ fi
 
 cd /data || exit 1
 
-export ORIGINAL_TYPE=${TYPE^^}
+export DECLARED_TYPE=${TYPE^^}
+export DECLARED_VERSION="$VERSION"
 
 if isTrue "${ENABLE_AUTOPAUSE}"; then
   "${SCRIPTS:-/}start-autopause"

scripts/start-setupRbac

@@ -22,9 +22,6 @@ elif [[ -v OVERRIDE_WHITELIST ]] && isTrue "${OVERRIDE_WHITELIST}"; then
 fi
 
 sharedArgs=(--version="$VERSION")
-if isFalse "${ONLINE_MODE:-true}"; then
-  sharedArgs+=( --offline )
-fi
 
 if [[ -v OPS_FILE ]]; then
   existing="$EXISTING_OPS_FILE"

scripts/start-setupServerProperties

@@ -25,6 +25,7 @@ function customizeServerProps {
   # normalize MOTD
   if [[ ${TYPE^^} = LIMBO ]]; then
     if [[ $MOTD ]] && ! [[ $MOTD =~ ^{ ]]; then
+      # shellcheck disable=SC2089
       MOTD="{\"text\":\"${MOTD}\"}"
     fi
   fi
@@ -114,7 +115,15 @@ function customizeServerProps {
   if [[ -v CUSTOM_SERVER_PROPERTIES ]]; then
     setPropertiesArgs+=(--custom-properties "$CUSTOM_SERVER_PROPERTIES")
   fi
+  if [[ -v SERVER_PROPERTIES_ESCAPE_UNICODE ]]; then
+    if isTrue "$SERVER_PROPERTIES_ESCAPE_UNICODE"; then
+      setPropertiesArgs+=(--escape-unicode)
+    fi
+  elif versionLessThan '1.20'; then
+    setPropertiesArgs+=(--escape-unicode)
+  fi
 
+  handleDebugMode
   if ! mc-image-helper set-properties "${setPropertiesArgs[@]}" "$SERVER_PROPERTIES"; then
     log "ERROR: failed to update server.properties"
     exit 1
@@ -136,10 +145,10 @@ if ! isTrue "${SKIP_SERVER_PROPERTIES}"; then
     # which shows up in the server listing in the client
     if ! [ -v MOTD ]; then
       # snapshot is the odd case where we have to look at version to identify that label
-      if [[ ${ORIGINAL_TYPE} == "VANILLA" && ${VERSION} == "SNAPSHOT" ]]; then
+      if [[ ${DECLARED_TYPE} == "VANILLA" && ${VERSION} == "SNAPSHOT" ]]; then
         label=SNAPSHOT
       else
-        label=${ORIGINAL_TYPE}
+        label=${DECLARED_TYPE}
       fi
 
       # Convert label to title-case