chore(docs): note add mod var for auto_curseforge use (#3111)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.github/workflows/build-multiarch.yml

@@ -11,6 +11,7 @@ on:
       - "docs/**"
       - "examples/**"
       - "notes/**"
+      - "kustomize/**"
 
 jobs:
   build:
@@ -21,16 +22,15 @@ jobs:
         variant:
           - java21-graalvm
           - java21
+          - java21-jdk
           - java21-alpine
           - java17
           - java17-graalvm
-          - java17-jdk
           - java17-alpine
           - java8
           - java8-graalvm-ce
           - java8-openj9
           - java8-jdk
-          - java8-alpine
           - java11
         include:
         # JAVA 21:
@@ -42,6 +42,10 @@ jobs:
             baseImage: eclipse-temurin:21-jre
             platforms: linux/amd64,linux/arm64
             mcVersion: latest
+          - variant: java21-jdk
+            baseImage: eclipse-temurin:21
+            platforms: linux/amd64,linux/arm64
+            mcVersion: latest
           - variant: java21-alpine
             baseImage: eclipse-temurin:21-jre-alpine
             platforms: linux/amd64,linux/arm64
@@ -56,10 +60,6 @@ jobs:
             baseImage: container-registry.oracle.com/graalvm/jdk:17-ol8
             platforms: linux/amd64,linux/arm64
             mcVersion: 1.20.4
-          - variant: java17-jdk
-            baseImage: eclipse-temurin:17-focal
-            platforms: linux/amd64,linux/arm/v7,linux/arm64
-            mcVersion: 1.20.4
           - variant: java17-alpine
             baseImage: eclipse-temurin:17-jre-alpine
             platforms: linux/amd64
@@ -74,10 +74,6 @@ jobs:
             baseImage: eclipse-temurin:8u312-b07-jre-focal
             platforms: linux/amd64,linux/arm/v7,linux/arm64
             mcVersion: 1.12.2
-          - variant: java8-alpine
-            baseImage: openjdk:8-jre-alpine3.9
-            platforms: linux/amd64
-            mcVersion: 1.12.2
           - variant: java8-graalvm-ce
             baseImage: ghcr.io/graalvm/graalvm-ce:java8
             platforms: linux/amd64
@@ -97,7 +93,7 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.1.6
+        uses: actions/checkout@v4.2.1
         with:
           # for build-files step
           fetch-depth: 0
@@ -132,13 +128,13 @@ jobs:
             org.opencontainers.image.authors=Geoff Bourne <itzgeoff@gmail.com>
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v3.3.0
+        uses: docker/setup-buildx-action@v3.7.1
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3.0.0
+        uses: docker/setup-qemu-action@v3.2.0
 
       - name: Build for test
-        uses: docker/build-push-action@v5.3.0
+        uses: docker/build-push-action@v6.9.0
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -161,14 +157,14 @@ jobs:
           tests/test.sh
 
       - name: Login to DockerHub
-        uses: docker/login-action@v3.1.0
+        uses: docker/login-action@v3.3.0
         if: env.HAS_IMAGE_REPO_ACCESS
         with:
           username: ${{ secrets.DOCKER_USER }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
       - name: Login to GHCR
-        uses: docker/login-action@v3.1.0
+        uses: docker/login-action@v3.3.0
         if: env.HAS_IMAGE_REPO_ACCESS
         with:
           registry: ghcr.io
@@ -176,7 +172,7 @@ jobs:
           password: ${{ github.token }}
 
       - name: Build and push
-        uses: docker/build-push-action@v5.3.0
+        uses: docker/build-push-action@v6.9.0
         if: github.actor == github.repository_owner
         with:
           platforms: ${{ matrix.platforms }}

.github/workflows/discord.yml

@@ -19,7 +19,7 @@ jobs:
     steps:
       - name: on-publish
         if: github.event_name == 'release' && github.event.action == 'published'
-        uses: SethCohen/github-releases-to-discord@v1.15.0
+        uses: SethCohen/github-releases-to-discord@v1.15.1
         with:
           webhook_url: ${{ secrets.DISCORD_WEBHOOK }}
       - name: on-success

.github/workflows/verify-pr.yml

@@ -8,6 +8,7 @@ on:
       - "docs/**"
       - "examples/**"
       - "notes/**"
+      - "kustomize/**"
       - "docker-compose*.yml"
       - "mkdocs.yml"
 
@@ -46,16 +47,16 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v4.1.6
+        uses: actions/checkout@v4.2.1
         with:
           # for build-files step
           fetch-depth: 0
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v3.3.0
+        uses: docker/setup-buildx-action@v3.7.1
 
       - name: Confirm multi-arch build
-        uses: docker/build-push-action@v5.3.0
+        uses: docker/build-push-action@v6.9.0
         with:
           platforms: ${{ matrix.platforms }}
           # ensure latest base image is used
@@ -65,7 +66,7 @@ jobs:
           cache-from: type=gha,scope=${{ matrix.variant }}
 
       - name: Build for test
-        uses: docker/build-push-action@v5.3.0
+        uses: docker/build-push-action@v6.9.0
         with:
           # Only build single platform since loading multi-arch image into daemon fails with
           # "docker exporter does not currently support exporting manifest lists"

Dockerfile

@@ -1,5 +1,3 @@
-# syntax = docker/dockerfile:1.3
-
 ARG BASE_IMAGE=eclipse-temurin:21-jre
 FROM ${BASE_IMAGE}
 
@@ -9,9 +7,14 @@ ARG TARGETOS
 ARG TARGETARCH
 ARG TARGETVARIANT
 
+# The following three arg/env vars get used by the platform specific "install-packages" script
+ARG EXTRA_DEB_PACKAGES=""
+ARG EXTRA_DNF_PACKAGES=""
+ARG EXTRA_ALPINE_PACKAGES=""
 ARG FORCE_INSTALL_PACKAGES=1
 RUN --mount=target=/build,source=build \
-    TARGET=${TARGETARCH}${TARGETVARIANT} /build/run.sh install-packages
+    TARGET=${TARGETARCH}${TARGETVARIANT} \
+    /build/run.sh install-packages
 
 RUN --mount=target=/build,source=build \
     /build/run.sh setup-user
@@ -23,31 +26,31 @@ EXPOSE 25565
 ARG APPS_REV=1
 ARG GITHUB_BASEURL=https://github.com
 
-ARG EASY_ADD_VERSION=0.8.5
+ARG EASY_ADD_VERSION=0.8.8
 ADD ${GITHUB_BASEURL}/itzg/easy-add/releases/download/${EASY_ADD_VERSION}/easy-add_${TARGETOS}_${TARGETARCH}${TARGETVARIANT} /usr/bin/easy-add
 RUN chmod +x /usr/bin/easy-add
 
-ARG RESTIFY_VERSION=1.7.2
+ARG RESTIFY_VERSION=1.7.5
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${RESTIFY_VERSION} --var app=restify --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG RCON_CLI_VERSION=1.6.6
+ARG RCON_CLI_VERSION=1.6.9
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${RCON_CLI_VERSION} --var app=rcon-cli --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_MONITOR_VERSION=0.12.11
+ARG MC_MONITOR_VERSION=0.14.1
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${MC_MONITOR_VERSION} --var app=mc-monitor --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_SERVER_RUNNER_VERSION=1.12.1
+ARG MC_SERVER_RUNNER_VERSION=1.12.3
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${MC_SERVER_RUNNER_VERSION} --var app=mc-server-runner --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_HELPER_VERSION=1.38.15
+ARG MC_HELPER_VERSION=1.40.2
 ARG MC_HELPER_BASE_URL=${GITHUB_BASEURL}/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION}
 # used for cache busting local copy of mc-image-helper
 ARG MC_HELPER_REV=1
@@ -74,4 +77,4 @@ RUN curl -fsSL -o /image/Log4jPatcher.jar https://github.com/CreeperHost/Log4jPa
 RUN dos2unix /start* /auto/*
 
 ENTRYPOINT [ "/start" ]
-HEALTHCHECK --start-period=1m --interval=5s --retries=24 CMD mc-health
+HEALTHCHECK --start-period=2m --retries=2 --interval=30s CMD mc-health

bin/mc-health

@@ -13,6 +13,6 @@ elif isTrue "${ENABLE_AUTOPAUSE}" && [[ "$( ps -ax -o stat,comm | grep 'java' |
   echo "Java process suspended by Autopause function"
   exit 0
 else
-  mc-monitor status "${MC_HEALTH_EXTRA_ARGS[@]}" --host localhost --port "${SERVER_PORT:-25565}"
+  mc-monitor status "${MC_HEALTH_EXTRA_ARGS[@]}" --host "${SERVER_HOST:-localhost}" --port "${SERVER_PORT:-25565}"
   exit $?
 fi

bin/mc-send-to-console

@@ -17,7 +17,7 @@ if [ ! -p "${CONSOLE_IN_NAMED_PIPE}" ]; then
   exit 1
 fi
 
-if [ "$(id -u)" = 0 ]; then
+if [ "$(id -u)" = 0 -a $UID != 0 ]; then
   if [[ $(getDistro) == alpine ]]; then
     exec su-exec minecraft bash -c "echo '$*' > '${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}'"
   else

bin/rcon-cmds-daemon.sh

@@ -44,7 +44,7 @@ do
       if [[ "$RCON_CMDS_STARTUP" ]]; then
         while read -r cmd; do
           run_command "$cmd"
-        done <<< "$RCON_CMDS_STARTUP"
+        done <<< "$(echo -e "$RCON_CMDS_STARTUP")"
       fi
       if 
         [[ -z "$RCON_CMDS_ON_CONNECT" ]] && 
@@ -66,7 +66,7 @@ do
         logRcon "First Clients has Connected, running first connect cmds"
         while read -r cmd; do
           run_command "$cmd"
-        done <<< "$RCON_CMDS_FIRST_CONNECT"
+        done <<< "$(echo -e "$RCON_CMDS_FIRST_CONNECT")"
     fi
 
     # When a client joins
@@ -74,13 +74,13 @@ do
         logRcon "Clients have Connected, running connect cmds"
         while read -r cmd; do
           run_command "$cmd"
-        done <<< "$RCON_CMDS_ON_CONNECT"
+        done <<< "$(echo -e "$RCON_CMDS_ON_CONNECT")"
     # When a client leaves
     elif (( CURR_CLIENTCONNECTIONS < CLIENTCONNECTIONS )) && [[ "$RCON_CMDS_ON_DISCONNECT" ]]; then
         logRcon "Clients have Disconnected, running disconnect cmds"
         while read -r cmd; do
           run_command "$cmd"
-        done <<< "$RCON_CMDS_ON_DISCONNECT"
+        done <<< "$(echo -e "$RCON_CMDS_ON_DISCONNECT")"
     fi
 
     # Last client connection
@@ -89,7 +89,7 @@ do
         logRcon "ALL Clients have Disconnected, running last disconnect cmds"
         while read -r cmd; do
           run_command "$cmd"
-        done <<< "$RCON_CMDS_LAST_DISCONNECT"
+        done <<< "$(echo -e "$RCON_CMDS_LAST_DISCONNECT")"
     fi
     CLIENTCONNECTIONS=$CURR_CLIENTCONNECTIONS
     ;;

build/alpine/install-packages.sh

@@ -3,6 +3,8 @@
 set -e
 set -o pipefail
 
+# Install necessary packages
+# shellcheck disable=SC2086
 apk add --no-cache -U \
     openssl \
     imagemagick \
@@ -14,7 +16,8 @@ apk add --no-cache -U \
     procps \
     shadow \
     bash \
-    curl iputils \
+    curl \
+    iputils \
     git \
     jq \
     mysql-client \
@@ -27,13 +30,18 @@ apk add --no-cache -U \
     nfs-utils \
     libpcap \
     libwebp \
-    libcap
+    libcap \
+    ${EXTRA_ALPINE_PACKAGES}
 
-# Patched knockd
+# Download and install patched knockd
 curl -fsSL -o /tmp/knock.tar.gz https://github.com/Metalcape/knock/releases/download/0.8.1/knock-0.8.1-alpine-amd64.tar.gz
 tar -xf /tmp/knock.tar.gz -C /usr/local/ && rm /tmp/knock.tar.gz
 ln -s /usr/local/sbin/knockd /usr/sbin/knockd
 setcap cap_net_raw=ep /usr/local/sbin/knockd
 
-# Set git credentials
-echo -e "[user]\n       name = Minecraft Server on Docker\n     email = server@example.com" >> /etc/gitconfig
+# Set Git credentials globally
+cat <<EOF >> /etc/gitconfig
+[user]
+	name = Minecraft Server on Docker
+	email = server@example.com
+EOF

build/ol/install-gosu.sh

@@ -1,12 +1,22 @@
 #!/bin/bash
 
-if [[ $(uname -m) == "aarch64" ]]; then 
-    curl -sL -o /bin/gosu https://github.com/tianon/gosu/releases/download/1.16/gosu-arm64
-    chmod +x /bin/gosu
-elif [[ $(uname -m) == "x86_64" ]]; then 
-    curl -sL -o /bin/gosu https://github.com/tianon/gosu/releases/download/1.16/gosu-amd64
-    chmod +x /bin/gosu
-else
-    echo "Not supported!"
-    exit 1
-fi  
+set -euo pipefail
+
+GOSU_VERSION="1.16"
+GOSU_BASE_URL="https://github.com/tianon/gosu/releases/download/$GOSU_VERSION"
+
+case $(uname -m) in
+    "aarch64")
+        GOSU_ARCH="gosu-arm64"
+        ;;
+    "x86_64")
+        GOSU_ARCH="gosu-amd64"
+        ;;
+    *)
+        echo "Architecture not supported!"
+        exit 1
+        ;;
+esac
+
+curl -sL -o /bin/gosu "${GOSU_BASE_URL}/${GOSU_ARCH}"
+chmod +x /bin/gosu

build/ol/install-packages.sh

@@ -4,20 +4,26 @@ export TARGET
 
 set -euo pipefail
 
+# Install and configure dnf
 microdnf install dnf -y
-
 dnf install 'dnf-command(config-manager)' -y
 dnf config-manager --set-enabled ol8_codeready_builder
-tee /etc/yum.repos.d/ol8-epel.repo<<EOF
+
+# Add EPEL repository
+tee /etc/yum.repos.d/ol8-epel.repo <<EOF
 [ol8_developer_EPEL]
-name= Oracle Linux \$releasever EPEL (\$basearch)
+name=Oracle Linux \$releasever EPEL (\$basearch)
 baseurl=https://yum.oracle.com/repo/OracleLinux/OL8/developer/EPEL/\$basearch/
 gpgkey=file:///etc/pki/rpm-gpg/RPM-GPG-KEY-oracle
 gpgcheck=1
 enabled=1
 EOF
+
+# Update system
 dnf update -y
 
+# Install necessary packages
+# shellcheck disable=SC2086
 dnf install -y \
   ImageMagick \
   file \
@@ -26,7 +32,6 @@ dnf install -y \
   iputils \
   curl \
   git \
-  git-lfs \
   jq \
   dos2unix \
   mysql \
@@ -40,20 +45,29 @@ dnf install -y \
   libpcap \
   libwebp \
   findutils \
-  which
+  which \
+  ${EXTRA_DNF_PACKAGES}
 
+# Install Git LFS
 curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.rpm.sh | sudo bash
 dnf update -y
-dnf install -y \
-  git-lfs
+dnf install -y git-lfs
 
+# Clean up DNF when done
+dnf clean all
+
+# Install gosu (assuming the script /build/ol/install-gosu.sh exists and is executable)
 bash /build/ol/install-gosu.sh
 
-# Patched knockd
+# Download and install patched knockd
 curl -fsSL -o /tmp/knock.tar.gz https://github.com/Metalcape/knock/releases/download/0.8.1/knock-0.8.1-$TARGET.tar.gz
 tar -xf /tmp/knock.tar.gz -C /usr/local/ && rm /tmp/knock.tar.gz
 ln -s /usr/local/sbin/knockd /usr/sbin/knockd
 setcap cap_net_raw=ep /usr/local/sbin/knockd
 
-# Set git credentials
-echo -e "[user]\n       name = Minecraft Server on Docker\n     email = server@example.com" >> /etc/gitconfig
+# Set git credentials globally
+cat <<EOF >> /etc/gitconfig
+[user]
+	name = Minecraft Server on Docker
+	email = server@example.com
+EOF

build/ubuntu/install-packages.sh

@@ -4,8 +4,9 @@ export TARGET
 
 set -euo pipefail
 
+# Update and install packages
 apt-get update
-
+# shellcheck disable=SC2086
 DEBIAN_FRONTEND=noninteractive \
 apt-get install -y \
   imagemagick \
@@ -27,21 +28,26 @@ apt-get install -y \
   lbzip2 \
   nfs-common \
   libpcap0.8 \
-  webp
+  ${EXTRA_DEB_PACKAGES}
 
+# Install Git LFS
 curl -s https://packagecloud.io/install/repositories/github/git-lfs/script.deb.sh | sudo bash
 apt-get update
-apt-get install -y \
-  git-lfs
+apt-get install -y git-lfs
 
+# Clean up APT when done
 apt-get clean
 
-# Patched knockd
+# Download and install patched knockd
 curl -fsSL -o /tmp/knock.tar.gz https://github.com/Metalcape/knock/releases/download/0.8.1/knock-0.8.1-$TARGET.tar.gz
 tar -xf /tmp/knock.tar.gz -C /usr/local/ && rm /tmp/knock.tar.gz
 ln -s /usr/local/sbin/knockd /usr/sbin/knockd
 setcap cap_net_raw=ep /usr/local/sbin/knockd
 find /usr/lib -name 'libpcap.so.0.8' -execdir cp '{}' libpcap.so.1 \;
 
-# Set git credentials
-echo -e "[user]\n	name = Minecraft Server on Docker\n	email = server@example.com" >> /etc/gitconfig
+# Set git credentials globally
+cat <<EOF >> /etc/gitconfig
+[user]
+	name = Minecraft Server on Docker
+	email = server@example.com
+EOF

build/ubuntu/setup-user.sh

@@ -2,5 +2,9 @@
 
 set -e
 
+if id ubuntu > /dev/null 2>&1; then
+  deluser ubuntu
+fi
+
 addgroup --gid 1000 minecraft
 adduser --system --shell /bin/false --uid 1000 --ingroup minecraft --home /data minecraft

docs/configuration/misc-options.md

@@ -55,6 +55,14 @@ To allow time for players to finish what they're doing during a graceful server
     
     The grace period can be increased using [the -t option on docker-compose down](https://docs.docker.com/compose/reference/down/) or set the [stop_grace_period](https://docs.docker.com/compose/compose-file/05-services/#stop_grace_period) in the compose file.
 
+## Configuration Options for Minecraft Server Health Monitoring
+
+The image tags include specific variables to simplify configuration for monitoring the health of a Minecraft server:
+
+- `-e SERVER_HOST=localhost` : This variable sets the host address of the Minecraft server to be monitored. By default, it is set to `localhost`, but you can replace it with the actual hostname or IP address of your Minecraft server.
+
+- `-e SERVER_PORT=25565` : This variable sets the port number on which the Minecraft server is running. By default, Minecraft servers run on port 25565, but if your server is configured to use a different port, you should replace `25565` with the correct port number. This helps the monitoring system to accurately check the health status of the Minecraft server on the specified port.
+
 ## OpenJ9 Specific Options
 
 The openj9 image tags include specific variables to simplify configuration:

docs/configuration/server-properties.md

@@ -128,7 +128,7 @@ When either is set, [whitelisting of connecting users](https://minecraft.wiki/w/
 
 To change the behavior when the whitelist file already exists, set the variable `EXISTING_WHITELIST_FILE` to one of the following options:
 
-`SKIP` (default)
+`SKIP`
 : Skip processing of the whitelist file when one is already present. This is the same as setting the legacy variable `OVERRIDE_WHITELIST` to "false".
 
 `SYNCHRONIZE`
@@ -137,7 +137,7 @@ To change the behavior when the whitelist file already exists, set the variable
 `MERGE`
 : Merge the list of users from `WHITELIST` into the existing file. `WHITELIST_FILE` cannot be used with this option.
 
-`SYNC_FILE_MERGE_LIST`
+`SYNC_FILE_MERGE_LIST` (default)
 : When `WHITELIST_FILE` is provided it will overwrite an existing whitelist file. Also, if `WHITELIST` is provided, then those users will be merged into the newly copied file.
 
 !!! note 
@@ -171,7 +171,7 @@ Similar to the whitelist, users can be provisioned as operators (aka administrat
 
 To change the behavior when the ops file already exists, set the variable `EXISTING_OPS_FILE` to one of the following options:
 
-`SKIP` (default)
+`SKIP`
 : Skip processing of the ops file when one is already present. This is the same as setting the legacy variable `OVERRIDE_OPS` to "false".
 
 `SYNCHRONIZE`
@@ -180,7 +180,7 @@ To change the behavior when the ops file already exists, set the variable `EXIST
 `MERGE`
 : Merge the list of users from `OPS` into the existing file. `OPS_FILE` cannot be used with this option.
 
-`SYNC_FILE_MERGE_LIST`
+`SYNC_FILE_MERGE_LIST` (default)
 : When `OPS_FILE` is provided it will overwrite an existing ops file. Also, if `OPS` is provided, then those users will be merged into the newly copied file.
 
 !!! note
@@ -495,4 +495,11 @@ When using `docker run` from a bash shell, the entries must be quoted with the `
 | SIMULATION_DISTANCE               | simulation-distance               |
 | SYNC_CHUNK_WRITES                 | sync-chunk-writes                 |
 | USE_NATIVE_TRANSPORT              | use-native-transport              |
-
+| HIDE_ONLINE_PLAYERS               | hide-online-players               |
+| RESOURCE_PACK_ID                  | resource-pack-id                  |
+| RESOURCE_PACK_PROMPT              | resource-pack-prompt              |
+| MAX_CHAINED_NEIGHBOR_UPDATES      | max-chained-neighbor-updates      |
+| LOG_IPS                           | log-ips                           |
+| REGION_FILE_COMPRESSION           | region-file-compression           |   
+| BUG_REPORT_LINK                   | bug-report-link                   |
+| PAUSE_WHEN_EMPTY_SECONDS          | pause-when-empty-seconds          |

docs/misc/autopause-autostop/autostop.md

@@ -2,7 +2,7 @@
 
 An option to stop the server after a specified time has been added for niche applications (e.g. billing saving on AWS Fargate). The function is incompatible with the Autopause functionality, as they basically cancel out each other.
 
-!!! note 
+!!! note
 
     the docker container variables have to be set accordingly (restart policy set to "no") and that the container has to be manually restarted.
 
@@ -25,3 +25,6 @@ The following environment variables define the behavior of auto-stopping:
   describes period of the daemonized state machine, that handles the stopping of the server
 
 > To troubleshoot, add `DEBUG_AUTOSTOP=true` to see additional output
+
+## Proxy Support
+If you make use of PROXY Protocol, i.e. through something like HAProxy or Fly.io, you will need to enable it in your variety of server's configuration, and then set the `USES_PROXY_PROTOCOL` envar to `true`. This lets Autostop monitor the server, where it otherwise wouldn't

docs/misc/contributing/building.md

@@ -26,3 +26,11 @@ or just a plain build
 ```shell
 docker build -t IMG_PREFIX/minecraft-server .
 ```
+
+## Installing extra packages
+
+The following build args can be set to install additional packages for the respective base image distro:
+
+- `EXTRA_DEB_PACKAGES`
+- `EXTRA_DNF_PACKAGES`
+- `EXTRA_ALPINE_PACKAGES`

docs/misc/examples.md

@@ -26,6 +26,54 @@ services:
 
 [Source](https://github.com/itzg/docker-minecraft-server/blob/master/examples/geyser/docker-compose.yml)
 
+## Lazymc - Put your Minecraft server to rest when idle
+
+With [lazymc-docker-proxy](https://github.com/joesturge/lazymc-docker-proxy) you are able to use [lazymc](https://github.com/timvisee/lazymc) with the minecraft container.
+
+```yaml
+services:
+  lazymc:
+    container_name: lazymc
+    image: ghcr.io/joesturge/lazymc-docker-proxy:latest
+    environment:
+      # Point to the service name of the Minecraft server
+      SERVER_ADDRESS: mc:25565
+      # Required to find the container to manage it
+      LAZYMC_GROUP: mc
+    restart: unless-stopped
+    volumes:
+      # you should mount the minecraft server dir under /server, using read only.
+      - data:/server:ro
+      # you need to supply the docker socket, so that the container can run docker command
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+    ports:
+      # lazymc-docker-proxy acts as a proxy, so there is
+      # no need to expose the server port on the Minecraft container
+      - "25565:25565"
+
+  # Standard Docker Minecraft server, also works with other server types
+  mc:
+    image: itzg/minecraft-server:java21
+    container_name: minecraft-server
+    # We need to add a label here so that lazymc-docker-proxy knows which
+    # container to manage
+    labels:
+      - lazymc.group=mc
+    tty: true
+    stdin_open: true
+    # This container should be managed solely by the lazymc container
+    # so set restart to no, or else the container will start again...
+    restart: no
+    environment:
+      EULA: "TRUE"
+    volumes:
+      - data:/data
+
+volumes:
+  data:
+```
+[Source](https://github.com/joesturge/lazymc-docker-proxy/blob/master/docker-compose.yaml)
+
 ## Lazytainer - Stop Minecraft container based on traffic
 Monitors network traffic to the Minecraft containers. If there is traffic, the container runs, otherwise the container is stopped/paused.
 

docs/misc/related-projects.md

@@ -6,7 +6,7 @@ Docker image that runs a Minecraft Bedrock server.
 
 Lightweight multiplexer/proxy for Minecraft Java servers. Provided as a stand-alone application and a Docker image.
 
-### [itzg/bungeecord](https://github.com/itzg/docker-bungeecord/)
+### [itzg/mc-proxy](https://github.com/itzg/docker-bungeecord/)
 
 Docker image that runs a proxy powered by Bungeecord, Velocity, or Waterfall
 

docs/misc/troubleshooting.md

@@ -3,3 +3,5 @@ To troubleshoot the container initialization, such as when server files are pre-
 To troubleshoot just the command-line used to start the Minecraft server, set the environment variable `DEBUG_EXEC` to `true`.
 
 To troubleshoot any issues with memory allocation reported by the JVM, set the environment variable `DEBUG_MEMORY` to `true`.
+
+If you are experiencing any issues with the "Changing ownership of /data" step, that can be disabled by setting `SKIP_CHOWN_DATA` to `true`.

docs/mods-and-plugins/curseforge-files.md

@@ -47,3 +47,7 @@ naturalist
             aquaculture
             naturalist
     ```
+
+## Dependencies
+
+The files processing can detect if a dependency is missing from the given list, but is not able to resolve the dependencies otherwise since their metadata only gives the mod ID and not the specific file version/ID that is needed.

docs/mods-and-plugins/index.md

@@ -117,7 +117,7 @@ https://edge.forgecdn.net/files/2871/647/ToastControl-1.15.2-3.0.1.jar
 
     Blank lines and lines that start with a `#` will be ignored
 
-    [This compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-mods-file.yml) shows another example of using this feature.
+    [This compose file](https://github.com/itzg/docker-minecraft-server/blob/master/examples/mods-file/docker-compose.yml) shows another example of using this feature.
 
 ## Remove old mods/plugins
 

docs/mods-and-plugins/modrinth.md

@@ -9,16 +9,18 @@
                               |
                               +-- project slug
   ```
-  Also, a specific version/type can be declared using colon symbol and version id/type after the project slug. The version id can be found in the 'Metadata' section. Valid version types are `release`, `beta`, `alpha`.
-
-!!! example
+  Also, a specific version (or release type) can be declared adding a colon and then the version id, version number/name, or release type after the project slug. The version ID or number can be found in the 'Metadata' section. Valid release types are `release`, `beta`, `alpha`.
+  
+  To select a datapack from a Modrinth project, prefix the entry with "datapack:". When running a vanilla server, this is optional since only datapacks will be available for vanilla servers to select.
         
-    | Description                     | Example               |
-    |---------------------------------|-----------------------|
-    | Select latest version           | `fabric-api`          |
-    | Select specific version         | `fabric-api:PbVeub96` |
-    | Select latest beta version      | `fabric-api:beta`     |
-    | Latest version using project ID | `P7dR8mSH`            |
+  | Description                     | Example projects entry     |
+  |---------------------------------|----------------------------|
+  | Select latest version           | `fabric-api`               |
+  | Select specific version         | `fabric-api:PbVeub96`      |
+  | Select latest beta version      | `fabric-api:beta`          |
+  | Latest version using project ID | `P7dR8mSH`                 |
+  | Latest version of datapack      | `datapack:terralith`       |
+  | Specific version of datapack    | `datapack:terralith:2.5.5` |
 
 ## Extra options
 
@@ -26,5 +28,5 @@
 : Can be set to `none` (the default), `required`, or `optional` to download required and/or optional dependencies.
 
 `MODRINTH_ALLOWED_VERSION_TYPE`
-: The version type is used to determine the newest version to use from each project. The allowed values are `release` (default), `beta`, `alpha`.
+: The version type is used to determine the newest version to use from each project. The allowed values are `release` (default), `beta`, `alpha`. Setting to `beta` will pick up both release and beta versions. Setting to `alpha` will pick up release, beta, and alpha versions.
 

docs/requirements.txt

@@ -1,6 +1,6 @@
-mkdocs-material == 9.5.24
-mkdocs-autorefs == 1.0.1
-mkdocstrings == 0.25.1
+mkdocs-material == 9.5.40
+mkdocs-autorefs == 1.2.0
+mkdocstrings == 0.26.2
 mkdocs-literate-nav == 0.6.1
 mdx-gh-links == 0.4
 mkdocs-click == 0.8.1

docs/types-and-platforms/mod-platforms/auto-curseforge.md

@@ -164,6 +164,11 @@ Quite often there are mods that need to be excluded, such as ones that did not p
 
 Mods can be excluded by passing a comma or space delimited list of **project** slugs or IDs via `CF_EXCLUDE_MODS`. Similarly, there are some mods that are incorrectly tagged as client only. For those, pass the **project** slugs or IDs via `CF_FORCE_INCLUDE_MODS`. These lists will be combined with the content of the exclude/include file, if given.
 
+!!! note
+    `CF_FORCE_INCLUDE_MODS` will not download additional mods.
+    
+    For additional mods, refer to [the `CURSEFORGE_FILES` variable](../../mods-and-plugins/curseforge-files.md).
+
 A mod's project ID can be obtained from the right hand side of the project page:
 ![cf-project-id](../../img/cf-project-id.png)
 

docs/types-and-platforms/mod-platforms/modrinth-modpacks.md

@@ -73,6 +73,10 @@ To force include client mods, set `MODRINTH_FORCE_INCLUDE_FILES` to a comma or n
         yet-another-config-lib
     ```
 
+## Default exclude/includes
+
+The image comes with a default set of exclude/includes, maintained [in the repo files area](https://github.com/itzg/docker-minecraft-server/blob/master/files/modrinth-exclude-include.json) and uses the same [JSON schema](https://github.com/itzg/mc-image-helper?tab=readme-ov-file#excludeinclude-file-schema) as Auto CurseForge. Those defaults can be disabled by setting the env var `MODRINTH_DEFAULT_EXCLUDE_INCLUDES` to an empty string.
+
 ## Excluding Overrides Files
 
 Modrinth mrpack/zip files may include an `overrides` subdirectory that contains config files, world data, and extra mod files. All of those files will be extracted into the `/data` path of the container. If any of those files, such as incompatible mods, need to be excluded from extraction, then the `MODRINTH_OVERRIDES_EXCLUSIONS` variable can be set with a comma or newline delimited list of ant-style paths ([see below](#ant-style-paths)) to exclude, relative to the overrides (or `/data`) directory.

docs/types-and-platforms/server-types/hybrids.md

@@ -32,7 +32,7 @@ A [Ketting](https://github.com/kettingpowered/Ketting-1-20-x) server, which is a
 There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.20.1" or later.
 
 `FORGE_VERSION` and `KETTING_VERSION` may be specified; however, they will be defaulted by the [Ketting launcher](https://github.com/kettingpowered/kettinglauncher) otherwise.
-Available Ketting Versions may be found at [https://github.com/kettingpowered/Ketting-1-20-x/packages/2041866/versions](https://github.com/kettingpowered/Ketting-1-20-x/packages/2041866/versions).
+Available Ketting Versions may be found at [https://reposilite.c0d3m4513r.com/#/Ketting-Server-Releases/org/kettingpowered/server/forge](https://reposilite.c0d3m4513r.com/#/Ketting-Server-Releases/org/kettingpowered/server/forge).
 The Version structure is `MinecraftVersion-ForgeVersion-KettingVersion` (e.g. `1.20.1-47.2.20-0.1.4` is for Minecraft `1.20.1`, Forge `47.2.20` and Ketting `0.1.4`).
 
 ### Mohist

docs/types-and-platforms/server-types/paper.md

@@ -1,10 +1,28 @@
-Enable Paper server mode by adding a `-e TYPE=PAPER` to your command-line.
+A [PaperMC server](https://papermc.io/) can be automatically downloaded, upgraded, and run by setting the environment variable TYPE to "PAPER".
 
-By default, the container will run the latest build of [Paper server](https://papermc.io/downloads) but you can also choose to run a specific build with `-e PAPERBUILD=205`.
+By default, the container will find and download the latest build for the `VERSION` chosen. If `VERSION` is not specified, then the latest Minecraft version released by PaperMC is selected. Along with a specific `VERSION`, a specific Paper build can be selected by setting the environment variable `PAPER_BUILD`. 
 
-    docker run -d -v /path/on/host:/data \
-        -e TYPE=PAPER \
-        -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+To allow for the selection of experimental builds, set `PAPER_CHANNEL` to "experimental", otherwise only release/default channel builds are selected.
+
+!!! example
+
+    ```
+    docker run ... -e TYPE=PAPER ... 
+    
+    docker run ... -e TYPE=PAPER -e VERSION=1.20.6 ... 
+    
+    docker run ... -e TYPE=PAPER -e VERSION=1.20.6 -e PAPER_BUILD=140 ... 
+    
+    docker run ... -e TYPE=PAPER -e PAPER_CHANNEL=experimental ... 
+    ```
+
+!!! tip
+
+    If you see the following error, it likely means you need to set the env var `PAPER_CHANNEL` to "experimental"
+    
+    ```
+    No build found for version 1.21 with channel 'default'
+    ```
 
 If you are hosting your own copy of Paper you can override the download URL with `PAPER_DOWNLOAD_URL=<url>`.
 
@@ -47,13 +65,19 @@ Extra variables:
 
 ### Folia
 
-Enable Folia server mode by adding a `-e TYPE=FOLIA` to your command-line.
+A [Folia server](https://papermc.io/software/folia) can be used by setting the environment variable `TYPE` to "FOLIA".
 
-By default, the container will run the latest build of [Folia server](https://papermc.io/downloads), but you can also choose to run a specific build with `-e FOLIABUILD=26`.
+By default, the container will run the latest experimental build of [Folia server](https://papermc.io/downloads), but you can also choose to run a specific build with `-e FOLIABUILD=26`. The release channel can be changed with the variable `FOLIA_CHANNEL`; however, only experimental builds are available at this time.
 
+!!! example
+
+    Using `docker run`
+    
+    ```
     docker run -d -v /path/on/host:/data \
         -e TYPE=FOLIA \
         -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
+    ```
 
 If you are hosting your own copy of Folia you can override the download URL with `FOLIA_DOWNLOAD_URL=<url>`.
 

docs/variables.md

@@ -558,40 +558,40 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
         </tr>
         <tr>
             <td><code>BROADCAST_RCON_TO_OPS</code></td>
-            <td>Should RCON be enabled</td>
+            <td>Sets broadcast-rcon-to-ops server property</td>
             <td><code>false</code></td>
             <td>⬜️</td>
         </tr>
         <tr>
-            <td><code>RCON_CMDS_STARTUP</code></td>
-            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>RCON_CMDS_ON_CONNECT</code></td>
-            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>RCON_CMDS_ON_DISCONNECT</code></td>
-            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>RCON_CMDS_LAST_DISCONNECT</code></td>
-            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
-        <tr>
-            <td><code>RCON_CMDS_STARTUP</code></td>
-            <td>RCON commands can be configured to execute when the server starts, a client connects, or a client disconnects</td>
-            <td><code></code></td>
-            <td>⬜️</td>
-        </tr>
+			<td><code>RCON_CMDS_STARTUP</code></td>
+			<td>RCON commands to execute when the server starts.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_ON_CONNECT</code></td>
+			<td>RCON commands to execute whenever a client connects to the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_FIRST_CONNECT</code></td>
+			<td>RCON commands to execute on the first client connection to the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_ON_DISCONNECT</code></td>
+			<td>RCON commands to execute whenever a client disconnects from the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
+		<tr>
+			<td><code>RCON_CMDS_LAST_DISCONNECT</code></td>
+			<td>RCON commands to execute when the last client disconnects from the server.</td>
+			<td><code></code></td>
+			<td>⬜️</td>
+		</tr>
     </tbody>
 </table>
 

docs/versions/java.md

@@ -15,15 +15,14 @@ where `<tag>` refers to the first column of this table:
 | latest           | 21           | Ubuntu | Hotspot            | amd64, arm64        |
 | stable           | 21           | Ubuntu | Hotspot            | amd64, arm64        |
 | java21           | 21           | Ubuntu | Hotspot            | amd64, arm64        |
+| java21-jdk       | 21           | Ubuntu | Hotspot+JDK        | amd64, arm64        |
 | java21-alpine    | 21           | Alpine | Hotspot            | amd64, arm64        |
 | java21-graalvm   | 21           | Oracle | Oracle GraalVM[^1] | amd64, arm64        |   
 | java17           | 17           | Ubuntu | Hotspot            | amd64, arm64, armv7 |
-| java17-jdk       | 17           | Ubuntu | Hotspot+JDK        | amd64, arm64, armv7 |
 | java17-graalvm   | 17           | Oracle | Oracle GraalVM[^1] | amd64, arm64        |   
 | java17-alpine    | 17           | Alpine | Hotspot            | amd64  (1)          |
 | java11           | 11           | Ubuntu | Hotspot            | amd64, arm64, armv7 |
 | java8            | 8            | Ubuntu | Hotspot            | amd64, arm64, armv7 |
-| java8-alpine     | 8            | Alpine | Hotspot            | amd64  (1)          |
 | java8-jdk        | 8            | Ubuntu | Hotspot+JDK        | amd64               |
 | java8-openj9     | 8            | Debian | OpenJ9             | amd64               |
 | java8-graalvm-ce | 8            | Oracle | GraalVM CE         | amd64               |
@@ -80,6 +79,18 @@ The `stable` image tag combines the benefits of `latest` and [release versions](
 
 [This section in the Minecraft wiki](https://minecraft.wiki/w/Tutorials/Update_Java#Why_update?) lists out versions of **vanilla** Minecraft versions and the corresponding Java version that is required.
 
+### Class file version 65.0
+
+If encountering a startup failure similar to the following examples, then ensure that the latest image has been re-pulled to use a Java 21. Alternatively, set the image tag specifically to `itzg/minecraft-server:java21`.
+
+> Exception in thread "ServerMain" java.lang.UnsupportedClassVersionError: org/bukkit/craftbukkit/Main has been compiled by a more recent version of the Java Runtime (class file version 65.0), this version of the Java Runtime only recognizes class file versions up to 61.0
+
+or
+
+> Error: LinkageError occurred while loading main class net.minecraft.bundler.Main
+java.lang.UnsupportedClassVersionError: net/minecraft/bundler/Main has been compiled by a more recent version of the Java Runtime (class file version 65.0), this version of the Java Runtime only recognizes class file versions up to 61.0
+
+
 ### Forge versions
 
 Forge and its mods sometimes utilize non-public APIs of the JVM and as such are suspceptible to becoming broken with newer Java versions.
@@ -121,5 +132,6 @@ The following image tags have been deprecated and are no longer receiving update
 - java17-openj9
 - java20-graalvm, java20, java20-alpine
 - java8-multiarch is still built and pushed, but please move to java8 instead
+- java8-alpine
 
 [^1]: Based on the [Oracle GraalMV images](https://blogs.oracle.com/java/post/new-oracle-graalvm-container-images), which as of JDK 17, are now under the [GraalVM Free License](https://blogs.oracle.com/java/post/graalvm-free-license) incorporating what used to be known as the GraalVM Enterprise. 

examples/aof7/docker-compose.yml

@@ -16,21 +16,6 @@ services:
       - "25565:25565"
     volumes:
       - mc-data:/data
-      - ./downloads:/downloads
-      # Manually download the following and put into the 'downloads' directory next to this compose file
-      #
-      #  Mod                          Filename                                   Download page
-      #  ===========================  =========================================  ====================================================================================
-      #  Fish of Thieves              [Fabric 1.20.1] Fish of Thieves v3.0.3     https://www.curseforge.com/minecraft/mc-mods/fish-of-thieves/files/4958329
-      #  Only Hammers [FORGE/FABRIC]  OnlyHammers-1.20.1-0.6-Fabric              https://www.curseforge.com/minecraft/mc-mods/only-hammers-forge-fabric/files/4832068
-      #  Sprinklerz                   sprinklerz-0.5_fabric.jar                  https://www.curseforge.com/minecraft/mc-mods/sprinklerz/files/4835664
-      #  Frog Legs (Fabric/Forge)     FrogLegs-v2.0.0-1.20.1-Fabric.jar          https://www.curseforge.com/minecraft/mc-mods/froglegs/files/4917818
-      #  TrimsEffects                 [FABRIC] TrimsEffects - MC 1.20.X - 1.1.0  https://www.curseforge.com/minecraft/mc-mods/trimseffects/files/4954156
-      #  Display Case                 Display Case-fabric-1.20-1.0.8.jar         https://www.curseforge.com/minecraft/mc-mods/displaycase/files/4921333
-      #  Structory: Towers            Structory Towers 1.20.4 v1.0.6             https://www.curseforge.com/minecraft/mc-mods/structory-towers/files/4937875
-      #  Packet Fixer                 Packet Fixer Fabric 1.2.1                  https://www.curseforge.com/minecraft/mc-mods/packet-fixer/files/4884316
-      #  Perfect Plushies             Perfect Plushies 1.9.0 [Fabric]            https://www.curseforge.com/minecraft/mc-mods/perfect-plushies/files/4985767
-      #  Structory                    Structory 1.20.2 v1.3.4                    https://www.curseforge.com/minecraft/mc-mods/structory/files/4937872
 
 volumes:
   mc-data: {}

examples/atm8/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   mc:
-    image: itzg/minecraft-server
+    image: itzg/minecraft-server:java17
     ports:
       - "25565:25565"
     environment:
@@ -9,11 +9,10 @@ services:
       # allocate from https://console.curseforge.com/ and set in .env file
       CF_API_KEY: ${CF_API_KEY}
       CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-8
-      CF_FILENAME_MATCHER: "1.0.6"
+#      CF_FILENAME_MATCHER: "1.1.0"
       MEMORY: 4G
     volumes:
       - mc-data:/data
-      - ../downloads:/downloads
   # Since Docker's default volume driver creates volumes owned by root, this
   # init container will change ownership to match final UID of mc service, above
   init-filebrowser:

examples/atm9/docker-compose.yml

@@ -14,7 +14,6 @@ services:
       MEMORY: 4G
     volumes:
       - mc-data:/data
-      - ./downloads:/downloads
 
 volumes:
   mc-data: {}

examples/auto-cf/using-excludes/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   mc:
-    image: itzg/minecraft-server:java8-multiarch
+    image: itzg/minecraft-server:java8
     ports:
       - "25565:25565"
     environment:
@@ -43,7 +43,6 @@ services:
       MEMORY: 4G
     volumes:
       - mc-data:/data
-      - ./downloads:/downloads
 
 volumes:
   mc-data: {}

examples/bettermc/docker-compose.yml

@@ -7,11 +7,10 @@ services:
       # Set CF_API_KEY=... in a .env file next to this compose file and don't source control that file
       CF_API_KEY: ${CF_API_KEY}
       CF_SLUG: better-mc-fabric-bmc1
-      CF_FILENAME_MATCHER: v18.5
+#      CF_FILENAME_MATCHER: v18.5
       MEMORY: 4G
     volumes:
       - mc:/data
-      - ../downloads:/downloads
     ports:
       - "25565:25565"
 

examples/bmc4/docker-compose.yml

@@ -1,30 +1,20 @@
 services:
   mc:
-    image: itzg/minecraft-server:java17
+    image: itzg/minecraft-server
     environment:
       EULA: true
-      TYPE: MODRINTH
-      MEMORY: 4G
-      MODRINTH_MODPACK: better-mc-forge-bmc4
-      MODRINTH_VERSION: v26
+      MOD_PLATFORM: MODRINTH
+      MODRINTH_MODPACK: https://modrinth.com/modpack/better-mc-forge-bmc4/version/v32.5
       MODRINTH_EXCLUDE_FILES: |
-        citresewn
-        oculus
-        yungsmenutweaks
-        notenoughanimations
-        ryoamiclights
-        euphoriapatcher
-        entity_model_features
-        entity_texture_features
-        3dskinlayers
-        connector
+        XaeroPlus
+        XaerosWorldMap
       MODRINTH_OVERRIDES_EXCLUSIONS: |
-        mods/NekosEnchantedBooks-*.jar
         mods/citresewn-*.jar
-    volumes:
-      - data:/data
+        **/datapacks/BE_default_endgen_fix*
+      MODRINTH_FORCE_SYNCHRONIZE: true
+      MEMORY: 4G
     ports:
       - "25565:25565"
-
-volumes:
-  data: {}
+    # declare /data volume mapping as desired
+#    volumes:
+#      - ./data:/data

examples/docker-compose-autopause.yml

@@ -8,7 +8,6 @@ services:
     environment:
       EULA: "TRUE"
       ENABLE_AUTOPAUSE: "TRUE"
-      OVERRIDE_SERVER_PROPERTIES: "TRUE"
       MAX_TICK_TIME: "-1"
       # More aggressive settings for demo purposes
       AUTOPAUSE_TIMEOUT_INIT: "30"

examples/lazymc/docker_compose.yml

@@ -0,0 +1,40 @@
+services:
+  lazymc:
+    container_name: lazymc
+    image: ghcr.io/joesturge/lazymc-docker-proxy:latest
+    environment:
+      # Point to the service name of the Minecraft server
+      SERVER_ADDRESS: mc:25565
+      # Required to find the container to manage it
+      LAZYMC_GROUP: mc
+    restart: unless-stopped
+    volumes:
+      # you should mount the minecraft server dir under /server, using read only.
+      - data:/server:ro
+      # you need to supply the docker socket, so that the container can run docker command
+      - /var/run/docker.sock:/var/run/docker.sock:ro
+    ports:
+      # lazymc-docker-proxy acts as a proxy, so there is
+      # no need to expose the server port on the Minecraft container
+      - "25565:25565"
+
+  # Standard Docker Minecraft server, also works with other server types
+  mc:
+    image: itzg/minecraft-server:java21
+    container_name: minecraft-server
+    # We need to add a label here so that lazymc-docker-proxy knows which
+    # container to manage
+    labels:
+      - lazymc.group=mc
+    tty: true
+    stdin_open: true
+    # This container should be managed solely by the lazymc container
+    # so set restart to no, or else the container will start again...
+    restart: no
+    environment:
+      EULA: "TRUE"
+    volumes:
+      - data:/data
+
+volumes:
+  data:

examples/multi-project/servers/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   proxy:
-    image: itzg/bungeecord
+    image: itzg/mc-proxy
     environment:
       TYPE: WATERFALL
     ports:
@@ -10,7 +10,7 @@ services:
       - ./waterfall-config:/config
 # If you want to use Velocity here is a premade version that supports Velocity
 #  velocity-proxy:
-#    image: itzg/bungeecord
+#    image: itzg/mc-proxy
 #    environment:
 #      TYPE: VELOCITY
 #    ports:

examples/optimized-paper-config/README.md

@@ -0,0 +1,60 @@
+# A Form to Load New Config Files to Paper MC
+
+In this example, we illustrate how to efficiently load and manage different configuration files to optimize a Paper Minecraft server. To implement this, it is necessary to create a dedicated repository where the configuration files can be stored and later retrieved. The repository should adhere to a specific structure to facilitate seamless integration with your Docker setup. Notably, the configurations must be organized into a folder named after the version of Minecraft you are using.
+
+For reference, I have provided this [repository](https://github.com/Alpha018/paper-config-optimized), which contains optimized configuration files for the latest version of Minecraft. You can use this repository by linking directly to the configuration files in your Docker file, as demonstrated in the example below.
+
+## Usage
+
+You can directly use the optimized configuration files from this repository by accessing them through the GitHub raw URLs. Simply replace the env var like the docker compose with any other repo with different configurations.
+
+To use the raw files, you can download or link to them using the following pattern:
+
+```yaml
+services:
+  mc:
+    image: itzg/minecraft-server
+    container_name: paper
+    environment:
+      EULA: "true"
+      TYPE: "PAPER"
+      VIEW_DISTANCE: 10
+      MEMORY: 2G
+      PAPER_CONFIG_REPO: "https://raw.githubusercontent.com/[your-username]/[your-repository]/main/[file-path]"
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-paper:/data
+    restart: unless-stopped
+volumes:
+  mc-paper: {}
+```
+
+For example:
+
+```yaml
+services:
+  mc:
+    image: itzg/minecraft-server
+    container_name: paper
+    environment:
+      EULA: "true"
+      TYPE: "PAPER"
+      VIEW_DISTANCE: 10
+      MEMORY: 2G
+      PAPER_CONFIG_REPO: "https://raw.githubusercontent.com/Alpha018/paper-config-optimized/main"
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-paper:/data
+    restart: unless-stopped
+volumes:
+  mc-paper: {}
+```
+
+Feel free to explore and use the configurations in this repo to enhance your Minecraft server's performance.
+
+## Contribution
+
+If you'd like to improve or suggest changes to these configurations, feel free to submit a pull request in this [repository](https://github.com/Alpha018/paper-config-optimized). We welcome contributions from the community!
+

examples/optimized-paper-config/docker-compose.yml

@@ -0,0 +1,17 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    container_name: paper
+    environment:
+      EULA: "true"
+      TYPE: "PAPER"
+      VIEW_DISTANCE: 10
+      MEMORY: 2G
+      PAPER_CONFIG_REPO: "https://raw.githubusercontent.com/Alpha018/paper-config-optimized/main"
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-paper:/data
+    restart: unless-stopped
+volumes:
+  mc-paper: {}

examples/prominence2/docker-compose.yml

@@ -0,0 +1,18 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      MOD_PLATFORM: AUTO_CURSEFORGE
+      # allocate from https://console.curseforge.com/ and set in .env file
+      CF_API_KEY: ${CF_API_KEY}
+      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/prominence-2-rpg
+      CF_FILENAME_MATCHER: "2.8.7"
+      MEMORY: 4G
+    volumes:
+      - mc-data:/data
+
+volumes:
+  mc-data: {}

examples/rad2/compose.yaml

@@ -13,38 +13,21 @@ services:
       # Optional: select a specific version/file
       #CF_FILENAME_MATCHER: "0.2.34"
       CF_EXCLUDE_MODS: |
-        auudio-forge
-        betterf3
-        better-third-person
-        clickable-advancements
         controlling
         craftpresence
         creative-core
         default-options
-        drippy-loading-screen
-        embeddium
-        embeddium-extension
-        embeddium-extras
         equipment-compare
-        ezzoom
-        fading-night-vision
-        fancymenu
         item-borders
         itemphysic-lite
-        just-enough-resources-jer
         konkrete
-        legendary-tooltips
-        mouse-tweaks
         oauth
-        oculus
         sound-filters
-        textrues-embeddium-options
         toast-control
       CF_FORCE_SYNCHRONIZE: "true"
       MEMORY: 4G
     volumes:
       - mc-data:/data
-      - ./downloads:/downloads
 
 volumes:
   mc-data: {}

examples/simple-voice-chat/fabric-compose.yaml

@@ -0,0 +1,21 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    tty: true
+    stdin_open: true
+    ports:
+      # Game port
+      - "25565:25565/tcp"
+      # Voice chat port
+      - "24454:24454/udp"
+    environment:
+      EULA: "TRUE"
+      TYPE: "FABRIC"
+      VERSION: "1.21.1"
+      # This will select the latest version of simple voice chat for 1.21.1.
+      # You can specify a version by appending :versionID (e.g. simple-voice-chat:anabvqRL)
+      MODRINTH_PROJECTS: "simple-voice-chat"
+      MEMORY: 8G
+    volumes:
+      # attach the relative directory 'data' to the container's /data path
+      - ./data:/data

examples/simple-voice-chat/neoforge-compose.yaml

@@ -0,0 +1,21 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    tty: true
+    stdin_open: true
+    ports:
+      # Game port
+      - "25565:25565/tcp"
+      # Voice chat port
+      - "24454:24454/udp"
+    environment:
+      EULA: "TRUE"
+      TYPE: "NEOFORGE"
+      VERSION: "1.21.1"
+      # This will select the latest version of simple voice chat for 1.21.1.
+      # You can specify a version by appending :versionID (e.g. simple-voice-chat:anabvqRL)
+      MODRINTH_PROJECTS: "simple-voice-chat"
+      MEMORY: 8G
+    volumes:
+      # attach the relative directory 'data' to the container's /data path
+      - ./data:/data

examples/simple-voice-chat/paper-compose.yaml

@@ -0,0 +1,21 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    tty: true
+    stdin_open: true
+    ports:
+      # Game port
+      - "25565:25565/tcp"
+      # Voice chat port
+      - "24454:24454/udp"
+    environment:
+      EULA: "TRUE"
+      TYPE: "PAPER"
+      VERSION: "1.21.1"
+      # This will select the latest version of simple voice chat for 1.21.1.
+      # You can specify a version by appending :versionID (e.g. simple-voice-chat:anabvqRL)
+      MODRINTH_PROJECTS: "simple-voice-chat"
+      MEMORY: 8G
+    volumes:
+      # attach the relative directory 'data' to the container's /data path
+      - ./data:/data

examples/spiget/docker-compose.yml

@@ -1,6 +1,5 @@
 # NOTE
-# This file is named spiget with an "e"
-# since it provides an example of the 
+# This file is purposely named spiget with an "e" since it provides an example of the
 # feature https://docker-minecraft-server.readthedocs.io/en/latest/mods-and-plugins/spiget/
 # which uses the Spiget API at https://spiget.org/
 
@@ -13,8 +12,6 @@ services:
       EULA: "TRUE"
       TYPE: PAPER
       SPIGET_RESOURCES: 34315,3836
+      REMOVE_OLD_MODS: true
     volumes:
-      - data:/data
-
-volumes:
-  data: {}
+      - ./data:/data

examples/vault-hunters-1-18-2/docker-compose.yml

@@ -16,10 +16,6 @@ services:
       ENABLE_COMMAND_BLOCK: true
       DIFFICULTY: hard
     volumes:
-      # Need to place non-distributable mods in ./downloads/mods
-      # As of Update-10.0.0
-      # - Neon Craft 2 v2.2: https://www.curseforge.com/minecraft/mc-mods/neon-craft-2-mod/files/3726051
-      - ./downloads:/downloads
       - mc-data:/data
 
 volumes:

files/auto/autopause-fcns.sh

@@ -1,5 +1,7 @@
 #!/bin/bash
 
+# shellcheck source=../scripts/start-utils
+. "${SCRIPTS:-/}start-utils"
 current_uptime() {
   awk '{print $1}' /proc/uptime | cut -d . -f 1
 }
@@ -16,14 +18,20 @@ rcon_client_exists() {
   [[ -n "$(ps -ax -o comm | grep 'rcon-cli')" ]]
 }
 
+use_proxy() {
+  if isTrue "$USES_PROXY_PROTOCOL"; then
+    echo "--use-proxy"
+  fi
+}
+
 mc_server_listening() {
-  mc-monitor status --host localhost --port "$SERVER_PORT" --timeout 10s >& /dev/null
+  mc-monitor status $(use_proxy) --host "${SERVER_HOST:-localhost}" --port "$SERVER_PORT" --timeout 10s >&/dev/null
 }
 
 java_clients_connections() {
   local connections
-  if java_running ; then
-    if ! connections=$(mc-monitor status --host localhost --port "$SERVER_PORT" --show-player-count); then
+  if java_running; then
+    if ! connections=$(mc-monitor status $(use_proxy) --host "${SERVER_HOST:-localhost}" --port "$SERVER_PORT" --show-player-count); then
       # consider it a non-zero player count if the ping fails
       # otherwise a laggy server with players connected could get paused
       connections=1

files/cf-exclude-include.json

@@ -1,30 +1,72 @@
 {
   "globalExcludes": [
+    "ambience-music-mod",
     "ambientsounds",
+    "appleskin",
+    "armor-chroma",
     "armor-toughness-bar",
+    "auudio-forge",
+    "beehivetooltips",
+    "better-advancements",
+    "better-foliage",
+    "better-placement",
+    "better-sprinting",
+    "better-third-person",
+    "better-tips-nbt-tag",
+    "betterf3",
+    "betterfps",
     "biomeinfo",
     "block-drops-jei-addon",
+    "blur-forge",
+    "cartography",
     "cherished-worlds",
+    "chunk-animator",
+    "clickable-advancements",
+    "configured",
     "controlling",
     "ctm",
     "custom-main-menu",
     "defensive-measures",
     "ding",
+    "drippy-loading-screen",
+    "dynamic-surroundings",
     "dynamiclights-reforged",
+    "easiervillagertrading",
+    "effective-forge",
     "embeddium",
+    "embeddium-extension",
+    "embeddium-extras",
     "enchantment-descriptions",
+    "enhancedvisuals",
+    "entity-collision-fps-fix",
     "entity-texture-features-fabric",
     "entityculling",
     "extreme-sound-muffler",
+    "ezzoom",
+    "fading-night-vision",
+    "falling-leaves-forge",
+    "fancymenu",
+    "faster-ladder-climbing",
+    "foamfix-optimization-mod",
+    "fps-reducer",
     "free-cam",
+    "ftb-backups-2",
+    "fullscreen-windowed-borderless-for-minecraft",
+    "hwyla",
     "ignitioncoil",
     "inmisaddon",
-    "irisshaders",
     "iris-flywheel-compat",
+    "irisshaders",
+    "item-obliterator",
+    "itemphysic-lite",
+    "itemzoom",
     "just-enough-harvestcraft",
     "just-enough-resources-jer",
+    "just-zoom",
+    "konkrete",
     "legendary-tooltips",
     "loot-capacitor-tooltips",
+    "lootbeams",
     "magnesium-extras",
     "menumobs",
     "minecraft-rich-presence",
@@ -32,6 +74,7 @@
     "mouse-tweaks",
     "neat",
     "nekos-enchanted-books",
+    "no-nv-flash",
     "no-recipe-book",
     "not-enough-animations",
     "oculus",
@@ -39,16 +82,38 @@
     "overloaded-armor-bar",
     "packmodemenu",
     "reauth",
+    "reblured",
+    "reforgium",
     "resource-reloader",
     "rubidium",
     "rubidium-extra",
+    "ryoamiclights",
+    "schematica",
+    "seamless-loading-screen",
+    "seamless-loading-screen-forge",
+    "searchables",
+    "shulkerboxviewer",
     "skin-layers-3d",
+    "smart-hud",
+    "smooth-font",
+    "smoothwater",
     "sodium",
+    "sodium-rubidium-occlusion-culling-fix",
+    "sound-filters",
+    "sound-physics-remastered",
+    "stellar-sky",
+    "swingthroughgrass",
+    "textrues-embeddium-options",
     "textrues-rubidium-options",
     "thaumic-jei",
     "tips",
     "torohealth-damage-indicators",
-    "waila-harvestability"
+    "true-darkness",
+    "ungrab-mouse-mod",
+    "vanillafix",
+    "visuality",
+    "waila-harvestability",
+    "zume"
   ],
   "modpacks": {
     "all-of-fabric-6": {

files/modrinth-exclude-include.json

@@ -0,0 +1,80 @@
+{
+  "globalExcludes": [
+    "3dskinlayers",
+    "ae2-emi-crafting",
+    "AmbientSounds",
+    "amecs",
+    "Animation_Overhaul",
+    "appleskin",
+    "auudio",
+    "axolotlbuckets",
+    "BadOptimizations",
+    "BetterAdvancements",
+    "betterbeds",
+    "BetterThirdPerson",
+    "BHMenu",
+    "blur",
+    "Boat-Item-View",
+    "bobby",
+    "cat_jam",
+    "chat_heads",
+    "chatanimation",
+    "cherishedworlds",
+    "citresewn",
+    "clickadv",
+    "connector",
+    "DisableCustomWorldsAdvice",
+    "drippyloadingscreen",
+    "eating-animation",
+    "emiffect",
+    "emitrades",
+    "entity_model_features",
+    "entity_texture_features",
+    "entityculling",
+    "euphoriapatcher",
+    "fallingleaves",
+    "fancymenu",
+    "fast-ip-ping",
+    "FauxCustomEntityData",
+    "GeckoLibIrisCompat",
+    "gpumemleakfix",
+    "Highlighter",
+    "ImmediatelyFast",
+    "indium",
+    "iris",
+    "iris-flywheel",
+    "ItemBorders",
+    "ItemLocks",
+    "justzoom",
+    "language-reload",
+    "lazy-language-loader",
+    "LegendaryTooltips",
+    "loadmyresources",
+    "lootbeams",
+    "MindfulDarkness",
+    "MouseTweaks",
+    "nicer-skies",
+    "notenoughanimations",
+    "oculus",
+    "OverflowingBars",
+    "PickUpNotifier",
+    "PresenceFootsteps",
+    "Prism",
+    "reeses_sodium_options",
+    "ResourcePackOverrides",
+    "ryoamiclights",
+    "Searchables",
+    "seasonhud",
+    "ShoulderSurfing",
+    "skinlayers3d",
+    "sodium",
+    "sorted_enchantments",
+    "visuality",
+    "VR-Combat",
+    "YeetusExperimentus",
+    "yungsmenutweaks",
+    "Zoomify"
+  ],
+  "globalForceIncludes": [],
+  "modpacks": {}
+}

files/property-definitions.json

@@ -1,58 +1,66 @@
 {
-  "motd": {"env": "MOTD"},
-  "gamemode": {"env": "MODE"},
-  "difficulty": {"env": "DIFFICULTY"},
-  "white-list": {"env": "WHITELIST_PROP"},
-  "enforce-whitelist": {"env": "ENFORCE_WHITELIST"},
-  "level-type": {"env": "LEVEL_TYPE"},
-  "server-name": {"env": "SERVER_NAME"},
-  "server-ip": {"env": "SERVER_IP"},
-  "server-port": {"env": "SERVER_PORT"},
+  "allow-flight": {"env": "ALLOW_FLIGHT"},
   "allow-nether": {"env": "ALLOW_NETHER"},
+  "bug-report-link": {"env": "BUG_REPORT_LINK"},
   "announce-player-achievements": {"env": "ANNOUNCE_PLAYER_ACHIEVEMENTS"},
+  "broadcast-console-to-ops": {"env": "BROADCAST_CONSOLE_TO_OPS"},
+  "broadcast-rcon-to-ops": {"env": "BROADCAST_RCON_TO_OPS"},
+  "difficulty": {"env": "DIFFICULTY"},
   "enable-command-block": {"env": "ENABLE_COMMAND_BLOCK"},
+  "enable-jmx-monitoring": {"env": "ENABLE_JMX"},
+  "enable-query": {"env": "ENABLE_QUERY"},
+  "enable-rcon": {"env": "ENABLE_RCON"},
+  "enable-status": {"env": "ENABLE_STATUS"},
+  "enforce-secure-profile": {"env": "ENFORCE_SECURE_PROFILE"},
+  "enforce-whitelist": {"env": "ENFORCE_WHITELIST"},
+  "entity-broadcast-range-percentage": {"env": "ENTITY_BROADCAST_RANGE_PERCENTAGE"},
+  "force-gamemode": {"env": "FORCE_GAMEMODE"},
+  "function-permission-level": {"env": "FUNCTION_PERMISSION_LEVEL"},
+  "gamemode": {"env": "MODE"},
+  "generate-structures": {"env": "GENERATE_STRUCTURES"},
+  "generator-settings": {"env": "GENERATOR_SETTINGS"},
+  "hardcore": {"env": "HARDCORE"},
+  "hide-online-players": {"env": "HIDE_ONLINE_PLAYERS"},
+  "initial-disabled-packs": {"env": "INITIAL_DISABLED_PACKS"},
+  "initial-enabled-packs": {"env": "INITIAL_ENABLED_PACKS"},
+  "level-name": {"env": "LEVEL"},
+  "level-seed": {"env": "SEED"},
+  "level-type": {"env": "LEVEL_TYPE"},
+  "log-ips": {"env": "LOG_IPS"},
+  "max-build-height": {"env": "MAX_BUILD_HEIGHT"},
+  "max-chained-neighbor-updates": {"env": "MAX_CHAINED_NEIGHBOR_UPDATES"},
+  "max-players": {"env": "MAX_PLAYERS"},
+  "max-tick-time": {"env": "MAX_TICK_TIME"},
+  "max-world-size": {"env": "MAX_WORLD_SIZE"},
+  "motd": {"env": "MOTD"},
+  "network-compression-threshold": {"env": "NETWORK_COMPRESSION_THRESHOLD"},
+  "online-mode": {"env": "ONLINE_MODE"},
+  "op-permission-level": {"env": "OP_PERMISSION_LEVEL"},
+  "pause-when-empty-seconds": {"env": "PAUSE_WHEN_EMPTY_SECONDS"},
+  "player-idle-timeout": {"env": "PLAYER_IDLE_TIMEOUT"},
+  "prevent-proxy-connections": {"env": "PREVENT_PROXY_CONNECTIONS"},
+  "previews-chat": {"env": "PREVIEWS_CHAT"},
+  "pvp": {"env": "PVP"},
+  "query.port": {"env": "QUERY_PORT"},
+  "rcon.password": {"env": "RCON_PASSWORD"},
+  "rcon.port": {"env": "RCON_PORT"},
+  "region-file-compression": {"env": "REGION_FILE_COMPRESSION"},
+  "resource-pack": {"env": "RESOURCE_PACK"},
+  "resource-pack-id": {"env": "RESOURCE_PACK_ID"},
+  "resource-pack-prompt": {"env": "RESOURCE_PACK_PROMPT"},
+  "resource-pack-sha1": {"env": "RESOURCE_PACK_SHA1"},
+  "require-resource-pack": {"env": "RESOURCE_PACK_ENFORCE"},
+  "server-ip": {"env": "SERVER_IP"},
+  "server-name": {"env": "SERVER_NAME"},
+  "server-port": {"env": "SERVER_PORT"},
+  "simulation-distance": {"env": "SIMULATION_DISTANCE"},
+  "snooper-enabled": {"env": "SNOOPER_ENABLED"},
   "spawn-animals": {"env": "SPAWN_ANIMALS"},
   "spawn-monsters": {"env": "SPAWN_MONSTERS"},
   "spawn-npcs": {"env": "SPAWN_NPCS"},
   "spawn-protection": {"env": "SPAWN_PROTECTION"},
-  "generate-structures": {"env": "GENERATE_STRUCTURES"},
-  "view-distance": {"env": "VIEW_DISTANCE"},
-  "hardcore": {"env": "HARDCORE"},
-  "snooper-enabled": {"env": "SNOOPER_ENABLED"},
-  "max-build-height": {"env": "MAX_BUILD_HEIGHT"},
-  "force-gamemode": {"env": "FORCE_GAMEMODE"},
-  "max-tick-time": {"env": "MAX_TICK_TIME"},
-  "enable-query": {"env": "ENABLE_QUERY"},
-  "query.port": {"env": "QUERY_PORT"},
-  "enable-rcon": {"env": "ENABLE_RCON"},
-  "rcon.password": {"env": "RCON_PASSWORD"},
-  "rcon.port": {"env": "RCON_PORT"},
-  "max-players": {"env": "MAX_PLAYERS"},
-  "max-world-size": {"env": "MAX_WORLD_SIZE"},
-  "level-name": {"env": "LEVEL"},
-  "level-seed": {"env": "SEED"},
-  "pvp": {"env": "PVP"},
-  "generator-settings": {"env": "GENERATOR_SETTINGS"},
-  "online-mode": {"env": "ONLINE_MODE"},
-  "allow-flight": {"env": "ALLOW_FLIGHT"},
-  "resource-pack": {"env": "RESOURCE_PACK"},
-  "resource-pack-sha1": {"env": "RESOURCE_PACK_SHA1"},
-  "require-resource-pack": {"env": "RESOURCE_PACK_ENFORCE"},
-  "player-idle-timeout": {"env": "PLAYER_IDLE_TIMEOUT"},
-  "broadcast-console-to-ops": {"env": "BROADCAST_CONSOLE_TO_OPS"},
-  "broadcast-rcon-to-ops": {"env": "BROADCAST_RCON_TO_OPS"},
-  "enable-jmx-monitoring": {"env": "ENABLE_JMX"},
   "sync-chunk-writes": {"env": "SYNC_CHUNK_WRITES"},
-  "enable-status": {"env": "ENABLE_STATUS"},
-  "entity-broadcast-range-percentage": {"env": "ENTITY_BROADCAST_RANGE_PERCENTAGE"},
-  "function-permission-level": {"env": "FUNCTION_PERMISSION_LEVEL"},
-  "network-compression-threshold": {"env": "NETWORK_COMPRESSION_THRESHOLD"},
-  "op-permission-level": {"env": "OP_PERMISSION_LEVEL"},
-  "prevent-proxy-connections": {"env": "PREVENT_PROXY_CONNECTIONS"},
   "use-native-transport": {"env": "USE_NATIVE_TRANSPORT"},
-  "simulation-distance": {"env": "SIMULATION_DISTANCE"},
-  "previews-chat": {"env": "PREVIEWS_CHAT"},
-  "enforce-secure-profile": {"env": "ENFORCE_SECURE_PROFILE"},
-  "initial-enabled-packs": {"env": "INITIAL_ENABLED_PACKS"},
-  "initial-disabled-packs": {"env": "INITIAL_DISABLED_PACKS"}
+  "view-distance": {"env": "VIEW_DISTANCE"},
+  "white-list": {"env": "WHITELIST_PROP"}
 }

kustomize/README.md

@@ -13,10 +13,24 @@ configMapGenerator:
   - name: mc
     envs:
       - mc.env
+patches:
+  # Example of using a patch to set external service name for mc-router to pick up
+  - path: set-external-servername.yml
 ```
 
 ### mc.env
 ```
 EULA=true
 TYPE=FORGE
+```
+
+###
+
+```yaml
+apiVersion: v1
+kind: Service
+metadata:
+  name: mc
+  annotations:
+    mc-router.itzg.me/externalServerName: forge.example.com
 ```

scripts/start

@@ -6,6 +6,7 @@
 # The Dockerfile ENVs take precedence here, but defaulting for testing consistency
 : "${UID:=1000}"
 : "${GID:=1000}"
+: "${SKIP_CHOWN_DATA:=false}"
 
 umask "${UMASK:=0002}"
 
@@ -38,7 +39,7 @@ if ! isTrue "${SKIP_SUDO:-false}" && [ "$(id -u)" = 0 ]; then
     fi
   fi
 
-  if [[ $(stat -c "%u" /data) != "$UID" ]]; then
+  if isTrue "${SKIP_CHOWN_DATA}" || [[ $(stat -c "%u" /data) != "$UID" ]]; then
     log "Changing ownership of /data to $UID ..."
     chown -R ${runAsUser}:${runAsGroup} /data
   fi

scripts/start-configuration

@@ -57,6 +57,9 @@ fi
 # Setup RCON password
 
 if isTrue "${ENABLE_RCON:-true}"; then
+  # turn off debug output
+  set +x
+
   if [[ -v RCON_PASSWORD_FILE ]]; then
     if [ ! -e "${RCON_PASSWORD_FILE}" ]; then
       log ""
@@ -78,11 +81,12 @@ if isTrue "${ENABLE_RCON:-true}"; then
   # For rcon-cli access running via exec, which by default is running as root
   echo "password=${RCON_PASSWORD}" > "$HOME/.rcon-cli.env"
   echo "password: \"${RCON_PASSWORD}\"" > "$HOME/.rcon-cli.yaml"
+
+  isDebugging && set -x
 else
   rm -f "$HOME/.rcon-cli.env" "$HOME/.rcon-cli.yaml"
 fi
 
-
 ##########################################
 # Auto-pause/stop
 

scripts/start-deployAutoCF

@@ -12,7 +12,7 @@ set -eu
 : "${CF_FORCE_SYNCHRONIZE:=false}"
 : "${CF_FORCE_REINSTALL_MODLOADER:=false}"
 : "${CF_IGNORE_MISSING_FILES:=}"
-: "${CF_EXCLUDE_INCLUDE_FILE=https://raw.githubusercontent.com/itzg/docker-minecraft-server/master/files/cf-exclude-include.json}"
+: "${CF_EXCLUDE_INCLUDE_FILE=/image/cf-exclude-include.json}"
 : "${CF_EXCLUDE_MODS:=}"
 : "${CF_FORCE_INCLUDE_MODS:=}"
 : "${CF_SET_LEVEL_FROM:=}" # --set-level-from
@@ -20,6 +20,7 @@ set -eu
 : "${CF_OVERRIDES_EXCLUSIONS:=}" # --overrides-exclusions
 : "${CF_DOWNLOADS_REPO=$([ -d /downloads ] && echo '/downloads' || echo '')}"
 : "${CF_MODPACK_MANIFEST:=}"
+: "${CF_API_CACHE_DEFAULT_TTL:=}" # as ISO-8601 duration, such as P2D or PT12H
 
 resultsFile=/data/.install-curseforge.env
 
@@ -29,49 +30,31 @@ ensureRemoveAllModsOff "MOD_PLATFORM=AUTO_CURSEFORGE"
 
 args=(
   --results-file="$resultsFile"
-)
-if [[ $CF_PAGE_URL ]]; then
-  args+=(--modpack-page-url="$CF_PAGE_URL")
-fi
-if [[ $CF_FILE_ID ]]; then
-  args+=(--file-id="$CF_FILE_ID")
-fi
-if [[ $CF_SLUG ]]; then
-  args+=(--slug="$CF_SLUG")
-fi
-if [[ $CF_MODPACK_MANIFEST ]]; then
-  args+=(--modpack-manifest="$CF_MODPACK_MANIFEST")
-fi
-if [[ $CF_FILENAME_MATCHER ]]; then
-  args+=(--filename-matcher="$CF_FILENAME_MATCHER")
-fi
-if [[ ${CF_SET_LEVEL_FROM} ]]; then
-  args+=(--set-level-from="$CF_SET_LEVEL_FROM")
-fi
-if [[ ${CF_OVERRIDES_EXCLUSIONS} ]]; then
-  args+=(--overrides-exclusions="$CF_OVERRIDES_EXCLUSIONS")
-fi
-if [[ ${CF_IGNORE_MISSING_FILES} ]]; then
-  args+=(--ignore-missing-files="$CF_IGNORE_MISSING_FILES")
-fi
-args+=(
   --force-synchronize="$CF_FORCE_SYNCHRONIZE"
   --force-reinstall-modloader="$CF_FORCE_REINSTALL_MODLOADER"
   --overrides-skip-existing="$CF_OVERRIDES_SKIP_EXISTING"
 )
+setArg() {
+  arg="${1?}"
+  var="${2?}"
 
-if [[ $CF_EXCLUDE_MODS ]]; then
-  args+=( --exclude-mods="$CF_EXCLUDE_MODS" )
-fi
-if [[ $CF_FORCE_INCLUDE_MODS ]]; then
-  args+=( --force-include-mods="$CF_FORCE_INCLUDE_MODS" )
-fi
-if [[ $CF_EXCLUDE_INCLUDE_FILE ]]; then
-  args+=( --exclude-include-file="$CF_EXCLUDE_INCLUDE_FILE" )
-fi
-if [[ $CF_DOWNLOADS_REPO ]]; then
-  args+=( --downloads-repo="$CF_DOWNLOADS_REPO" )
-fi
+  if [[ ${!var} ]]; then
+      args+=("${arg}=${!var}")
+  fi
+}
+setArg --modpack-page-url CF_PAGE_URL
+setArg --file-id CF_FILE_ID
+setArg --slug CF_SLUG
+setArg --modpack-manifest CF_MODPACK_MANIFEST
+setArg --filename-matcher CF_FILENAME_MATCHER
+setArg --set-level-from CF_SET_LEVEL_FROM
+setArg --overrides-exclusions CF_OVERRIDES_EXCLUSIONS
+setArg --ignore-missing-files CF_IGNORE_MISSING_FILES
+setArg --api-cache-default-ttl CF_API_CACHE_DEFAULT_TTL
+setArg --exclude-mods CF_EXCLUDE_MODS
+setArg --force-include-mods CF_FORCE_INCLUDE_MODS
+setArg --exclude-include-file CF_EXCLUDE_INCLUDE_FILE
+setArg --downloads-repo CF_DOWNLOADS_REPO
 
 if ! mc-image-helper install-curseforge "${args[@]}"; then
     log "ERROR failed to auto-install CurseForge modpack"

scripts/start-deployFTBA

@@ -88,6 +88,32 @@ if ! [ -v SERVER ]; then
   exit 2
 fi
 
-export FAMILY=FORGE
+# Remap the TYPE and FAMILY based on discovered server jar
+if [[ $SERVER = run.sh ]]; then
+  if grep -q neoforge "$SERVER"; then
+    export FAMILY=FORGE
+    export TYPE=NEOFORGE
+  elif grep -q forge "$SERVER"; then
+    export FAMILY=FORGE
+    export TYPE=FORGE
+  elif grep -q fabric run.s; then
+      export FAMILY=FABRIC
+      export TYPE=FABRIC
+  else
+    log "ERROR: unrecognized loader type in $SERVER"
+    cat "$SERVER"
+    exit 1
+  fi
+
+elif [[ $SERVER = forge* ]]; then
+  export FAMILY=FORGE
+  export TYPE=FORGE
+elif [[ $SERVER = fabric* ]]; then
+  export FAMILY=FABRIC
+  export TYPE=FABRIC
+else
+  log "ERROR: unrecognized loader type from $SERVER"
+  exit 1
+fi
 
 exec "${SCRIPTS:-/}start-setupWorld" "$@"

scripts/start-deployFolia

@@ -1,5 +1,12 @@
 #!/bin/bash
 
+: "${FOLIA_CHANNEL:=experimental}"
+
+# shellcheck source=start-utils
+. "${SCRIPTS:-/}start-utils"
+set -o pipefail
+handleDebugMode
+
 if [[ $FOLIA_DOWNLOAD_URL ]]; then
   export PAPER_DOWNLOAD_URL="$FOLIA_DOWNLOAD_URL"
 fi
@@ -8,4 +15,7 @@ if [[ $FOLIABUILD ]]; then
   export PAPERBUILD="$FOLIABUILD"
 fi
 
-PAPER_PROJECT="folia" PAPER_NAME="FoliaMC" exec "${SCRIPTS:-/}start-deployPaper" "$@"
+PAPER_PROJECT="folia" \
+PAPER_NAME="FoliaMC" \
+PAPER_CHANNEL="${FOLIA_CHANNEL}" \
+  exec "${SCRIPTS:-/}start-deployPaper" "$@"

scripts/start-deployModrinth

@@ -9,10 +9,11 @@ resultsFile=/data/.install-modrinth.env
 : "${MODRINTH_MODPACK:=${MODRINTH_PROJECT:-}}"
 : "${MODRINTH_LOADER:=}"
 : "${MODRINTH_VERSION:=${MODRINTH_VERSION_ID:-}}"
-: "${MODRINTH_IGNORE_MISSING_FILES:=}"
-: "${MODRINTH_EXCLUDE_FILES:=}"
-: "${MODRINTH_FORCE_INCLUDE_FILES:=}"
-: "${MODRINTH_OVERRIDES_EXCLUSIONS:=}"
+: "${MODRINTH_IGNORE_MISSING_FILES=}"
+: "${MODRINTH_EXCLUDE_FILES=}"
+: "${MODRINTH_FORCE_INCLUDE_FILES=}"
+: "${MODRINTH_OVERRIDES_EXCLUSIONS=}"
+: "${MODRINTH_DEFAULT_EXCLUDE_INCLUDES=/image/modrinth-exclude-include.json}"
 
 if [[ ! $MODRINTH_MODPACK ]]; then
   log "ERROR: MODRINTH_MODPACK must be set when using TYPE/MOD_PLATFORM of MODRINTH"
@@ -60,6 +61,7 @@ setArg --default-version-type MODRINTH_DEFAULT_VERSION_TYPE
 setArg --exclude-files MODRINTH_EXCLUDE_FILES
 setArg --force-include-files MODRINTH_FORCE_INCLUDE_FILES
 setArg --overrides-exclusions MODRINTH_OVERRIDES_EXCLUSIONS
+setArg --default-exclude-includes MODRINTH_DEFAULT_EXCLUDE_INCLUDES
 
 if ! mc-image-helper install-modrinth-modpack "${args[@]}"; then
     log "ERROR failed to install Modrinth modpack"

scripts/start-deployPaper

@@ -6,9 +6,11 @@ set -o pipefail
 handleDebugMode
 
 : "${PAPER_PROJECT:=paper}"
-: "${PAPERBUILD:=}"
+: "${PAPER_BUILD:=${PAPERBUILD:-}}"
+: "${PAPER_CHANNEL:=default}"
 : "${PAPER_DOWNLOAD_URL:=}"
 : "${PAPER_CUSTOM_JAR:=}"
+: "${PAPER_CONFIG_DEFAULTS_REPO:=${PAPER_CONFIG_REPO:=https://raw.githubusercontent.com/dayyeeet/minecraft-default-configs/main}}"
 
 resultsFile=/data/.paper.env
 if [[ $PAPER_CUSTOM_JAR ]]; then
@@ -33,9 +35,10 @@ else
     --results-file="$resultsFile"
     --project="$PAPER_PROJECT"
     --version="$VERSION"
+    --channel="$PAPER_CHANNEL"
   )
-  if [[ $PAPERBUILD ]]; then
-    args+=(--build="$PAPERBUILD")
+  if [[ $PAPER_BUILD ]]; then
+    args+=(--build="$PAPER_BUILD")
   fi
   if ! mc-image-helper install-paper "${args[@]}"; then
       log "ERROR: failed to download $PAPER_PROJECT"
@@ -49,6 +52,12 @@ else
 
 fi
 
+# Download default configs to allow for consistent patching
+for c in paper-global.yml paper-world-defaults.yml spigot.yml; do
+  DOWNLOAD_DEFAULT_CONFIGS+=",${PAPER_CONFIG_DEFAULTS_REPO}/${VERSION}/$c"
+done
+export DOWNLOAD_DEFAULT_CONFIGS
+
 # Normalize on Spigot for downstream operations
 export FAMILY=SPIGOT
 

scripts/start-finalExec

@@ -64,6 +64,9 @@ patchLog4jConfig() {
   canUseRollingLogs=false
 }
 
+# Temporarily disable debugging output
+oldState=$(shopt -po xtrace || true)
+shopt -u -o xtrace
 # Patch Log4j remote code execution vulnerability
 # See https://www.minecraft.net/en-us/article/important-message--security-vulnerability-java-edition
 if versionLessThan 1.7; then
@@ -80,6 +83,7 @@ elif isType PURPUR && versionLessThan 1.18.1; then
 elif versionLessThan 1.18.1; then
   useFallbackJvmFlag=true
 fi
+eval "$oldState"
 
 if ${useFallbackJvmFlag}; then
   JVM_OPTS="-Dlog4j2.formatMsgNoLookups=true ${JVM_OPTS}"
@@ -227,6 +231,12 @@ MC_HEALTH_EXTRA_ARGS=(
   --use-server-list-ping
 )
   " > /data/.mc-health.env
+elif isTrue "$USES_PROXY_PROTOCOL"; then
+  echo "
+MC_HEALTH_EXTRA_ARGS=(
+  --use-proxy
+)
+  " > /data/.mc-health.env
 else
   rm -f /data/.mc-health.env
 fi

scripts/start-setupEnvVariables

@@ -4,6 +4,7 @@
 . "${SCRIPTS:-/}start-utils"
 
 set -e
+handleDebugMode
 
 : "${REPLACE_ENV_IN_PLACE:=${REPLACE_ENV_VARIABLES:-false}}"
 : "${REPLACE_ENV_PATHS:=/data}"
@@ -13,6 +14,7 @@ set -e
 : "${REPLACE_ENV_VARIABLES_EXCLUDE_PATHS:=}"
 : "${PATCH_DEFINITIONS:=}"
 : "${DEBUG:=false}"
+: "${DOWNLOAD_DEFAULT_CONFIGS:=}"
 
 if isTrue "${REPLACE_ENV_IN_PLACE}"; then
   log "Replacing env variables in ${REPLACE_ENV_PATHS} that match the prefix '$REPLACE_ENV_VARIABLE_PREFIX' ..."
@@ -25,6 +27,16 @@ if isTrue "${REPLACE_ENV_IN_PLACE}"; then
     "${REPLACE_ENV_PATHS[@]}"
 fi
 
+if [[ $DOWNLOAD_DEFAULT_CONFIGS ]]; then
+  log "Downloading default configs, if needed"
+  if ! mc-image-helper mcopy \
+    --to /data/config \
+    --skip-existing --skip-up-to-date=false \
+    "$DOWNLOAD_DEFAULT_CONFIGS" 2> /dev/null; then
+    log "WARN: one or more default config files were not available from $DOWNLOAD_DEFAULT_CONFIGS"
+  fi
+fi
+
 if [[ ${PATCH_DEFINITIONS} ]]; then
   log "Applying patch definitions from ${PATCH_DEFINITIONS}"
   mc-image-helper patch \

scripts/start-setupModpack

@@ -244,14 +244,17 @@ function handleModrinthProjects() {
     log "        Use MODRINTH_DOWNLOAD_DEPENDENCIES=optional instead"
   fi
 
-  if [[ $MODRINTH_PROJECTS ]] && isFamily HYBRID FORGE FABRIC SPIGOT; then
+  if [[ $MODRINTH_PROJECTS ]]; then
     if isFamily HYBRID; then
       loader=forge
+    elif isFamily VANILLA; then
+      loader=datapack
     else
       loader="${TYPE,,}"
     fi
     mc-image-helper modrinth \
       --output-directory=/data \
+      --world-directory="${LEVEL:-world}" \
       --projects="${MODRINTH_PROJECTS}" \
       --game-version="${VERSION}" \
       --loader="$loader" \

scripts/start-setupRbac

@@ -2,8 +2,8 @@
 set -euo pipefail
 IFS=$'\n\t'
 
-: "${EXISTING_OPS_FILE:=SKIP}"
-: "${EXISTING_WHITELIST_FILE:=SKIP}"
+: "${EXISTING_OPS_FILE:=SYNC_FILE_MERGE_LIST}"
+: "${EXISTING_WHITELIST_FILE:=SYNC_FILE_MERGE_LIST}"
 
 # shellcheck source=start-utils
 . "${SCRIPTS:-/}start-utils"

scripts/start-setupWorld

@@ -5,10 +5,15 @@
 set -e
 isDebugging && set -x
 
-if [ "$TYPE" = "CURSEFORGE" ]; then
-  worldDest=$FTB_DIR/${LEVEL:-world}
+# support absolute directories
+if [[ "${LEVEL:-world}" =~ ^\/.*$ ]]; then
+  worldDest=${LEVEL}
 else
-  worldDest=/data/${LEVEL:-world}
+  if [ "$TYPE" = "CURSEFORGE" ]; then
+    worldDest=$FTB_DIR/${LEVEL:-world}
+  else
+    worldDest=/data/${LEVEL:-world}
+  fi
 fi
 
 if [[ "$WORLD" ]] && ( isTrue "${FORCE_WORLD_COPY}" || [ ! -d "$worldDest" ] ); then

scripts/start-spiget

@@ -8,7 +8,10 @@ handleDebugMode
 
 : "${SPIGET_RESOURCES:=}"
 : "${SPIGET_DOWNLOAD_TOLERANCE:=5}" # in minutes
+: "${REMOVE_OLD_MODS:=false}"
+: "${REMOVE_OLD_MODS_EXCLUDE:=}"
 : "${REMOVE_OLD_MODS_INCLUDE:=*.jar,*-version.json}"
+: "${REMOVE_OLD_MODS_DEPTH:=1} "
 
 acceptArgs=(--accept application/zip --accept application/java-archive --accept application/octet-stream)
 
@@ -127,7 +130,7 @@ downloadResourceFromSpiget() {
 }
 
 if [[ ${SPIGET_RESOURCES} ]]; then
-  if isTrue "${REMOVE_OLD_MODS:-false}"; then
+  if isTrue "${REMOVE_OLD_MODS}"; then
     removeOldMods /data/plugins
     REMOVE_OLD_MODS=false
   fi

scripts/start-utils

@@ -34,18 +34,14 @@ function get_major_version() {
 function isURL() {
   local value=$1
 
-  if [[ ${value:0:8} == "https://" || ${value:0:7} == "http://" || ${value:0:6} == "ftp://" ]]; then
-    return 0
-  else
-    return 1
-  fi
+  [[ $value =~ ^(https?|ftp):// ]]
 }
 
 function isValidFileURL() {
   suffix=${1:?Missing required suffix arg}
   url=${2:?Missing required url arg}
 
-  [[ "$url" == http*://*.${suffix} || "$url" == http*://*.${suffix}\?* ]]
+  [[ "$url" =~ ^http.*://.*\.${suffix}(\?.*)?$ ]]
 }
 
 function resolveEffectiveUrl() {
@@ -64,7 +60,7 @@ function getFilenameFromUrl() {
 
 function isTrue() {
   case "${1,,}" in
-  true | on | 1)
+  true | yes | on | 1)
     return 0
     ;;
   *)
@@ -75,7 +71,7 @@ function isTrue() {
 
 function isFalse() {
   case "${1,,}" in
-  false | off | 0)
+  false | no | off | 0)
     return 0
     ;;
   *)
@@ -85,11 +81,7 @@ function isFalse() {
 }
 
 function isDebugging() {
-  if isTrue "${DEBUG:-false}"; then
-    return 0
-  else
-    return 1
-  fi
+  isTrue "${DEBUG:-false}"
 }
 
 function handleDebugMode() {
@@ -113,11 +105,9 @@ function log() {
   # The  return  status  when listing options is zero if all optnames are enabled, non- zero otherwise.
   oldState=$(shopt -po xtrace || true)
   shopt -u -o xtrace
-
+  ts=
   if isDebugging || isTrue "${LOG_TIMESTAMP:-false}"; then
     ts=" $(date --rfc-3339=seconds)"
-  else
-    ts=
   fi
   echo "[init]${ts} $*"
   eval "$oldState"
@@ -161,13 +151,108 @@ function normalizeMemSize() {
   echo $((val * scale))
 }
 
-function versionLessThan() {
-  # Use if-else since strict mode might be enabled
-  if mc-image-helper compare-versions "${VERSION}" lt "${1?}"; then
-    return 0
-  else
+function compare_version() {
+  local left_version=$1
+  local comparison=$2
+  local right_version=$3
+
+  if [[ -z "$left_version" ]]; then
+    echo "Left version is required"
     return 1
   fi
+
+  if [[ -z "$right_version" ]]; then
+    echo "Right version is required"
+    return 1
+  fi
+
+  # Handle version channels ('a', 'b', or numeric)
+  if [[ $left_version == a* || $left_version == b* ]]; then
+    left_version=${left_version:1}
+  fi
+
+  if [[ $right_version == a* || $right_version == b* ]]; then
+    right_version=${right_version:1}
+  fi
+
+  local left_version_channel=${left_version:0:1}
+  if [[ $left_version_channel =~ [0-9] ]]; then
+    left_version_channel='r'
+  fi
+
+  local right_version_channel=${right_version:0:1}
+  if [[ $right_version_channel =~ [0-9] ]]; then
+    right_version_channel='r'
+  fi
+
+  if [[ $comparison == "lt" && $left_version_channel < $right_version_channel ]]; then
+      return 0
+  elif [[ $comparison == "lt" && $left_version_channel > $right_version_channel ]]; then
+      return 1
+  elif [[ $comparison == "gt" && $left_version_channel > $right_version_channel ]]; then
+      return 0
+  elif [[ $comparison == "gt" && $left_version_channel < $right_version_channel ]]; then
+      return 1
+  elif [[ $comparison == "le" && $left_version_channel < $right_version_channel ]]; then
+      return 0
+  elif [[ $comparison == "le" && $left_version_channel == $right_version_channel ]]; then
+      return 0
+  elif [[ $comparison == "ge" && $left_version_channel > $right_version_channel ]]; then
+      return 0
+  elif [[ $comparison == "ge" && $left_version_channel == $right_version_channel ]]; then
+      return 0
+  elif [[ $comparison == "eq" && $left_version_channel == $right_version_channel ]]; then
+      return 0
+  fi
+
+# Compare the versions using sort -V
+  local result=1
+
+  case $comparison in
+      "lt")
+          if [[ $(echo -e "$left_version\n$right_version" | sort -V | head -n1) == "$left_version" && "$left_version" != "$right_version" ]]; then
+              result=0
+          fi
+          ;;
+      "le")
+          if [[ $(echo -e "$left_version\n$right_version" | sort -V | head -n1) == "$left_version" ]]; then
+              result=0
+          fi
+          ;;
+      "eq")
+          if [[ "$left_version" == "$right_version" ]]; then
+              result=0
+          fi
+          ;;
+      "ge")
+          if [[ $(echo -e "$left_version\n$right_version" | sort -V | tail -n1) == "$left_version" ]]; then
+              result=0
+          fi
+          ;;
+      "gt")
+          if [[ $(echo -e "$left_version\n$right_version" | sort -V | tail -n1) == "$left_version" && "$left_version" != "$right_version" ]]; then
+              result=0
+          fi
+          ;;
+      *)
+          echo "Unsupported comparison operator: $comparison"
+          return 1
+          ;;
+  esac
+
+  return $result
+}
+
+function versionLessThan() {
+  local oldState
+  # The  return  status  when listing options is zero if all optnames are enabled, non- zero otherwise.
+  oldState=$(shopt -po xtrace || true)
+  shopt -u -o xtrace
+
+  eval "$oldState"
+
+  # Verify strict mode because it might be enabled
+  compare_version "${VERSION}" "lt" "${1?}"
 }
 
 requireVar() {
@@ -192,7 +277,7 @@ requireEnum() {
   done
 
   log "ERROR: $var must be set to one of $*"
-#  exit 1
+  #  exit 1
 }
 
 function writeEula() {
@@ -207,13 +292,13 @@ eula=${EULA,,}
 
 function removeOldMods {
   if [ -d "$1" ]; then
-    log "Removing old mods including:${REMOVE_OLD_MODS_INCLUDE} excluding:${REMOVE_OLD_MODS_EXCLUDE}"
+    log "Removing old mods including='${REMOVE_OLD_MODS_INCLUDE}' excluding='${REMOVE_OLD_MODS_EXCLUDE}' up to depth=${REMOVE_OLD_MODS_DEPTH}"
     args=(
       --delete
       --type file
-      --min-depth=1 --max-depth "${REMOVE_OLD_MODS_DEPTH:-16}"
-      --name "${REMOVE_OLD_MODS_INCLUDE:-*}"
-      --exclude-name "${REMOVE_OLD_MODS_EXCLUDE:-}"
+      --min-depth=1 --max-depth "${REMOVE_OLD_MODS_DEPTH}"
+      --name "${REMOVE_OLD_MODS_INCLUDE}"
+      --exclude-name "${REMOVE_OLD_MODS_EXCLUDE}"
     )
     if ! isDebugging; then
       args+=(--quiet)
@@ -259,19 +344,19 @@ function extract() {
 
   type=$(file -b --mime-type "${src}")
   case "${type}" in
-    application/zip)
-      unzip -o -q -d "${destDir}" "${src}"
-      ;;
-    application/x-tar|application/gzip|application/x-gzip|application/x-bzip2)
-      tar -C "${destDir}" -xf "${src}"
-      ;;
-    application/zstd|application/x-zstd)
-      tar -C "${destDir}" --use-compress-program=unzstd -xf "${src}"
-      ;;
-    *)
-      log "ERROR: unsupported archive type: $type"
-      return 1
-      ;;
+  application/zip)
+    unzip -o -q -d "${destDir}" "${src}"
+    ;;
+  application/x-tar | application/gzip | application/x-gzip | application/x-bzip2)
+    tar -C "${destDir}" -xf "${src}"
+    ;;
+  application/zstd | application/x-zstd)
+    tar -C "${destDir}" --use-compress-program=unzstd -xf "${src}"
+    ;;
+  *)
+    log "ERROR: unsupported archive type: $type"
+    return 1
+    ;;
   esac
 }
 
@@ -285,31 +370,33 @@ function checkSum() {
   # Get distro
   distro=$(getDistro)
 
-  if [ "${distro}" == "debian" ] && sha1sum -c "${sum_file}" --status 2> /dev/null; then
-    return 0
-  elif [ "${distro}" == "ubuntu" ] && sha1sum -c "${sum_file}" --status 2> /dev/null; then
-    return 0
-  elif [ "${distro}" == "alpine" ] && sha1sum -c "${sum_file}" -s 2> /dev/null; then
-    return 0
-  elif [ "${distro}" == "ol" ] && sha1sum -c "${sum_file}" --status 2> /dev/null; then
-    return 0
-  else
+  case "${distro}" in
+  debian | ubuntu | ol)
+    sha1sum -c "${sum_file}" --status 2>/dev/null && return 0
+    ;;
+  alpine)
+    sha1sum -c "${sum_file}" -s 2>/dev/null && return 0
+    ;;
+  *)
     return 1
-  fi
+    ;;
+  esac
 }
 
 function usesMods() {
   case "$FAMILY" in
-    FORGE|FABRIC|HYBRID|SPONGE)
-      return 0
+  FORGE | FABRIC | HYBRID | SPONGE)
+    return 0
+    ;;
   esac
   return 1
 }
 
 function usesPlugins() {
   case "$FAMILY" in
-    SPIGOT|HYBRID)
-      return 0
+  SPIGOT | HYBRID)
+    return 0
+    ;;
   esac
   return 1
 }
@@ -325,15 +412,15 @@ function resolveVersion() {
 
 function resolveFamily() {
   case "$TYPE" in
-    PAPER|SPIGOT|BUKKIT|CANYON|PUFFERFISH|PURPUR)
-      FAMILY=SPIGOT
-      ;;
-    FORGE)
-      FAMILY=FORGE
-      ;;
-    FABRIC|QUILT)
-      FAMILY=FABRIC
-      ;;
+  PAPER | SPIGOT | BUKKIT | CANYON | PUFFERFISH | PURPUR)
+    FAMILY=SPIGOT
+    ;;
+  FORGE)
+    FAMILY=FORGE
+    ;;
+  FABRIC | QUILT)
+    FAMILY=FABRIC
+    ;;
   esac
   export FAMILY
 }
@@ -342,7 +429,7 @@ function ensureRemoveAllModsOff() {
   reason=${1?}
 
   if isTrue "${REMOVE_OLD_MODS:-false}"; then
-    log "WARNING using REMOVE_OLDS_MODS interferes with $reason -- it is now disabled"
+    log "WARNING using REMOVE_OLD_MODS interferes with $reason -- it is now disabled"
     REMOVE_OLD_MODS=false
   fi
-}
+}

tests/setuponlytests/test.sh

@@ -2,6 +2,8 @@
 set -euo pipefail
 IFS=$'\n\t'
 
+: "${IMAGE_TO_TEST:=itzg/minecraft-server}"
+
 # go to script root directory
 cd "$(dirname "$0")" || exit 1
 
@@ -42,22 +44,20 @@ setupOnlyMinecraftTest(){
   # false positive since it's used in delta calculations below
   # shellcheck disable=SC2034
   start=$(date +%s)
+  status=PASSED
+  verify=
   if ! logs=$(docker compose run --rm -e SETUP_ONLY=true -e DEBUG="${DEBUG:-false}" mc 2>&1); then
     outputContainerLog "$logs"
     result=1
   elif [ -f verify.sh ]; then
-    if ! docker run --rm --entrypoint bash -v "${PWD}/data":/data -v "${PWD}/verify.sh":/verify "${IMAGE_TO_TEST:-itzg/minecraft-server}" -e /verify; then
-      endTime=$(date +%s)
-      echo "${folder} FAILED verify in $(delta start)"
+    verify=" verify"
+    if ! docker run --rm --entrypoint bash -v "${PWD}/data":/data -v "${PWD}/verify.sh":/verify "${IMAGE_TO_TEST}" -e /verify; then
+      status=FAILED
       outputContainerLog "$logs"
       result=1
-    else
-      endTime=$(date +%s)
-      echo "${folder} PASSED verify in $(delta start)"
     fi
-  else
-    echo "${folder} PASSED in $(delta start)"
   fi
+  echo "${folder} ${status}${verify} in $(delta start)"
 
   docker compose down -v --remove-orphans >& /dev/null
   cd ..
@@ -65,16 +65,17 @@ setupOnlyMinecraftTest(){
   return $result
 }
 
-# go through each folder in setuponly and test setups
-if (( $# > 0 )); then
-  for folder in "$@"; do
-    echo "Starting Tests in ${folder}"
-    setupOnlyMinecraftTest "$folder"
-  done
-else
+foldersList=("$@")
+image=""
+
+# Go through each folder in setuponly and test setups
+if (( $# == 0 )); then
   readarray -t folders < <(find . -maxdepth 2 -mindepth 2 -name docker-compose.yml -printf '%h\n')
-  for folder in "${folders[@]}"; do
-    echo "Starting Tests in ${folder}"
-    setupOnlyMinecraftTest "$folder"
-  done
+  foldersList=("${folders[@]}")
+  image=" using $IMAGE_TO_TEST"
 fi
+
+for folder in "${foldersList[@]}"; do
+  echo "Starting Tests in ${folder}${image}"
+  setupOnlyMinecraftTest "$folder"
+done