build(deps): bump docker/build-push-action from 6.12.0 to 6.13.0 in the updates group (#3283)

.github/workflows/build-multiarch.yml

@@ -131,10 +131,10 @@ jobs:
         uses: docker/setup-buildx-action@v3.8.0
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v3.2.0
+        uses: docker/setup-qemu-action@v3.3.0
 
       - name: Build for test
-        uses: docker/build-push-action@v6.10.0
+        uses: docker/build-push-action@v6.13.0
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -172,7 +172,7 @@ jobs:
           password: ${{ github.token }}
 
       - name: Build and push
-        uses: docker/build-push-action@v6.10.0
+        uses: docker/build-push-action@v6.13.0
         if: github.actor == github.repository_owner
         with:
           platforms: ${{ matrix.platforms }}

.github/workflows/verify-pr.yml

@@ -56,7 +56,7 @@ jobs:
         uses: docker/setup-buildx-action@v3.8.0
 
       - name: Confirm multi-arch build
-        uses: docker/build-push-action@v6.10.0
+        uses: docker/build-push-action@v6.13.0
         with:
           platforms: ${{ matrix.platforms }}
           # ensure latest base image is used
@@ -66,7 +66,7 @@ jobs:
           cache-from: type=gha,scope=${{ matrix.variant }}
 
       - name: Build for test
-        uses: docker/build-push-action@v6.10.0
+        uses: docker/build-push-action@v6.13.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

@@ -40,17 +40,17 @@ 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.15.0
+ARG MC_MONITOR_VERSION=0.15.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.3
+ARG MC_SERVER_RUNNER_VERSION=1.12.4
 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.40.7
+ARG MC_HELPER_VERSION=1.40.11
 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

README.md

@@ -10,10 +10,12 @@
 
 There you will find things like
 - [Quick start with Docker Compose](https://docker-minecraft-server.readthedocs.io/en/latest/#using-docker-compose)
-- Running [different versions of Minecraft](https://docker-minecraft-server.readthedocs.io/en/latest/versions/minecraft/) and using [various server types](https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/)
+- Running [different versions of Minecraft](https://docker-minecraft-server.readthedocs.io/en/latest/versions/minecraft/) and using [various server types](https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/) for Java Edition
 - [Setting server properties via container environment variables](https://docker-minecraft-server.readthedocs.io/en/latest/configuration/server-properties/)
 - [Managing mods and plugins with automated downloads and cleanup](https://docker-minecraft-server.readthedocs.io/en/latest/mods-and-plugins/)
 - [Using various modpack providers/platforms](https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/)
 - ...and much more
 
-There are also many examples located in [the examples directory](examples) of this repo.
+There are also many examples located in [the examples directory](examples) of this repo.
+
+This image only supports Java edition natively; however, if looking for a server that is compatible with Bedrock edition, then use [itzg/minecraft-bedrock-server](https://github.com/itzg/docker-minecraft-bedrock-server) or [refer to this section](https://docker-minecraft-server.readthedocs.io/en/latest/misc/examples/#bedrock-compatible-server) to add Bedrock compatibility to a Java edition server.

build/alpine/install-packages.sh

@@ -24,6 +24,7 @@ apk add --no-cache -U \
     tzdata \
     rsync \
     nano \
+    ncurses \
     sudo \
     tar \
     zstd \

docs/configuration/misc-options.md

@@ -55,6 +55,16 @@ 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.
 
+The `STOP_SERVER_ANNOUNCE_DELAY` can be bypassed by sending a `SIGUSR1` signal to the `mc-server-runner` process.
+
+`docker`:
+
+        docker stop --signal SIGUSR1 mc
+
+`docker compose`:
+
+        docker compose kill --signal SIGUSR1
+
 ## Configuration Options for Minecraft Server Health Monitoring
 
 The image tags include specific variables to simplify configuration for monitoring the health of a Minecraft server:

docs/index.md

@@ -19,7 +19,7 @@ where, in this case, the standard server port 25565, will be exposed on your hos
 
 !!! note
 
-    If you plan on running a server for a longer amount of time it is highly recommended using a management layer such as [Docker Compose](#using-docker-compose) or [Kubernetes](#deployment-templates-and-examples) to allow for incremental reconfiguration and image upgrades.
+    If you plan on running a server for a longer amount of time it is highly recommended using a management layer such as [Docker Compose](#using-docker-compose) or [Kubernetes](misc/deployment/index.md#on-kubernetes) to allow for incremental reconfiguration and image upgrades.
 
 !!! info 
 
@@ -58,6 +58,9 @@ To apply changes made to the compose file, just run `docker compose up -d` again
 
 Follow the logs of the container using `docker compose logs -f`, check on the status with `docker compose ps`, and stop the container using `docker compose stop`.
 
+!!! note "Configurator Tool"
+    If you prefer to use an interactive tool to create or edit a Docker Compose file for this image, you can check out [setupmc.com's configurator](https://setupmc.com/java-server/). It provides a form that supports most of the image variables and generates the `compose.yml` file in real time.
+
 !!! note "More Compose Examples"
     There are more [examples located in the Github repo](https://github.com/itzg/docker-minecraft-server/tree/master/examples).
 

docs/misc/world-data.md

@@ -80,6 +80,10 @@ Example of expected VanillaTweaks share codes:
 VANILLATWEAKS_SHARECODE: MGr52E,tF1zL2,LnEDwT
 ```
 
+!!! note
+
+    Datapack names are all lower case. [See their spec](https://vanillatweaks.net/assets/resources/json/1.21/dpcategories.json) for a full list of 1.21 datapacks, and [their spec](https://vanillatweaks.net/assets/resources/json/1.21/ctcategories.json) for a full list of 1.21 crafting tweaks.
+
 Example of expected VanillaTweaks files:
 
 ``` yaml
@@ -89,13 +93,14 @@ VANILLATWEAKS_FILE: /config/vt-datapacks.json,/config/vt-craftingtweaks.json,/co
 ``` json title="DataPacks json"
 {
   "type": "datapacks",
-  "version": "1.18",
+  "version": "1.21",
   "packs": {
-    "survival": [
+    "gameplay changes": [
       "graves",
-      "multiplayer sleep"
+      "multiplayer sleep",
+      "armored elytra"
     ],
-    "items": ["armored elytra"]
+    "teleport commands": ["tpa"]
   }
 }
 ```
@@ -103,7 +108,7 @@ VANILLATWEAKS_FILE: /config/vt-datapacks.json,/config/vt-craftingtweaks.json,/co
 ``` json title="ResourcePacks json"
 {
     "type": "resourcepacks",
-    "version": "1.18",
+    "version": "1.21",
     "packs": {
         "aesthetic": ["CherryPicking", "BlackNetherBricks", "AlternateBlockDestruction"]
     }
@@ -114,7 +119,7 @@ VANILLATWEAKS_FILE: /config/vt-datapacks.json,/config/vt-craftingtweaks.json,/co
 ``` json title="CraftingTweaks Json"
 {
     "type": "craftingtweaks",
-    "version": "1.18",
+    "version": "1.21",
     "packs": {
         "quality of life": [
             "dropper to dispenser",

docs/mods-and-plugins/index.md

@@ -78,6 +78,20 @@ If applying large generic packs, the update can be time-consuming. To skip the u
 
 The most time-consuming portion of the generic pack update is generating and comparing the SHA1 checksum. To skip the checksum generation, set `SKIP_GENERIC_PACK_CHECKSUM` to "true".
 
+To disable specific mods, which can be useful for conflicts between multiple generic packs, you can use the `GENERIC_PACKS_DISABLE_MODS` variable to specify mods to disable.
+
+Disabling mods with docker run:
+```shell
+docker run -d -e GENERIC_PACKS_DISABLE_MODS="mod1.jar mod2.jar" ...
+```
+
+Disabling mods within docker compose files:
+```yaml
+      GENERIC_PACKS_DISABLE_MODS: |
+        mod1.jar
+        mod2.jar
+```
+
 ## Mods/plugins list
 
 You may also download or copy over individual mods/plugins using the `MODS` or `PLUGINS` environment variables. Both are a comma or newline delimited list of

docs/requirements.txt

@@ -1,7 +1,7 @@
-mkdocs-material == 9.5.49
-mkdocs-autorefs == 1.2.0
+mkdocs-material == 9.5.50
+mkdocs-autorefs == 1.3.0
 mkdocstrings == 0.27.0
 mkdocs-literate-nav == 0.6.1
 mdx-gh-links == 0.4
 mkdocs-click == 0.8.1
-mkdocs-static-i18n == 1.2.3
+mkdocs-static-i18n == 1.3.0

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

@@ -6,6 +6,8 @@ To allow for the selection of experimental builds, set `PAPER_CHANNEL` to "exper
 
 !!! example
 
+    Using `docker run` command line
+    
     ```
     docker run ... -e TYPE=PAPER ... 
     
@@ -15,6 +17,26 @@ To allow for the selection of experimental builds, set `PAPER_CHANNEL` to "exper
     
     docker run ... -e TYPE=PAPER -e PAPER_CHANNEL=experimental ... 
     ```
+    
+    Using a compose file:
+    
+    ```yaml
+    environment:
+      TYPE: PAPER
+    ```
+    
+    ```yaml
+    environment:
+      TYPE: PAPER
+      VERSION: 1.20.6
+      PAPER_BUILD: 140
+    ```
+    
+    ```yaml
+    environment:
+      TYPE: PAPER
+      PAPER_CHANNEL: experimental
+    ```
 
 !!! tip
 

examples/canyon/compose.yml

@@ -0,0 +1,13 @@
+services:
+  mc:
+    image: itzg/minecraft-server:java8
+    environment:
+      EULA: true
+      TYPE: canyon
+      VERSION: b1.7.3
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+volumes:
+  mc-data:

examples/gtnh/docker-compose.yaml

@@ -9,15 +9,17 @@ services:
     environment:
       EULA: "TRUE"
       TYPE: CUSTOM
-      GENERIC_PACKS: GT_New_Horizons_2.7.1_Server_Java_17-21
+      GENERIC_PACKS: GT_New_Horizons_2.7.2_Server_Java_17-21
       GENERIC_PACKS_SUFFIX: .zip
       GENERIC_PACKS_PREFIX: https://downloads.gtnewhorizons.com/ServerPacks/
       # if this isn't true, then the container tries to download the modpack every run
-      : "true"
+      SKIP_GENERIC_PACK_UPDATE_CHECK: "true"
+      MEMORY: 6G
       # Make sure that this matches what is in your pack's startserver bash file
-      CUSTOM_JAR_EXEC: "-Xms6G -Xmx6G -Dfml.readTimeout=180 @java9args.txt -jar lwjgl3ify-forgePatches.jar nogui"
+      JVM_OPTS: -Dfml.readTimeout=180 @java9args.txt
+      CUSTOM_JAR_EXEC: -jar lwjgl3ify-forgePatches.jar nogui
     volumes:
-      # attach the relative directory 'data' to the container's /data path
+      # attach a managed volume, change to a relative or absolute host directory if needed
       - mc-data:/data
 volumes:
-  mc-data:
+  mc-data:

examples/multiline-motd/docker-compose.yml

@@ -4,7 +4,7 @@ services:
     environment:
       EULA: true
       MOTD: |
-        line one
+        A §l§cMinecraft§r server
         line two
 # or
 #      MOTD: "line one\nline two"

examples/skyfactory5/compose.yml

@@ -0,0 +1,19 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      # https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+#      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/skyfactory-5/files/6044634
+      CF_SLUG: skyfactory-5
+      CF_FILENAME_MATCHER: 5.0.2
+      # Loads from .env file
+      CF_API_KEY: ${CF_API_KEY}
+      MEMORY: 4G
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+volumes:
+  mc-data:

files/cf-exclude-include.json

@@ -138,11 +138,18 @@
     "all-of-fabric-6": {
       "forceIncludes": ["revelationary"]
     },
-    "valhelsia-5": {
-      "excludes": ["modernfix"]
-    },
     "create-arcane-engineering": {
       "forceIncludes": ["just-enough-resources-jer"]
+    },
+    "skyfactory-5": {
+      "forceIncludes": [
+        "colored-torches",
+        "dye-mob-dye",
+        "openstairs"
+      ]
+    },
+    "valhelsia-5": {
+      "excludes": ["modernfix"]
     }
   }
 }

files/modrinth-exclude-include.json

@@ -22,7 +22,10 @@
     "cherishedworlds",
     "citresewn",
     "clickadv",
+    "connectedness",
     "connector",
+    "craftpresence",
+    "cwb",
     "DisableCustomWorldsAdvice",
     "drippyloadingscreen",
     "eating-animation",
@@ -36,6 +39,8 @@
     "fancymenu",
     "fast-ip-ping",
     "FauxCustomEntityData",
+    "feytweaks",
+    "figura",
     "GeckoLibIrisCompat",
     "gpumemleakfix",
     "Highlighter",
@@ -60,9 +65,11 @@
     "PickUpNotifier",
     "PresenceFootsteps",
     "Prism",
+    "reforgium",
     "reeses_sodium_options",
     "ResourcePackOverrides",
     "ryoamiclights",
+    "screenshot_viewer",
     "Searchables",
     "seasonhud",
     "ShoulderSurfing",
@@ -73,7 +80,8 @@
     "VR-Combat",
     "YeetusExperimentus",
     "yungsmenutweaks",
-    "Zoomify"
+    "Zoomify",
+    "zume"
   ],
   "globalForceIncludes": [],
   "modpacks": {}

scripts/start-deployCanyon

@@ -18,10 +18,10 @@ githubUrl="https://github.com/KoboDev/SupplyAndDemand/releases/download"
 canyonBuildJSON=$(curl -fsSL "${canyonJob}/${CANYON_BUILD}/api/json")
 
 buildRelPath=$(
-    jq '.artifacts[0].relativePath' <<< "$canyonBuildJSON"
+    jq -r '.artifacts[0].relativePath' <<< "$canyonBuildJSON"
 ) 
 buildNumber=$(
-    jq '.number'<<< "$canyonBuildJSON"
+    jq -r '.number'<<< "$canyonBuildJSON"
 )
 baseName=$(basename "${buildRelPath}")
 
@@ -50,7 +50,7 @@ if [ ! -f "$SERVER" ]; then
     fi
     curl -fsSL -o "$SERVER" "$downloadUrl"
     if [ ! -f "$SERVER" ]; then
-      logError "Failed to download from $downloadUrl (status=$?)"
+      logError "Failed to download from $downloadUrl"
       exit 3
     fi
 fi

scripts/start-deployKetting

@@ -17,12 +17,12 @@ export SERVER
 
 resolveVersion
 
-EXTRA_ARGS+="-minecraftVersion $VERSION"
+EXTRA_ARGS+=" -minecraftVersion $VERSION"
 if [[ ${KETTING_VERSION:-} ]]; then
-  EXTRA_ARGS+="-kettingVersion $KETTING_VERSION"
+  EXTRA_ARGS+=" -kettingVersion $KETTING_VERSION"
 fi
 if [[ ${FORGE_VERSION:-} ]]; then
-  EXTRA_ARGS+="-forgeVersion $FORGE_VERSION"
+  EXTRA_ARGS+=" -forgeVersion $FORGE_VERSION"
 fi
 export EXTRA_ARGS
 

scripts/start-deployMohist

@@ -9,39 +9,46 @@ isDebugging && set -x
 resolveVersion
 : "${MOHIST_BUILD:=lastSuccessfulBuild}"
 
-mohistBaseUrl=https://ci.codemc.io/job/MohistMC/
-mohistJobs=${mohistBaseUrl}job/
-mohistJob=${mohistJobs}Mohist-${VERSION}/
+mohistBaseUrl="https://mohistmc.com/api/v2/projects/mohist/"
+mohistApiUrl="${mohistBaseUrl}${VERSION}/builds/"
 
 function logMohistAvailableVerisons(){
   logError "       check ${mohistBaseUrl} for available versions"
   logError "       and set VERSION accordingly"
 }
 
-if ! get --exists "${mohistJob}"; then
+if ! get --exists "${mohistApiUrl}"; then
   logError "Mohist builds do not exist for ${VERSION}"
   logMohistAvailableVerisons
   exit 1
 fi
 
-buildRelPath=$(
-  get --json-path '$.artifacts[0].relativePath' "${mohistJob}${MOHIST_BUILD}/api/json"
+if [[ "${MOHIST_BUILD}" == "lastSuccessfulBuild" ]]; then
+  # Get the latest build number from the API
+  buildNumber=$(
+    get --json-path '$.builds[-1].number' "${mohistApiUrl}"
+  )
+  MOHIST_BUILD="${buildNumber}"
+fi
+
+downloadUrl=$(
+  get --json-path "$.builds[?(@.number==${MOHIST_BUILD})].url" "${mohistApiUrl}"
 )
 
-baseName=$(basename "${buildRelPath}")
-if [[ ${baseName} != *-server.jar* ]]; then
-  logError "Mohist build for ${VERSION} is not a valid server jar, found ${baseName}"
+if [[ -z "${downloadUrl}" ]]; then
+  logError "Could not find build ${MOHIST_BUILD} for version ${VERSION}"
   logMohistAvailableVerisons
   exit 1
 fi
 
-export SERVER="/data/${baseName}"
+SERVER="/data/mohist-${VERSION}-${MOHIST_BUILD}-server.jar"
 
 if [ ! -f "${SERVER}" ]; then
-  log "Downloading ${baseName}"
-  get -o "${SERVER}" "${mohistJob}${MOHIST_BUILD}/artifact/${buildRelPath}"
+  log "Downloading Mohist build ${MOHIST_BUILD} for ${VERSION}"
+  get -o "${SERVER}" "${downloadUrl}"
 fi
 
 export FAMILY=HYBRID
+export SERVER
 
 exec "${SCRIPTS:-/}start-spiget" "$@"

scripts/start-setupDatapack

@@ -41,8 +41,13 @@ if [[ "$DATAPACKS" ]]; then
         exit 2
       fi
     elif [[ -d "$i" ]]; then
-      log "Copying datapacks from $i ..."
-      cp "$i"/*.zip "${out_dir}"
+      if [[ -f "$i/pack.mcmeta" ]]; then
+        log "Copying datapack from $i"
+        cp -r "$i" "${out_dir}"
+      else
+        log "Copying datapacks from $i ..."
+        cp "$i"/*.zip "${out_dir}"
+      fi
     else
       logError "Invalid URL or path given in DATAPACKS: $i"
       exit 2

scripts/start-setupModpack

@@ -155,6 +155,7 @@ function handleGenericPacks() {
   : "${GENERIC_PACKS:=${GENERIC_PACK}}"
   : "${GENERIC_PACKS_PREFIX:=}"
   : "${GENERIC_PACKS_SUFFIX:=}"
+  : "${GENERIC_PACKS_DISABLE_MODS:=}"
 
   if [[ "${GENERIC_PACKS}" ]]; then
     IFS=',' read -ra packs <<< "${GENERIC_PACKS}"
@@ -192,6 +193,12 @@ function handleGenericPacks() {
         extract "${pack}" "${base_dir}"
       done
 
+      # Disable mods
+      for mod in ${GENERIC_PACKS_DISABLE_MODS}; do
+        log Disabling $mod
+        find "${base_dir}" -name "$mod" -exec mv {} {}.disabled -v \;
+      done
+
       # Remove any eula file since container manages it
       rm -f "${base_dir}/eula.txt"