Download paper.yml and bukkit.yml (#3217)

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

@@ -128,7 +128,7 @@ jobs:
             org.opencontainers.image.authors=Geoff Bourne <itzgeoff@gmail.com>
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v3.7.1
+        uses: docker/setup-buildx-action@v3.8.0
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3.2.0

.github/workflows/verify-pr.yml

@@ -53,7 +53,7 @@ jobs:
           fetch-depth: 0
 
       - name: Setup Docker Buildx
-        uses: docker/setup-buildx-action@v3.7.1
+        uses: docker/setup-buildx-action@v3.8.0
 
       - name: Confirm multi-arch build
         uses: docker/build-push-action@v6.10.0

Dockerfile

@@ -50,7 +50,7 @@ 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.6
+ARG MC_HELPER_VERSION=1.40.7
 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
@@ -64,7 +64,7 @@ WORKDIR /data
 STOPSIGNAL SIGTERM
 
 # End user MUST set EULA and change RCON_PASSWORD
-ENV TYPE=VANILLA VERSION=LATEST EULA="" UID=1000 GID=1000
+ENV TYPE=VANILLA VERSION=LATEST EULA="" UID=1000 GID=1000 LC_ALL=en_US.UTF-8
 
 COPY --chmod=755 scripts/start* /
 COPY --chmod=755 bin/ /usr/local/bin/

build/ol/install-packages.sh

@@ -46,6 +46,7 @@ dnf install -y \
   libwebp \
   findutils \
   which \
+  glibc-langpack-en \
   ${EXTRA_DNF_PACKAGES}
 
 # Install Git LFS

docs/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.8
+FROM python:3.9
 
 RUN pip install --upgrade pip
 

docs/misc/autopause-autostop/autopause.md

@@ -16,7 +16,7 @@ A file called `.paused` is created in `/data` directory when the server is pause
 
 A `.skip-pause` file can be created in the `/data` directory to make the server skip autopausing, for as long as the file is present. The autopause timer will also be reset.
 
-A starting, example compose file has been provided in [examples/docker-compose-autopause.yml](https://github.com/itzg/docker-minecraft-server/blob/master/examples/docker-compose-autopause.yml).
+A starting, example compose file has been provided in [the examples](https://github.com/itzg/docker-minecraft-server/blob/master/examples/autopause/compose.yml).
 
 Auto-pause is not compatible with `EXEC_DIRECTLY=true` and the two cannot be set together.
 

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

@@ -22,22 +22,27 @@ The following formats are supported in the list of project-file references:
 - Project ID, such as `238222`. _The newest applicable file will be automatically selected._
 - Project slug or ID, `:`, and a file ID, such as `jei:4593548` or `238222:4593548`
 - Project slug or ID, `@`, and a partial filename, such as `jei@10.2.1.1005`. This option is useful to refer to a version of the mod/plugin rather than looking up the file ID.
+- An `@` followed by the **container path** to a listing file
 
-An `@` followed by the container path to a listing file can also be provided as a project-file reference. Each line is processed as a reference where blank lines and comments that start with `#` are ignored.
+!!! info "More about listing files"
 
-For example, `CURSEFORGE_FILES` can be set to "@/extras/cf-mods.txt" where the container file `/extras/cf-mods.txt` contains
+    Each line in the listing file is processed as one of the references above; however, blank lines and comments that start with `#` are ignored.
+    
+    Make sure to place the listing file in a mounted directory/volume or declare an appropriate mount for it.
+    
+    For example, `CURSEFORGE_FILES` can be set to "@/extras/cf-mods.txt", assuming "/extras" has been added to `volumes` section, where the container file `/extras/cf-mods.txt` contains
+    
+    ```text
+    # This comment is ignored
+    jei:10.2.1.1005
+    
+    # This and previous blank line are ignore
+    geckolib
+    aquaculture
+    naturalist
+    ```
 
-```text
-# This comment is ignored
-jei:10.2.1.1005
-
-# This and previous blank line are ignore
-geckolib
-aquaculture
-naturalist
-```
-
-!!! tip "Docker Compose"
+!!! tip "Multi-line values in Docker Compose"
 
     Making use of the space delimited option, compose file declarations can be organized nicely with a [multi-line string](https://yaml-multiline.info/), such as
     

docs/mods-and-plugins/modrinth.md

@@ -1,8 +1,8 @@
 # Auto-download from Modrinth
 
-[Modrinth](https://modrinth.com/) is an open source modding platform with a clean, easy to use website for finding [Fabric and Forge mods](https://modrinth.com/mods). At startup, the container will automatically locate and download the newest versions of mod/plugin files that correspond to the `TYPE` and `VERSION` in use. Older file versions downloaded previously will automatically be cleaned up.
+[Modrinth](https://modrinth.com/) is an open source modding platform with a clean, easy to use website for finding [Fabric, Forge, etc mods](https://modrinth.com/mods) and [Paper, etc plugins](https://modrinth.com/plugins), and [datapacks](https://modrinth.com/datapacks). At startup, the container will automatically locate and download the newest versions of mod/plugin files that correspond to the `TYPE` and `VERSION` in use. Older file versions downloaded previously will automatically be cleaned up.
 
-- **MODRINTH_PROJECTS** : comma or newline separated list of project slugs (short name) or IDs. The project ID is located in the "Technical information" section. The slug is the part of the page URL that follows `/mod/`:
+- **MODRINTH_PROJECTS** : comma or newline separated list of project slugs (short name) or IDs. The project ID is located in the "Technical information" section. The project slug is the part of the URL that follows `/mod/`, `/plugin/`, or `/datapack/`. For example:
   ```
     https://modrinth.com/mod/fabric-api
                              ----------

docs/requirements.txt

@@ -1,4 +1,4 @@
-mkdocs-material == 9.5.47
+mkdocs-material == 9.5.49
 mkdocs-autorefs == 1.2.0
 mkdocstrings == 0.27.0
 mkdocs-literate-nav == 0.6.1

docs/types-and-platforms/server-types/bukkit-spigot.md

@@ -1,5 +1,9 @@
 # Bukkit/Spigot
 
+!!! failure "GetBukkit site no longer supports automated downloads"
+
+    The downloads provider <https://getbukkit.org> seems to no longer support automated downloads. As such, it is highly recommended to switch to [Paper](paper.md) instead since it is actively maintained and fully compatible with Bukkit/Spigot plugins.
+
 Run a Bukkit/Spigot server type by setting the environment variable `TYPE` to "BUKKIT" or "SPIGOT".
 
 !!! example

examples/craftoria/docker-compose.yml

@@ -0,0 +1,34 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    tty: true
+    stdin_open: true
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: true
+      ALLOW_FLIGHT: true
+      MOD_PLATFORM: AUTO_CURSEFORGE
+      # allocate from https://console.curseforge.com/ and set in .env file
+      CF_API_KEY: ${CF_API_KEY}
+      CF_SLUG: craftoria
+      MEMORY: 8G
+      CF_EXCLUDE_MODS: |
+        737481
+        363363
+        394468
+        986380
+        844662
+        568563
+        915902
+        690971
+        455508
+        1089803
+        511319
+    volumes:
+      # Use managed volume by default, but can change to a relative path like
+      # ./data:/data
+      # to use a host directory
+      - mc-data:/data
+volumes:
+  mc-data:

examples/gtnh/docker-compose.yaml

@@ -0,0 +1,23 @@
+services:
+  mc:
+    # make sure this java version matches with pack java version
+    image: itzg/minecraft-server:java21
+    tty: true
+    stdin_open: true
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "TRUE"
+      TYPE: CUSTOM
+      GENERIC_PACKS: GT_New_Horizons_2.7.1_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"
+      # 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"
+    volumes:
+      # attach the relative directory 'data' to the container's /data path
+      - mc-data:/data
+volumes:
+  mc-data:

examples/rad2/compose.yaml

@@ -14,11 +14,8 @@ services:
       #CF_FILENAME_MATCHER: "0.2.34"
       CF_EXCLUDE_MODS: |
         controlling
-        craftpresence
         creative-core
         default-options
-        equipment-compare
-        item-borders
         itemphysic-lite
         konkrete
         oauth

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

@@ -1,17 +1,18 @@
 services:
   mc:
-    image: itzg/minecraft-server
+    image: itzg/minecraft-server:java17
     ports:
       - "25565:25565"
     environment:
       EULA: "true"
       MODPACK_PLATFORM: AUTO_CURSEFORGE
-      CF_API_KEY: # allocate from https://console.curseforge.com/
+      # allocate from https://console.curseforge.com/
+      CF_API_KEY: ${CF_API_KEY}
       CF_SLUG: vault-hunters-1-18-2
-      CF_FILENAME_MATCHER: "Update-10.0.0"
-      MOTD: "§4----- §2 Vault Hunters: 1.18.2u10.0.0 §4 -----§r\\n     §4------ §e vaulthunters.gg  §4------"
+      MOTD: "§4----- §2 Vault Hunters: 1.18.2 §4 -----§r\\n     §4------ §e vaulthunters.gg  §4------"
       MEMORY: 6G # 4G for base server + 2G per player
-      CF_EXCLUDE_MODS: reauth
+      CF_EXCLUDE_MODS: |
+        reauth
       ALLOW_FLIGHT: true
       ENABLE_COMMAND_BLOCK: true
       DIFFICULTY: hard
@@ -19,4 +20,4 @@ services:
       - mc-data:/data
 
 volumes:
-  mc-data: {}
+  mc-data: {}

files/cf-exclude-include.json

@@ -26,6 +26,7 @@
     "clickable-advancements",
     "configured",
     "controlling",
+    "craftpresence",
     "ctm",
     "custom-main-menu",
     "dark-mode-everywhere",
@@ -44,6 +45,7 @@
     "entity-collision-fps-fix",
     "entity-texture-features-fabric",
     "entityculling",
+    "equipment-compare",
     "extreme-sound-muffler",
     "ezzoom",
     "fading-night-vision",
@@ -61,6 +63,8 @@
     "inmisaddon",
     "iris-flywheel-compat",
     "irisshaders",
+    "item-borders",
+    "item-highlighter",
     "item-obliterator",
     "itemphysic-lite",
     "itemzoom",
@@ -125,6 +129,9 @@
     "vanillafix",
     "visuality",
     "waila-harvestability",
+    "wawla",
+    "xaeroplus",
+    "yungs-menu-tweaks",
     "zume"
   ],
   "modpacks": {

scripts/start-deployFTBA

@@ -62,8 +62,11 @@ elif ! [[ ${FTB_MODPACK_VERSION_ID} =~ [0-9]+ ]]; then
   exit 1
 fi
 
-if isTrue "$FTB_FORCE_REINSTALL" || ! [ -f "${ftbManifest}" ] || ! [ -f "${ftbInstallMarker}" ] || [ "$(cat "${ftbInstallMarker}")" != "${FTB_MODPACK_ID}=${FTB_MODPACK_VERSION_ID}" ]; then
-  ftbInstaller=/data/ftb-installer
+if isTrue "$FTB_FORCE_REINSTALL" ||
+  ! [ -f "${ftbManifest}" ] ||
+  ! [ -f "${ftbInstallMarker}" ] ||
+  [ "$(cat "${ftbInstallMarker}")" != "${FTB_MODPACK_ID}=${FTB_MODPACK_VERSION_ID}" ]; then
+  ftbInstaller=/data/ftb-installer-v2
   arm=
   if ! [[ -f "${ftbInstaller}" ]]; then
     if [ "$(uname -m)" == "aarch64" ]; then

scripts/start-deployPaper

@@ -42,11 +42,18 @@ else
   applyResultsFile ${resultsFile}
 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
+defaultTopLevelConfigs="bukkit.yml spigot.yml"
+if versionLessThan 1.19; then
+  defaultTopLevelConfigs+=" paper.yml"
+else
+  # Download default configs to allow for consistent patching
+  DOWNLOAD_DEFAULT_CONFIGS=$(buildDownloadList "$PAPER_CONFIG_DEFAULTS_REPO" "$VERSION" paper-global.yml paper-world-defaults.yml)
+  export DOWNLOAD_DEFAULT_CONFIGS
+fi
+
+# Download top-level configs to allow for consistent patching
+DOWNLOAD_DEFAULTS=$(buildDownloadList "$PAPER_CONFIG_DEFAULTS_REPO" "$VERSION" $defaultTopLevelConfigs)
+export DOWNLOAD_DEFAULTS
 
 # Normalize on Spigot for downstream operations
 export FAMILY=SPIGOT

scripts/start-deployPurpur

@@ -15,7 +15,7 @@ if [[ $PURPUR_DOWNLOAD_URL ]]; then
   if ! mc-image-helper install-purpur \
     --output-directory=/data \
     --results-file="$resultsFile" \
-    --url="$PURPUR_DOWNLOAD_URL}"; then
+    --url="${PURPUR_DOWNLOAD_URL}"; then
       logError "Failed to download from custom Purpur URL"
       exit 1
   fi

scripts/start-setupEnvVariables

@@ -36,6 +36,15 @@ if [[ $DOWNLOAD_DEFAULT_CONFIGS ]]; then
     logWarning "One or more default config files were not available from $DOWNLOAD_DEFAULT_CONFIGS"
   fi
 fi
+if [[ $DOWNLOAD_DEFAULTS ]]; then
+  log "Downloading default top-level configs, if needed"
+  if ! mc-image-helper mcopy \
+    --to /data \
+    --skip-existing --skip-up-to-date=false \
+    "$DOWNLOAD_DEFAULTS" 2> /dev/null; then
+    logWarning "One or more default files were not available from $DOWNLOAD_DEFAULTS"
+  fi
+fi
 
 if [[ ${PATCH_DEFINITIONS} ]]; then
   log "Applying patch definitions from ${PATCH_DEFINITIONS}"

scripts/start-utils

@@ -513,3 +513,17 @@ function ensureRemoveAllModsOff() {
     REMOVE_OLD_MODS=false
   fi
 }
+
+function buildDownloadList() {
+  repoUrl=${1?}
+  version=${2?}
+  shift 2
+  result=
+  for c in "${@}"; do
+    if [[ $result ]]; then
+      result+=","
+    fi
+    result+="${repoUrl}/${version}/$c"
+  done
+  echo "$result"
+}