Corrected stable tag build configuration (#2249)

Also
- removed carry-on from default exclusions

.github/workflows/build-multiarch.yml

@@ -102,6 +102,7 @@ jobs:
     env:
       IMAGE_TO_TEST: ${{ github.repository_owner }}/minecraft-server:test-${{ matrix.variant }}-${{ github.run_id }}
       HAS_IMAGE_REPO_ACCESS: ${{ secrets.DOCKER_USER != '' && secrets.DOCKER_PASSWORD != '' }}
+      MAIN_VARIANT: java17
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
@@ -120,14 +121,20 @@ jobs:
             ${{ github.repository_owner }}/minecraft-server
             ghcr.io/${{ github.repository_owner }}/minecraft-server
           tags: |
-            type=ref,event=tag,enable=${{ matrix.variant == 'java17' }}
+            # For the "main" variant, it gets the tag as-is, without suffix
+            type=ref,event=tag,enable=${{ matrix.variant == env.MAIN_VARIANT }}
+            # and each variant (including main one) gets the tag with the variant suffix, such as 2023.1.1-java17
             type=ref,event=tag,suffix=-${{ matrix.variant }}
+            # latest repo tag gets a moving 'stable' image tag applied to the main variant
+            type=pep440,value=stable,enable=${{ matrix.variant == env.MAIN_VARIANT }},pattern={{version}}
+            # for building test/* branch images
             type=ref,event=branch,suffix=-${{ matrix.variant }},enable=${{ github.ref_name != 'master' }}
+            # 
             type=raw,value=${{ matrix.variant }},enable=${{ github.ref_name == 'master' }}
           # NOTE this identifies which variant will be published as "latest", which isn't
           # necessarily the newest version of Java
           flavor: |
-            latest=${{ matrix.variant == 'java17' && github.ref_name == 'master' }}
+            latest=${{ matrix.variant == env.MAIN_VARIANT && github.ref_name == 'master' }}
           labels: |
             org.opencontainers.image.authors=Geoff Bourne <itzgeoff@gmail.com>
 
@@ -138,7 +145,7 @@ jobs:
         uses: docker/setup-qemu-action@v2.2.0
 
       - name: Build for test
-        uses: docker/build-push-action@v4.1.0
+        uses: docker/build-push-action@v4.1.1
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -177,7 +184,7 @@ jobs:
           password: ${{ github.token }}
 
       - name: Build and push
-        uses: docker/build-push-action@v4.1.0
+        uses: docker/build-push-action@v4.1.1
         if: github.actor == github.repository_owner
         with:
           platforms: ${{ matrix.platforms }}

.github/workflows/verify-pr.yml

@@ -54,7 +54,7 @@ jobs:
         uses: docker/setup-buildx-action@v2
 
       - name: Confirm multi-arch build
-        uses: docker/build-push-action@v4.1.0
+        uses: docker/build-push-action@v4.1.1
         with:
           platforms: ${{ matrix.platforms }}
           # ensure latest base image is used
@@ -64,7 +64,7 @@ jobs:
           cache-from: type=gha,scope=${{ matrix.variant }}
 
       - name: Build for test
-        uses: docker/build-push-action@v4.1.0
+        uses: docker/build-push-action@v4.1.1
         with:
           # Only build single platform since loading multi-arch image into daemon fails with
           # "docker exporter does not currently support exporting manifest lists"

Dockerfile

@@ -46,7 +46,7 @@ RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=0.1.1 --var app=maven-metadata-release --file {{.app}} \
   --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_HELPER_VERSION=1.31.0
+ARG MC_HELPER_VERSION=1.32.4
 ARG MC_HELPER_BASE_URL=https://github.com/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION}
 # used for cache busting local copy of mc-image-helper
 ARG MC_HELPER_REV=1

docs/index.md

@@ -29,7 +29,7 @@ where, in this case, the standard server port 25565, will be exposed on your hos
 
     **DO NOT** port forward RCON on 25575 without first setting `RCON_PASSWORD` to a secure value. It is highly recommended to only use RCON within the container, such as with `rcon-cli`. 
 
-By default, the container will download the latest version of the "vanilla" [Minecraft: Java Edition server](https://www.minecraft.net/en-us/download/server) provided by Mojang. The [`VERSION`](versions/java.md) and the [`TYPE`](types-and-platforms/) can be configured to create many variations of desired Minecraft server. 
+By default, the container will download the latest version of the "vanilla" [Minecraft: Java Edition server](https://www.minecraft.net/en-us/download/server) provided by Mojang. The [`VERSION`](versions/java.md) and the [`TYPE`](types-and-platforms/index.md) can be configured to create many variations of desired Minecraft server. 
 
 ## Using [Docker Compose](https://docs.docker.com/compose/)
 
@@ -59,8 +59,8 @@ 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 "Full Setup Example"
-    Here is a [reference guide to setting up a server from scratch using docker compose](misc/deployment/docker-compose-full-example/).
+!!! note "More Compose Examples"
+    There are more [examples located in the Github repo](https://github.com/itzg/docker-minecraft-server/tree/master/examples).
 
-!!! note "More Examples"
-    There are more [examples located in the Github repo](https://github.com/itzg/docker-minecraft-server/tree/master/examples).
+!!! note "Deployment Examples"
+    The [deployments page](misc/deployment/index.md) provides more examples of deployment with and beyond Docker Compose.

docs/misc/autopause-autostop/autopause.md

@@ -1,20 +1,14 @@
-# AutoPause
+# Auto-Pause
 
-### Description
+An auto-pause functionality is provided that monitors whether clients are connected to the server. If a client is not connected for a specified time, the Java process is put into a pause state. When a client attempts to connect while the process is paused, then process will be restored to a running state. The experience for the client does not change. This feature can be enabled by setting the environment variable `ENABLE_AUTOPAUSE` to "true".
 
-There are various bug reports on [Mojang](https://bugs.mojang.com) about high CPU usage of servers with newer versions, even with few or no clients connected (e.g. [this one](https://bugs.mojang.com/browse/MC-149018), in fact the functionality is based on [this comment in the thread](https://bugs.mojang.com/browse/MC-149018?focusedCommentId=593606&page=com.atlassian.jira.plugin.system.issuetabpanels%3Acomment-tabpanel#comment-593606)).
+!!! important
 
-An autopause functionality has been added to this image to monitor whether clients are connected to the server. If for a specified time no client is connected, the Java process is stopped. When knocking on the server port (e.g. by the ingame Multiplayer server overview), the process is resumed. The experience for the client does not change.
-
-Of course, even loaded chunks are not ticked when the process is stopped.
-
-**You must greatly increase or disable max-tick-time watchdog functionality.** From the server's point of view, the pausing causes a single tick to take as long as the process is stopped, so the server watchdog might intervene after the process is continued, possibly forcing a container restart. To prevent this, ensure that the `max-tick-time` in the `server.properties` file is set to a very large value or -1 to disable it entirely, which is highly recommended. That can be set with `MAX_TICK_TIME` as described in [the section below](../../configuration/server-properties.md#max-tick-time).
-
-!!! note 
+    **You must greatly increase or disable max-tick-time watchdog functionality.** From the server's point of view, the pausing causes a single tick to take as long as the process is stopped, so the server watchdog might intervene after the process is continued, possibly forcing a container restart. To prevent this, ensure that the `max-tick-time` in the `server.properties` file is set to a very large value or -1 to disable it entirely, which is highly recommended. That can be set with `MAX_TICK_TIME` as described in [the section below](../../configuration/server-properties.md#max-tick-time).
 
     Non-vanilla versions might have their own configuration file, you might have to disable their watchdogs separately. For PaperMC servers, you need to send the JVM flag `-Ddisable.watchdog=true`, this can be done with the docker env variable `-e JVM_DD_OPTS=disable.watchdog:true`
 
-On startup the `server.properties` file is checked and, if applicable, a warning is printed to the terminal. When the server is created (no data available in the persistent directory), the properties file is created with the Watchdog disabled.
+    On startup the `server.properties` file is checked and, if applicable, a warning is printed to the terminal. When the server is created (no data available in the persistent directory), the properties file is created with the Watchdog disabled.
 
 The utility used to wake the server (`knock(d)`) works at network interface level. So the correct interface has to be set using the `AUTOPAUSE_KNOCK_INTERFACE` variable when using non-default networking environments (e.g. host-networking, Portainer oder NAS solutions). See the description of the variable below.
 
@@ -22,20 +16,14 @@ A file called `.paused` is created in `/data` directory when the server is pause
 
 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).
 
-### Enabling Autopause
-
-Enable the Autopause functionality by setting:
-
-```
--e ENABLE_AUTOPAUSE=TRUE
-```
-
-Autopause is not compatible with `EXEC_DIRECTLY=true` and the two cannot be set together.
+Auto-pause is not compatible with `EXEC_DIRECTLY=true` and the two cannot be set together.
 
 !!! note 
 
     When configuring kubernetes readiness/liveness health checks with auto-pause enabled, be sure to reference the `mc-health` wrapper script rather than `mc-status` directly.
 
+## Additional configuration
+
 The following environment variables define the behaviour of auto-pausing:
 
 - `AUTOPAUSE_TIMEOUT_EST`, default `3600` (seconds)
@@ -53,7 +41,7 @@ The following environment variables define the behaviour of auto-pausing:
 
     To troubleshoot, add `DEBUG_AUTOPAUSE=true` to see additional output
 
-### Rootless Autopause
+## Rootless Auto-Pause
 
 If you're running the container as rootless, you might need to set change the default port forwarder from RootlessKit to slirp4netns.
 

docs/misc/autopause-autostop/autostop.md

@@ -1,4 +1,4 @@
-# AutoStop
+# Auto-Stop
 
 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.
 

docs/misc/contributing/development.md

@@ -55,14 +55,14 @@ docker run -it --rm -v ${PWD}:/scripts -e SCRIPTS=/scripts/ --entrypoint bash mc
 From within the container you can run individual scripts via the attached `/scripts/` path; however, be sure to set any environment variables expected by the scripts by either `export`ing them manually:
 
 ```shell script
-export VANILLA_VERSION=1.12.2
+export VERSION=1.12.2
 /scripts/start-magma
 ```
 
 ...or pre-pending script execution:
 
 ```shell script
-VANILLA_VERSION=1.12.2 /scripts/start-magma
+VERSION=1.12.2 /scripts/start-magma
 ```
 
 > NOTE: You may want to temporarily add an `exit` statement near the end of your script to isolate execution to just the script you're developing.

docs/misc/deployment/aws.md

@@ -1 +0,0 @@
-If you're looking for a simple way to deploy this to the Amazon Web Services Cloud, check out the [Minecraft Server Deployment (CloudFormation) repository](https://github.com/vatertime/minecraft-spot-pricing). This repository contains a CloudFormation template that will get you up and running in AWS in a matter of minutes. Optionally it uses Spot Pricing so the server is very cheap, and you can easily turn it off when not in use.

docs/misc/deployment/docker-compose.md

@@ -1,26 +0,0 @@
-Rather than type the server options below, the port mappings above, etc
-every time you want to create new Minecraft server, you can now use
-[Docker Compose](https://docs.docker.com/compose/). Start with a
-`docker-compose.yml` file like the following:
-
-``` yaml
-version: "3"
-
-services:
-  mc:
-    image: itzg/minecraft-server
-    ports:
-      - 25565:25565
-    environment:
-      EULA: "TRUE"
-    tty: true
-    stdin_open: true
-    restart: unless-stopped
-```
-
-and in the same directory as that file run
-
-    docker-compose up -d
-
-Now, go play...or adjust the `environment` section to configure
-this server instance.

docs/misc/deployment/helmcharts.md

@@ -1,8 +0,0 @@
-- itzg Helm Chart:
-    - [GitHub repo](https://github.com/itzg/minecraft-server-charts)
-    - [Helm Chart repo](https://itzg.github.io/minecraft-server-charts/)
-- [mcsh/server-deployment](https://github.com/mcserverhosting-net/charts)
-
-### Examples
-
-The [examples directory](https://github.com/itzg/docker-minecraft-server/tree/master/examples) also provides examples of deploying the [itzg/minecraft-server](https://hub.docker.com/r/itzg/minecraft-server/) Docker image.

docs/misc/deployment/index.md

@@ -1,10 +1,22 @@
+# More Deployment Info 
+
+## Using Helm
+
+- itzg Helm Chart:
+    - [GitHub repo](https://github.com/itzg/minecraft-server-charts)
+      - [Helm Chart repo](https://itzg.github.io/minecraft-server-charts/)
+- [mcsh/server-deployment](https://github.com/mcserverhosting-net/charts)
+
 ## Supporting Articles
 
 Below are supporting articles for server deployment.
 
-
 - "Zero to Minecraft Server with Docker Desktop and Compose"
 
     https://dev.to/rela-v/zero-to-minecraft-server-with-docker-desktop-and-compose-500a
 
     - This is a reference guide/tutorial on how to set up a vanilla Minecraft server using this project, including step-by-step instructions, and information on topics such as port-forwarding.
+
+## Deploying onto AWS
+
+If you're looking for a simple way to deploy this to the Amazon Web Services Cloud, check out the [Minecraft Server Deployment (CloudFormation) repository](https://github.com/vatertime/minecraft-spot-pricing). This repository contains a CloudFormation template that will get you up and running in AWS in a matter of minutes. Optionally it uses Spot Pricing so the server is very cheap, and you can easily turn it off when not in use.

examples/atm8/docker-compose.yml

@@ -7,7 +7,7 @@ services:
       - "25565:25565"
     environment:
       EULA: "true"
-      TYPE: AUTO_CURSEFORGE
+      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/all-the-mods-8

examples/docker-compose-fabric.yml

@@ -2,12 +2,12 @@ version: "3"
 
 services:
   mc:
-    image: ${IMAGE:-itzg/minecraft-server}
+    image: itzg/minecraft-server
     environment:
       EULA: "true"
       TYPE: FABRIC
     ports:
-      - 25565:25565
+      - "25565:25565"
     volumes:
       - fabric:/data
 

examples/modrinth-modpack/docker-compose.yml

@@ -9,7 +9,7 @@ services:
       - "25565:25565"
     environment:
       EULA: "TRUE"
-      TYPE: MODRINTH
+      MOD_PLATFORM: MODRINTH
       MODRINTH_PROJECT: https://modrinth.com/modpack/cobblemon-fabric/version/1.3.2
       # or for auto-upgrading to latest
       # MODRINTH_PROJECT: https://modrinth.com/modpack/cobblemon-fabric
@@ -18,7 +18,6 @@ services:
       # MODRINTH_VERSION: nvrqJg44
       # MODRINTH_VERSION: 1.3.2
       # MODRINTH_VERSION: "Cobblemon [Fabric] 1.3.2"
-      SETUP_ONLY: "true"
     volumes:
       # attach the relative directory 'data' to the container's /data path
       - ./data:/data

examples/modrinth-paper/docker-compose.yml

@@ -2,7 +2,7 @@ version: "3"
 
 services:
   mc:
-    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    image: itzg/minecraft-server
     environment:
       EULA: "true"
       TYPE: PAPER

examples/one-block-modded/docker-compose.yml

@@ -7,7 +7,7 @@ services:
       - "25565:25565"
     environment:
       EULA: "true"
-      TYPE: AUTO_CURSEFORGE
+      MOD_PLATFORM: AUTO_CURSEFORGE
       # CF_API_KEY=... must be set in .env file or as environment variable
       CF_API_KEY: ${CF_API_KEY}
       CF_SLUG: one-block-modded

examples/pixelmon/docker-compose.yml

@@ -7,7 +7,7 @@ services:
       - "25565:25565"
     environment:
       EULA: "true"
-      TYPE: AUTO_CURSEFORGE
+      MOD_PLATFORM: AUTO_CURSEFORGE
       CF_API_KEY: # allocate from https://console.curseforge.com/
       CF_SLUG: the-pixelmon-modpack
       CF_FILENAME_MATCHER: "9.1.2"

examples/quilt/docker-compose.yml

@@ -0,0 +1,15 @@
+version: "3"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: "true"
+      TYPE: QUILT
+    ports:
+      - "25565:25565"
+    volumes:
+      - data:/data
+
+volumes:
+  data: {}

examples/valhesia5/docker-compose.yml

@@ -7,7 +7,7 @@ services:
       - "25565:25565"
     environment:
       EULA: "true"
-      TYPE: AUTO_CURSEFORGE
+      MOD_PLATFORM: AUTO_CURSEFORGE
       CF_API_KEY: # allocate from https://console.curseforge.com/
       CF_FORCE_SYNCHRONIZE: "true"
       CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/valhelsia-5/files/4429560

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

@@ -7,7 +7,7 @@ services:
       - "25565:25565"
     environment:
       EULA: "true"
-      TYPE: AUTO_CURSEFORGE
+      MOD_PLATFORM: AUTO_CURSEFORGE
       CF_API_KEY: # allocate from https://console.curseforge.com/
       CF_SLUG: vault-hunters-1-18-2
       CF_FILENAME_MATCHER: "Update-10.0.0"

files/cf-exclude-include.json

@@ -4,7 +4,6 @@
     "armor-toughness-bar",
     "biomeinfo",
     "block-drops-jei-addon",
-    "carry-on",
     "cherished-worlds",
     "controlling",
     "ctm",

scripts/start-configuration

@@ -105,31 +105,6 @@ function fixJavaPath() {
   fi
 }
 
-function resolveVersion() {
-  VERSIONS_JSON=https://launchermeta.mojang.com/mc/game/version_manifest.json
-
-  case "X$VERSION" in
-    X|XLATEST|Xlatest)
-      if ! VANILLA_VERSION=$(get --json-path '$.latest.release' "$VERSIONS_JSON"); then
-        log "ERROR: version lookup failed: $VANILLA_VERSION"
-        exit 1
-      fi
-    ;;
-    XSNAPSHOT|Xsnapshot)
-      if ! VANILLA_VERSION=$(get --json-path '$.latest.snapshot' "$VERSIONS_JSON"); then
-        log "ERROR: version lookup failed: $VANILLA_VERSION"
-        exit 1
-      fi
-    ;;
-    *)
-      VANILLA_VERSION=$VERSION
-    ;;
-  esac
-  export VANILLA_VERSION
-  MAJOR_VANILLA_VERSION=$(get_major_version "$VANILLA_VERSION")
-  export MAJOR_VANILLA_VERSION
-  log "Resolved version given ${VERSION} into ${VANILLA_VERSION} and major version ${MAJOR_VANILLA_VERSION}"
-}
 
 if ! fixJavaPath; then
   log "ERROR: could not locate path that contains java"
@@ -187,8 +162,6 @@ if [[ $MOD_PLATFORM ]]; then
   esac
 fi
 
-resolveVersion
-
 log "Resolving type given ${TYPE}"
 case "${TYPE^^}" in
   *BUKKIT|SPIGOT)
@@ -204,7 +177,6 @@ case "${TYPE^^}" in
   ;;
 
   FORGE)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployForge" "$@"
   ;;
 
@@ -261,12 +233,6 @@ case "${TYPE^^}" in
   ;;
 
   CRUCIBLE)
-    log "**********************************************************************"
-    log "WARNING: The image tag itzg/minecraft-server:java8 is recommended"
-    log "         since some mods require Java 8"
-    log "         Exception traces reporting ClassCastException: class jdk.internal.loader.ClassLoaders\$AppClassLoader"
-    log "         can be fixed with java8"
-    log "**********************************************************************"
     exec "${SCRIPTS:-/}start-deployCrucible" "$@"
   ;;
 

scripts/start-deployAutoCF

@@ -66,13 +66,11 @@ if ! mc-image-helper install-curseforge "${args[@]}"; then
     exit 1
 fi
 
-# grab SERVER, FAMILY and export it
+# grab SERVER, TYPE, VERSION and export it
 set -a
 # shellcheck disable=SC1090
 source "${resultsFile}"
 set +a
-# grab the version resolved from modpack
-VANILLA_VERSION="$VERSION"
-export VANILLA_VERSION
+resolveFamily
 
 exec "${SCRIPTS:-/}start-setupWorld" "$@"

scripts/start-deployBukkitSpigot

@@ -1,6 +1,7 @@
 #!/bin/bash
 
-. ${SCRIPTS:-/}start-utils
+# shellcheck source=start-utils
+. "${SCRIPTS:-/}start-utils"
 isDebugging && set -x
 
 set -e
@@ -60,14 +61,14 @@ function downloadSpigot {
   esac
 
   if [[ ${VERSION^^} = LATEST ]]; then
-    VANILLA_VERSION=$(restify https://getbukkit.org/download/spigot --attribute='property=og:title' | jq -r '.[0] | .attributes | select(.property == "og:title") | .content | split(" ") | .[-1]')
+    VERSION=$(restify https://getbukkit.org/download/spigot --attribute='property=og:title' | jq -r '.[0] | .attributes | select(.property == "og:title") | .content | split(" ") | .[-1]')
   fi
 
   if [[ -z $downloadUrl ]]; then
-    if versionLessThan 1.16.5 || ([[ ${getbukkitFlavor} = "craftbukkit" ]] && [[ ${VANILLA_VERSION} = "1.16.5" ]]); then
-      downloadUrl="https://cdn.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VANILLA_VERSION}.jar"
+    if versionLessThan 1.16.5 || ([[ ${getbukkitFlavor} = "craftbukkit" ]] && [[ ${VERSION} = "1.16.5" ]]); then
+      downloadUrl="https://cdn.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VERSION}.jar"
     else
-      downloadUrl="https://download.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VANILLA_VERSION}.jar"
+      downloadUrl="https://download.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VERSION}.jar"
     fi
   fi
 
@@ -108,15 +109,16 @@ EOF
 function setServerVar {
   case "$TYPE" in
     *BUKKIT|*bukkit)
-      export SERVER=craftbukkit_server-${VANILLA_VERSION}.jar
+      export SERVER=craftbukkit_server-${VERSION}.jar
       ;;
     *)
-      export SERVER=spigot_server-${VANILLA_VERSION}.jar
+      export SERVER=spigot_server-${VERSION}.jar
       ;;
   esac
 }
 
 if isTrue "$BUILD_SPIGOT_FROM_SOURCE" || isTrue "$BUILD_FROM_SOURCE"; then
+  resolveVersion
   setServerVar
   if [ ! -f "$SERVER" ] || isTrue "$FORCE_REDOWNLOAD"; then
     buildSpigotFromSource

scripts/start-deployCF

@@ -24,6 +24,11 @@ loadForgeVars() {
 
 isDebugging && set -x
 
+if [[ ${VERSION^^} == LATEST ]]; then
+  log "WARNING for the old TYPE=CURSEFORGE mechanism it is best to set VERSION to a specific value"
+fi
+resolveVersion
+
 : "${FTB_BASE_DIR:=${CF_BASE_DIR:-/data/FeedTheBeast}}"
 export FTB_BASE_DIR
 

scripts/start-deployCrucible

@@ -6,7 +6,7 @@ set -o pipefail
 set -e
 isDebugging && set -x
 
-requireVar VANILLA_VERSION
+resolveVersion
 : "${CRUCIBLE_RELEASE:=latest}"
 
 crucibleReleasesUrl=https://api.github.com/repos/CrucibleMC/Crucible/releases
@@ -16,14 +16,14 @@ else
   crucibleReleaseUrl=${crucibleReleasesUrl}/tags/${CRUCIBLE_RELEASE}
 fi
 
-if ! downloadUrl=$(get --json-path "$.assets[?(@.name =~ /Crucible-${VANILLA_VERSION}-.*\.jar/)].browser_download_url" \
+if ! downloadUrl=$(get --json-path "$.assets[?(@.name =~ /Crucible-${VERSION}-.*\.jar/)].browser_download_url" \
     --accept "application/vnd.github.v3+json" "$crucibleReleaseUrl"); then
   log "ERROR: failed to access ${CRUCIBLE_RELEASE} release of Crucible"
   exit 1
 fi
 
 if [[ $downloadUrl = null ]]; then
-  log "ERROR: failed to locate Crucible jar for $VANILLA_VERSION from ${CRUCIBLE_RELEASE}"
+  log "ERROR: failed to locate Crucible jar for $VERSION from ${CRUCIBLE_RELEASE}"
   exit 1
 fi
 

scripts/start-deployFabric

@@ -19,9 +19,10 @@ if [[ $FABRIC_LAUNCHER ]]; then
   if ! mc-image-helper install-fabric-loader \
     --results-file=${resultsFile} \
     --from-local-file="$FABRIC_LAUNCHER"; then
-    log "ERROR failed to install Fabric launcher from $FABRIC_LAUNCHER"
+    log "ERROR failed to use provided Fabric launcher"
     exit 1
   fi
+
 # Custom fabric jar url
 elif [[ $FABRIC_LAUNCHER_URL ]]; then
   if ! mc-image-helper install-fabric-loader \
@@ -30,19 +31,21 @@ elif [[ $FABRIC_LAUNCHER_URL ]]; then
     log "ERROR failed to install Fabric launcher from $FABRIC_LAUNCHER_URL"
     exit 1
   fi
+
 # Official fabric launcher
 else
   if ! mc-image-helper install-fabric-loader \
     --results-file=${resultsFile} \
-    --minecraft-version="${VANILLA_VERSION}" \
+    --minecraft-version="${VERSION}" \
     --installer-version="${FABRIC_LAUNCHER_VERSION}" \
     --loader-version="${FABRIC_LOADER_VERSION}"; then
-    log "ERROR failed to install Fabric launcher from $VANILLA_VERSION, $FABRIC_LAUNCHER_VERSION, $FABRIC_LOADER_VERSION"
+    log "ERROR failed to install Fabric launcher given $VERSION, $FABRIC_LAUNCHER_VERSION, $FABRIC_LOADER_VERSION"
     exit 1
   fi
+
 fi
 
-# grab SERVER and export it
+# grab SERVER, etc and export it
 set -a
 # shellcheck disable=SC1090
 source "${resultsFile}"

scripts/start-deployForge

@@ -7,8 +7,6 @@
 . "${SCRIPTS:-$(dirname "$0")}/start-utils"
 isDebugging && set -x
 
-# NOTE: VERSION rather than VANILLA_VERSION is specified to allow for latest supported
-#       Forge version to be selected.
 if [[ ${FORGE_INSTALLER} ]]; then
   if ! mc-image-helper install-forge \
     --output-directory=/data \

scripts/start-deployMagma

@@ -4,10 +4,15 @@
 . "${SCRIPTS:-/}start-utils"
 isDebugging && set -x
 
-: "${VANILLA_VERSION?}"
+resolveVersion
 
-if ! downloadUrl=$(get --json-path '$.link' "https://api.magmafoundation.org/api/v2/${VANILLA_VERSION}/latest"); then
-  log "ERROR failed to locate latest Magma download for ${VANILLA_VERSION}. Is that version supported?"
+if ! downloadUrl=$(get --json-path '$.link' "https://api.magmafoundation.org/api/v2/${VERSION}/latest"); then
+  log "ERROR failed to locate latest Magma download for ${VERSION}. Is that version supported?"
+  exit 1
+fi
+
+if [[ $downloadUrl == null ]]; then
+  log "ERROR Magma does not seem to be available for $VERSION"
   exit 1
 fi
 

scripts/start-deployModrinth

@@ -48,13 +48,11 @@ if ! mc-image-helper install-modrinth-modpack "${args[@]}"; then
     exit 1
 fi
 
-# grab SERVER, FAMILY and export it
+# grab SERVER, TYPE, VERSION and export it
 set -a
 # shellcheck disable=SC1090
 source "${resultsFile}"
 set +a
-# grab the version resolved from modpack
-VANILLA_VERSION="$VERSION"
-export VANILLA_VERSION
+resolveFamily
 
 exec "${SCRIPTS:-/}start-setupWorld" "$@"

scripts/start-deployMohist

@@ -6,14 +6,14 @@ set -o pipefail
 set -e
 isDebugging && set -x
 
-requireVar VANILLA_VERSION
+resolveVersion
 : "${MOHIST_BUILD:=lastSuccessfulBuild}"
 
 mohistJobs=https://ci.codemc.io/job/MohistMC/job/
-mohistJob=${mohistJobs}Mohist-${VANILLA_VERSION}/
+mohistJob=${mohistJobs}Mohist-${VERSION}/
 
 if ! get --exists "${mohistJob}"; then
-  log "ERROR: mohist builds do not exist for ${VANILLA_VERSION}"
+  log "ERROR: mohist builds do not exist for ${VERSION}"
   log "       check https://ci.codemc.io/job/MohistMC/ for available versions"
   log "       and set VERSION accordingly"
   exit 1
@@ -25,7 +25,7 @@ buildRelPath=$(
 
 baseName=$(basename "${buildRelPath}")
 if [[ ${baseName} != *-server.jar* ]]; then
-  log "ERROR: mohist build for ${VANILLA_VERSION} is not a valid server jar, found ${baseName}"
+  log "ERROR: mohist build for ${VERSION} is not a valid server jar, found ${baseName}"
   log "       check https://ci.codemc.io/job/MohistMC/ for available versions"
   log "       and set VERSION accordingly"
   exit 1

scripts/start-deployPufferfish

@@ -15,7 +15,8 @@ fi
 
 : "${PUFFERFISH_BUILD:=lastSuccessfulBuild}"
 
-PUFFERFISH_BUILD_JSON=$(curl -X GET -s "https://ci.pufferfish.host/job/Pufferfish-${MAJOR_VANILLA_VERSION}/${PUFFERFISH_BUILD}/api/json")
+majorVersion=$(get_major_version "$VERSION")
+PUFFERFISH_BUILD_JSON=$(curl -X GET -s "https://ci.pufferfish.host/job/Pufferfish-${majorVersion}/${PUFFERFISH_BUILD}/api/json")
 # Example: "url": "https://ci.pufferfish.host/job/Pufferfish-1.18/50/",
 PUFFERFISH_BUILD_URL=$(jq -n "$PUFFERFISH_BUILD_JSON" | jq -jc '.url // empty' )
 # Example: "fileName": "pufferfish-paperclip-1.18.2-R0.1-SNAPSHOT-reobf.jar",

scripts/start-deployQuilt

@@ -4,8 +4,6 @@ set -eu
 # shellcheck source=start-utils
 . "${SCRIPTS:-/}start-utils"
 
-requireVar VANILLA_VERSION
-export TYPE=QUILT
 : "${QUILT_LAUNCHER:=}"
 : "${QUILT_LAUNCHER_URL:=}"
 : "${QUILT_INSTALLER_URL:=}"
@@ -14,47 +12,50 @@ export TYPE=QUILT
 
 isDebugging && set -x
 
-# Custom quilt jar
+resultsFile=/data/.quilt.env
+
 if [[ $QUILT_LAUNCHER ]]; then
-  export SERVER=${QUILT_LAUNCHER}
-# Custom quilt jar url
+  log "WARNING: use of QUILT_LAUNCHER is a deprecated feature."
+  SERVER="$QUILT_LAUNCHER"
+  export SERVER
+  resolveVersion
+
+  export FAMILY=FABRIC
+  exec "${SCRIPTS:-/}start-setupWorld" "$@"
+
 elif [[ $QUILT_LAUNCHER_URL ]]; then
-  export SERVER=quilt-server-$(echo -n "$QUILT_LAUNCHER_URL" | mc-image-helper hash)
-# Official quilt installer
+  log "ERROR: QUILT_LAUNCHER_URL is not longer supported. Pre-download and use QUILT_LAUNCHER."
+  exit 2
+
+elif [[ $QUILT_INSTALLER_URL ]]; then
+  if ! mc-image-helper install-quilt \
+    --loader-version="$QUILT_LOADER_VERSION" \
+    --minecraft-version="$VERSION" \
+    --output-directory=/data \
+    --results-file="$resultsFile" \
+    --installer-url="$QUILT_INSTALLER_URL"; then
+    log "ERROR: failed to install Quilt given custom installer URL $QUILT_INSTALLER_URL"
+    exit 2
+  fi
+
 else
-  if [[ ${QUILT_INSTALLER_VERSION^^} = LATEST ]]; then
-    log "Checking Quilt Installer version information."
-    QUILT_INSTALLER_VERSION=$(maven-metadata-release https://maven.quiltmc.org/repository/release/org/quiltmc/quilt-installer/maven-metadata.xml)
+  if ! mc-image-helper install-quilt \
+    --loader-version="$QUILT_LOADER_VERSION" \
+    --minecraft-version="$VERSION" \
+    --output-directory=/data \
+    --results-file="$resultsFile" \
+    --installer-version="$QUILT_INSTALLER_VERSION"; then
+    log "ERROR: failed to install Quilt given installer version $QUILT_INSTALLER_VERSION"
+    exit 2
   fi
-  if [[ ${QUILT_LOADER_VERSION^^} = LATEST ]]; then
-    log "Checking Quilt Loader version information."
-    QUILT_LOADER_VERSION=$(maven-metadata-release https://maven.quiltmc.org/repository/release/org/quiltmc/quilt-loader/maven-metadata.xml)
-  fi
-  export INSTALLER=quilt-installer-${QUILT_INSTALLER_VERSION}.jar
-  export SERVER=quilt-server-${VANILLA_VERSION}-${QUILT_LOADER_VERSION}-launch.jar 
-  export QUILT_INSTALLER_URL="https://maven.quiltmc.org/repository/release/org/quiltmc/quilt-installer/${QUILT_INSTALLER_VERSION}/quilt-installer-${QUILT_INSTALLER_VERSION}.jar"
+
 fi
 
-if [[ ! -e ${SERVER} && ! -z ${QUILT_INSTALLER_URL} ]]; then
-  log "Downloading and installing $QUILT_INSTALLER_URL ..."
-  if ! get -o "$INSTALLER" "$QUILT_INSTALLER_URL"; then
-    log "Failed to download from given location $QUILT_INSTALLER_URL"
-    exit 2
-  fi
-  if ! java -jar ${INSTALLER} install server ${VANILLA_VERSION} ${QUILT_LOADER_VERSION} --install-dir=./ --download-server; then
-    log "Failed to install $INSTALLER"
-    exit 2
-  fi
-  if ! mv quilt-server-launch.jar ${SERVER}; then
-    log "Failed to rename $SERVER"
-    exit 2
-  fi
-fi
-
-if [[ ! -e ${SERVER} ]]; then
-  log "$SERVER does not exist, cannot launch server!"
-  exit 1
-fi
+# grab SERVER, VERSION and export it
+set -a
+# shellcheck disable=SC1090
+source "${resultsFile}"
+set +a
 
 export FAMILY=FABRIC
 exec "${SCRIPTS:-/}start-setupWorld" "$@"

scripts/start-deploySpongeVanilla

@@ -1,5 +1,6 @@
 #!/bin/bash
 
+# shellcheck source=start-utils
 . ${SCRIPTS:-/}start-utils
 
 export TYPE=spongevanilla
@@ -24,20 +25,20 @@ esac
 if [ -z $SPONGEVERSION ]; then
   log "Choosing Version for Sponge"
   if [ "$SPONGEBRANCH" == "stable" ]; then
-    SPONGEVERSION=`curl -fsSL https://dl-api.spongepowered.org/v1/org.spongepowered/$TYPE | jq -r '.buildTypes.stable.latest.version'`
+    SPONGEVERSION=$(curl -fsSL https://dl-api.spongepowered.org/v1/org.spongepowered/$TYPE | jq -r '.buildTypes.stable.latest.version')
   else
-    SPONGEVERSION=`curl -fsSL https://dl-api.spongepowered.org/v1/org.spongepowered/$TYPE | jq -r '.buildTypes.bleeding.latest.version'`
+    SPONGEVERSION=$(curl -fsSL https://dl-api.spongepowered.org/v1/org.spongepowered/$TYPE | jq -r '.buildTypes.bleeding.latest.version')
   fi
 fi
 
-VANILLA_VERSION="$SPONGEVERSION"
-export VANILLA_VERSION
+VERSION="$SPONGEVERSION"
+export VERSION
 export SERVER="spongevanilla-$SPONGEVERSION.jar"
 
-if [ ! -e $SERVER ] || [ -n "$FORCE_REDOWNLOAD" ]; then
+if [ ! -e "$SERVER" ] || [ -n "$FORCE_REDOWNLOAD" ]; then
   log "Downloading $SERVER ..."
-  curl -sSL -o $SERVER https://repo.spongepowered.org/maven/org/spongepowered/$TYPE/$SPONGEVERSION/$SERVER
+  curl -sSL -o "$SERVER" "https://repo.spongepowered.org/maven/org/spongepowered/$TYPE/$SPONGEVERSION/$SERVER"
 fi
 
 export FAMILY=SPONGE
-exec ${SCRIPTS:-/}start-setupWorld "$@"
+exec "${SCRIPTS:-/}start-setupWorld" "$@"

scripts/start-deployVanilla

@@ -5,18 +5,19 @@
 isDebugging && set -x
 set -o pipefail
 
-export SERVER="minecraft_server.${VANILLA_VERSION// /_}.jar"
+resolveVersion
+export SERVER="minecraft_server.${VERSION// /_}.jar"
 
 if [ ! -e "$SERVER" ] || [ -n "$FORCE_REDOWNLOAD" ]; then
-  debug "Finding version manifest for $VANILLA_VERSION"
-  versionManifestUrl=$(get 'https://launchermeta.mojang.com/mc/game/version_manifest.json' | jq --arg VANILLA_VERSION "$VANILLA_VERSION" --raw-output '[.versions[]|select(.id == $VANILLA_VERSION)][0].url')
+  debug "Finding version manifest for $VERSION"
+  versionManifestUrl=$(get 'https://launchermeta.mojang.com/mc/game/version_manifest.json' | jq --arg VERSION "$VERSION" --raw-output '[.versions[]|select(.id == $VERSION)][0].url')
   result=$?
   if [ $result != 0 ]; then
     log "ERROR: failed to obtain version manifest URL ($result)"
     exit 1
   fi
   if [ "$versionManifestUrl" = "null" ]; then
-    log "ERROR: couldn't find a matching manifest entry for $VANILLA_VERSION"
+    log "ERROR: couldn't find a matching manifest entry for $VERSION"
     exit 1
   fi
   debug "Found version manifest at $versionManifestUrl"
@@ -25,11 +26,11 @@ if [ ! -e "$SERVER" ] || [ -n "$FORCE_REDOWNLOAD" ]; then
     log "ERROR: failed to obtain version manifest from $versionManifestUrl ($result)"
     exit 1
   elif [ "$serverDownloadUrl" = "null" ]; then
-    log "ERROR: there is not a server download for version $VANILLA_VERSION"
+    log "ERROR: there is not a server download for version $VERSION"
     exit 1
   fi
 
-  log "Downloading $VANILLA_VERSION server..."
+  log "Downloading $VERSION server..."
   debug "Downloading server from $serverDownloadUrl"
   get -o "$SERVER" "$serverDownloadUrl"
   result=$?

scripts/start-setupForgeApiMods

@@ -57,7 +57,7 @@ updateReleaseNumber(){
 }
 
 retrieveVersionTypeNumber(){
-  VERSION_NAME="Minecraft ${MAJOR_VANILLA_VERSION}"
+  VERSION_NAME=$(get_major_version "$VERSION")
   minecraft_types=$(curl -X GET -s \
     "${FORGEAPI_BASE_URL}/games/${MINECRAFT_GAME_ID}/version-types" \
     -H 'Accept: application/json' -H 'x-api-key: '${MODS_FORGEAPI_KEY}'')

scripts/start-setupModpack

@@ -289,7 +289,7 @@ function handleModrinthProjects() {
     mc-image-helper modrinth \
       --output-directory=/data \
       --projects="${MODRINTH_PROJECTS}" \
-      --game-version="${VANILLA_VERSION}" \
+      --game-version="${VERSION}" \
       --loader="$loader" \
       --download-optional-dependencies="$MODRINTH_DOWNLOAD_OPTIONAL_DEPENDENCIES" \
       --allowed-version-type="$MODRINTH_ALLOWED_VERSION_TYPE"

scripts/start-utils

@@ -163,7 +163,7 @@ function normalizeMemSize() {
 
 function versionLessThan() {
   # Use if-else since strict mode might be enabled
-  if mc-image-helper compare-versions "${VANILLA_VERSION}" lt "${1?}"; then
+  if mc-image-helper compare-versions "${VERSION}" lt "${1?}"; then
     return 0
   else
     return 1
@@ -320,4 +320,28 @@ function usesPlugins() {
       return 0
   esac
   return 1
+}
+
+function resolveVersion() {
+  givenVersion="$VERSION"
+  # shellcheck disable=SC2153
+  if ! VERSION=$(mc-image-helper resolve-minecraft-version "$VERSION"); then
+    exit 2
+  fi
+  log "Resolved version given ${givenVersion} into ${VERSION}"
+}
+
+function resolveFamily() {
+  case "$TYPE" in
+    PAPER|SPIGOT|BUKKIT|CANYON|PUFFERFISH|PURPUR)
+      FAMILY=SIGOT
+      ;;
+    FORGE)
+      FAMILY=FORGE
+      ;;
+    FABRIC|QUILT)
+      FAMILY=FABRIC
+      ;;
+  esac
+  export FAMILY
 }

tests/setuponlytests/auto_curseforge/docker-compose.yml

@@ -6,7 +6,7 @@ services:
     environment:
       EULA: "true"
       SETUP_ONLY: "TRUE"
-      TYPE: AUTO_CURSEFORGE
+      MOD_PLATFORM: AUTO_CURSEFORGE
       CF_API_KEY: ${CF_API_KEY}
       CF_SLUG: the-pixelmon-modpack
       CF_FILENAME_MATCHER: "9.1.2"

tests/setuponlytests/modrinth/docker-compose.yml

@@ -7,10 +7,7 @@ services:
       EULA: "true"
       SETUP_ONLY: "true"
       TYPE: FABRIC
-      FABRIC_LAUNCHER: /servers/fake.jar
-      CUSTOM_SERVER: /servers/fake.jar
       VERSION: 1.19.1
       MODRINTH_PROJECTS: fabric-api,cloth-config
     volumes:
       - ./data:/data
-      - ./fake.jar:/servers/fake.jar