Auto-merging via docker-versions-create

#891 #1041

.github/FUNDING.yml

@@ -0,0 +1,5 @@
+
+#github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+custom:
+  - https://www.buymeacoffee.com/itzg
+  - https://paypal.me/itzg

.github/workflows/build-multiarch.yml

@@ -23,9 +23,8 @@ on:
 
 jobs:
   docker-buildx:
+    if: github.repository == 'itzg/docker-minecraft-server'
     runs-on: ubuntu-20.04
-    env:
-      CACHE_NAME: master
     steps:
       - name: Checkout
         uses: actions/checkout@v2.3.4
@@ -39,9 +38,8 @@ jobs:
           tags: |
             type=ref,event=branch
             type=ref,event=tag
-            type=edge,branch=master
           flavor: |
-            latest=false
+            latest=${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
 
       - name: Setup Docker Buildx
         uses: docker/setup-buildx-action@v1
@@ -50,9 +48,8 @@ jobs:
         uses: actions/cache@v2.1.6
         with:
           path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ env.CACHE_NAME }}-${{ github.sha }}
+          key: ${{ runner.os }}-buildx-${{ github.sha }}
           restore-keys: |
-            ${{ runner.os }}-buildx-${{ env.CACHE_NAME }}-
             ${{ runner.os }}-buildx-
 
       - name: Set up QEMU
@@ -66,7 +63,7 @@ jobs:
 
       - name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v2.5.0
+        uses: docker/build-push-action@v2.7.0
         with:
           context: .
           platforms: linux/amd64,linux/arm/v7,linux/arm64
@@ -75,8 +72,16 @@ jobs:
           # ensure latest base image is used
           pull: true
           cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache-new
           labels: ${{ steps.meta.outputs.labels }}
 
       - name: Image digest
         run: echo ${{ steps.docker_build.outputs.digest }}
+
+      - # Temp fix
+        # https://github.com/docker/build-push-action/issues/252
+        # https://github.com/moby/buildkit/issues/1896
+        name: Move cache
+        run: |
+          rm -rf /tmp/.buildx-cache
+          mv /tmp/.buildx-cache-new /tmp/.buildx-cache

.github/workflows/generate-toc.yml

@@ -7,6 +7,7 @@ on:
       - README.md
 jobs:
   generate:
+    if: github.repository == 'itzg/docker-minecraft-server'
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
@@ -15,6 +16,6 @@ jobs:
           curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
           chmod a+x gh-md-toc
           ./gh-md-toc --insert --no-backup README.md
-      - uses: stefanzweifel/git-auto-commit-action@v4.11.0
+      - uses: stefanzweifel/git-auto-commit-action@v4.12.0
         with:
           commit_message: "docs: Auto update markdown TOC"

.github/workflows/main.yml

@@ -29,8 +29,6 @@ jobs:
     needs:
       - test
     runs-on: ubuntu-20.04
-    env:
-      CACHE_NAME: master
 
     steps:
     - uses: actions/checkout@v2.3.4
@@ -51,9 +49,7 @@ jobs:
         fi
         TAGS="${DOCKER_IMAGE}:${VERSION//\//-}"
         echo ::set-output name=tags::${TAGS}
-        echo ::set-output name=cache_from::${TAGS}
         echo ::set-output name=version::${VERSION//\//-}
-        echo ::set-output name=cache_version::${VERSION//\//-}
 
     - name: Setup Docker Buildx
       uses: docker/setup-buildx-action@v1
@@ -62,9 +58,8 @@ jobs:
       uses: actions/cache@v2.1.6
       with:
         path: /tmp/.buildx-cache
-        key: ${{ runner.os }}-buildx-${{ env.CACHE_NAME }}-${{ github.sha }}
+        key: ${{ runner.os }}-buildx-${{ github.sha }}
         restore-keys: |
-          ${{ runner.os }}-buildx-${{ env.CACHE_NAME }}-
           ${{ runner.os }}-buildx-
 
     - name: Login to DockerHub
@@ -75,7 +70,7 @@ jobs:
 
     - name: Build and push
       id: docker_build
-      uses: docker/build-push-action@v2.5.0
+      uses: docker/build-push-action@v2.7.0
       with:
         context: .
         file: ./Dockerfile
@@ -86,7 +81,7 @@ jobs:
         # tags determined by prep step
         tags: ${{ steps.prep.outputs.tags }}
         cache-from: type=local,src=/tmp/.buildx-cache
-        cache-to: type=local,dest=/tmp/.buildx-cache
+        cache-to: type=local,dest=/tmp/.buildx-cache-new
         labels: |
           org.opencontainers.image.documentation=https://github.com/itzg/docker-minecraft-server
           org.opencontainers.image.version=${{ steps.prep.outputs.version }}
@@ -95,3 +90,11 @@ jobs:
 
     - name: Image digest
       run: echo ${{ steps.docker_build.outputs.digest }}
+
+    - # Temp fix
+      # https://github.com/docker/build-push-action/issues/252
+      # https://github.com/moby/buildkit/issues/1896
+      name: Move cache
+      run: |
+        rm -rf /tmp/.buildx-cache
+        mv /tmp/.buildx-cache-new /tmp/.buildx-cache

DEVELOPMENT.md

@@ -70,5 +70,5 @@ The multiarch images are built and published by [a Github action](https://github
 The following git command can be used to provide the bulk of release notes content:
 
 ```shell script
-git log --invert-grep --grep "^ci:" --grep "^misc:" --grep "^docs:" --grep "^build(deps)" --pretty="- %s" 1.1.0..1.2.0
+git log --invert-grep --grep "^ci:" --grep "^misc:" --grep "^docs:" --pretty="- %s" 1.1.0..1.2.0
 ```

Dockerfile

@@ -1,29 +1,30 @@
-FROM openjdk:8u212-jre-alpine
+FROM adoptopenjdk:11-jre
 
 LABEL org.opencontainers.image.authors="Geoff Bourne <itzgeoff@gmail.com>"
 
-RUN apk add --no-cache -U \
-  openssl \
+RUN apt-get update \
+  && DEBIAN_FRONTEND=noninteractive \
+  apt-get install -y \
     imagemagick \
-  lsof \
-  su-exec \
-  shadow \
-  bash \
-  curl iputils wget \
+    gosu \
+    sudo \
+    net-tools \
+    iputils-ping \
+    curl wget \
     git \
     jq \
+    dos2unix \
     mysql-client \
     tzdata \
     rsync \
     nano \
-  sudo \
-  knock \
-  ttf-dejavu
+    unzip \
+    knockd \
+    ttf-dejavu \
+    && apt-get clean
 
-RUN addgroup -g 1000 minecraft \
-  && adduser -Ss /bin/false -u 1000 -G minecraft -h /home/minecraft minecraft \
-  && mkdir -m 777 /data \
-  && chown minecraft:minecraft /data /home/minecraft
+RUN addgroup --gid 1000 minecraft \
+  && adduser --system --shell /bin/false --uid 1000 --ingroup minecraft --home /data minecraft
 
 COPY files/sudoers* /etc/sudoers.d
 
@@ -31,9 +32,9 @@ EXPOSE 25565 25575
 
 # hook into docker BuildKit --platform support
 # see https://docs.docker.com/engine/reference/builder/#automatic-platform-args-in-the-global-scope
-ARG TARGETOS=linux
-ARG TARGETARCH=amd64
-ARG TARGETVARIANT=""
+ARG TARGETOS
+ARG TARGETARCH
+ARG TARGETVARIANT
 
 ARG EASY_ADD_VER=0.7.1
 ADD https://github.com/itzg/easy-add/releases/download/${EASY_ADD_VER}/easy-add_${TARGETOS}_${TARGETARCH}${TARGETVARIANT} /usr/bin/easy-add
@@ -52,13 +53,17 @@ RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
  --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
- --var version=1.5.0 --var app=mc-server-runner --file {{.app}} \
+ --var version=1.7.0 --var app=mc-server-runner --file {{.app}} \
  --from https://github.com/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
 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 ASCIIFY_VERSION=1.0.1
+ADD https://jitpack.io/com/github/itzg/asciify/${ASCIIFY_VERSION}/asciify-${ASCIIFY_VERSION}.jar /usr/share/asciify/asciify.jar
+RUN chmod -R a+r /usr/share/asciify
+
 COPY mcstatus /usr/local/bin
 
 VOLUME ["/data"]
@@ -69,7 +74,7 @@ WORKDIR /data
 STOPSIGNAL SIGTERM
 
 ENV UID=1000 GID=1000 \
-  JVM_XX_OPTS="-XX:+UseG1GC" MEMORY="1G" \
+  MEMORY="1G" \
   TYPE=VANILLA VERSION=LATEST \
   ENABLE_RCON=true RCON_PORT=25575 RCON_PASSWORD=minecraft \
   SERVER_PORT=25565 ONLINE_MODE=TRUE SERVER_NAME="Dedicated Server" \
@@ -84,5 +89,6 @@ RUN dos2unix /start* && chmod +x /start*
 RUN dos2unix /health.sh && chmod +x /health.sh
 RUN dos2unix /autopause/* && chmod +x /autopause/*.sh
 
+
 ENTRYPOINT [ "/start" ]
 HEALTHCHECK --start-period=1m CMD /health.sh

README.md

@@ -13,30 +13,11 @@ To simply use the latest stable version, run
 
     docker run -d -it -p 25565:25565 -e EULA=TRUE itzg/minecraft-server
 
-where the standard server port, 25565, will be exposed on your host machine.
+where, in this case, the standard server port 25565, will be exposed on your host machine.
 
-If you want to serve up multiple Minecraft servers or just use an alternate port,
-change the host-side port mapping such as
+> 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.
 
-    ... -p 25566:25565 ...
-
-will serve your Minecraft server on your host's port 25566 since the `-p` syntax is
-`host-port`:`container-port`.
-
-Speaking of multiple servers, it's handy to give your containers explicit names using `--name`, such as naming this one "mc"
-
-    ... --name mc itzg/minecraft-server
-
-With that you can easily view the logs, stop, or re-start the container:
-
-    docker logs -f mc
-        ( Ctrl-C to exit logs action )
-
-    docker stop mc
-
-    docker start mc
-
-> Be sure to always include `-e EULA=TRUE` in your commands, as Mojang/Microsoft requires EULA acceptance.
+> Be sure to always include `-e EULA=TRUE` in your commands and container definitions, as Mojang/Microsoft requires EULA acceptance.
 
 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) and the [`TYPE`](#server-types) can be configured to create many variations of desired Minecraft server. 
 
@@ -57,6 +38,7 @@ By default, the container will download the latest version of the "vanilla" [Min
       * [Examples](#examples)
       * [Amazon Web Services (AWS) Deployment](#amazon-web-services-aws-deployment)
       * [Using Docker Compose](#using-docker-compose)
+   * [Troubleshooting](#troubleshooting)
    * [Server types](#server-types)
       * [Running a Forge Server](#running-a-forge-server)
       * [Running a Bukkit/Spigot server](#running-a-bukkitspigot-server)
@@ -71,13 +53,14 @@ By default, the container will download the latest version of the "vanilla" [Min
       * [Running an Canyon server](#running-an-canyon-server)
       * [Running a SpongeVanilla server](#running-a-spongevanilla-server)
       * [Running a Fabric Server](#running-a-fabric-server)
+      * [Running a Limbo server](#running-a-limbo-server)
    * [Running a server with a Feed the Beast modpack](#running-a-server-with-a-feed-the-beast-modpack)
       * [Environment Variables:](#environment-variables)
       * [Upgrading](#upgrading)
       * [Example](#example)
    * [Running a server with a CurseForge modpack](#running-a-server-with-a-curseforge-modpack)
-         * [Modpack data directory](#modpack-data-directory)
-         * [Buggy start scripts](#buggy-start-scripts)
+      * [Modpack data directory](#modpack-data-directory)
+      * [Buggy start scripts](#buggy-start-scripts)
       * [Fixing "unable to launch forgemodloader"](#fixing-unable-to-launch-forgemodloader)
    * [Working with mods and plugins](#working-with-mods-and-plugins)
       * [Optional plugins, mods, and config attach points](#optional-plugins-mods-and-config-attach-points)
@@ -119,7 +102,7 @@ By default, the container will download the latest version of the "vanilla" [Min
       * [PVP Mode](#pvp-mode)
       * [Level Type and Generator Settings](#level-type-and-generator-settings)
       * [Custom Server Resource Pack](#custom-server-resource-pack)
-      * [World Save Name](#world-save-name)
+      * [Level / World Save Name](#level--world-save-name)
       * [Online mode](#online-mode)
       * [Allow flight](#allow-flight)
       * [Other server property mappings](#other-server-property-mappings)
@@ -131,21 +114,23 @@ By default, the container will download the latest version of the "vanilla" [Min
       * [Memory Limit](#memory-limit)
       * [JVM Options](#jvm-options)
       * [Interactive and Color Console](#interactive-and-color-console)
+      * [Server Shutdown Options](#server-shutdown-options)
       * [OpenJ9 Specific Options](#openj9-specific-options)
       * [Enabling rolling logs](#enabling-rolling-logs)
-   * [Timezone Configuration](#timezone-configuration)
+      * [Timezone Configuration](#timezone-configuration)
       * [Enable Remote JMX for Profiling](#enable-remote-jmx-for-profiling)
       * [Enable Aikar's Flags](#enable-aikars-flags)
       * [HTTP Proxy](#http-proxy)
       * [Using "noconsole" option](#using-noconsole-option)
       * [Explicitly disable GUI](#explicitly-disable-gui)
       * [Stop Duration](#stop-duration)
+      * [Setup only](#setup-only)
    * [Autopause](#autopause)
       * [Description](#description)
       * [Enabling Autopause](#enabling-autopause)
    * [Running on RaspberryPi](#running-on-raspberrypi)
 
-<!-- Added by: runner, at: Wed Jun  9 12:35:18 UTC 2021 -->
+<!-- Added by: runner, at: Thu Sep 16 01:45:44 UTC 2021 -->
 
 <!--te-->
 
@@ -212,7 +197,7 @@ When attached in this way you can stop the server, edit the configuration under
 With Docker Compose, setting up a host attached directory is even easier since relative paths can be configured. For example, with the following `docker-compose.yml` Docker will automatically create/attach the relative directory `minecraft-data` to the container.
 
 ```yaml
-version: "3.8"
+version: "3"
 
 services:
   mc:
@@ -221,6 +206,9 @@ services:
       - 25565:25565
     environment:
       EULA: "TRUE"
+    tty: true
+    stdin_open: true
+    restart: unless-stopped
     volumes:
       # attach a directory relative to the directory containing this compose file
       - ./minecraft-data:/data
@@ -249,7 +237,7 @@ docker run -d -it --name mc-new -v mc:/data -p 25565:25565 -e EULA=TRUE -e MEMOR
 
 ## Versions
 
-To use a different Minecraft version, pass the `VERSION` environment variable, which can have the value
+To use a different Minecraft version, pass the `VERSION` environment variable (case sensitive), which can have the value
 
 - LATEST (the default)
 - SNAPSHOT
@@ -284,9 +272,9 @@ To use a different version of Java, please use a docker tag to run your Minecraf
 | java16-openj9  | 16           | Debian | OpenJ9   | amd64             |
 | multiarch-latest | 15+        | Debian | Hotspot  | amd64,arm64,armv7 |
 
-For example, to use Java version 15 on any supported architecture:
+For example, to use Java version 16 on any supported architecture:
 
-    docker run --name mc itzg/minecraft-server:java15
+    docker run --name mc itzg/minecraft-server:java16
 
 > Keep in mind that some versions of Minecraft server can't work on the newest versions of Java. Also, FORGE doesn't support openj9 JVM implementation.
 
@@ -343,20 +331,18 @@ every time you want to create new Minecraft server, you can now use
 `docker-compose.yml` file like the following:
 
 ```yml
-version: "3.8"
+version: "3"
 
-minecraft-server:
-  image: itzg/minecraft-server
-
-  ports:
-    - "25565:25565"
-
-  environment:
-    EULA: "TRUE"
-
-  tty: true
-  stdin_open: true
-  restart: always
+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
@@ -366,6 +352,14 @@ and in the same directory as that file run
 Now, go play...or adjust the `environment` section to configure
 this server instance.
 
+## Troubleshooting
+
+To troubleshoot the container initialization, such as when server files are pre-downloaded, set the environment variable `DEBUG` to `true`. The container logs will include **much more** output, and it is highly recommended including that output when reporting any [issues](https://github.com/itzg/docker-minecraft-server/issues).
+
+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`.
+
 ## Server types
 
 ### Running a Forge Server
@@ -450,15 +444,16 @@ An [Airplane](https://github.com/TECHNOVE/Airplane) server, which is a fork of T
 
     -e TYPE=AIRPLANE
 
-> **NOTE** only `VERSION=LATEST` is supported
+> NOTE: The `VERSION` variable is used to select an Airplane branch to download from. The available options are "LATEST" "1.17" "1.16" "PURPUR" and "PURPUR-1.16"
 
 Extra variables:
+- `AIRPLANE_BUILD=lastSuccessfulBuild` : set a specific Airplane build to use
 - `FORCE_REDOWNLOAD=false` : set to true to force the located server jar to be re-downloaded
 - `USE_FLARE_FLAGS=false` : set to true to add appropriate flags for the [Flare](https://blog.airplane.gg/flare) profiler
 
 ### Running a Purpur server
 
-A [Purpur](https://purpur.pl3x.net/) server, which is "a drop-in replacement for Paper servers designed for configurability, new fun and exciting gameplay features, and high performance built on top of Tuinity.".
+A [Purpur](https://purpur.pl3x.net/) server, which is "a drop-in replacement for Paper servers designed for configurability, new fun and exciting gameplay features, and high performance built on top of Tuinity."
 
     -e TYPE=PURPUR
 
@@ -487,7 +482,9 @@ A [Magma](https://magmafoundation.org/) server, which is a combination of Forge
 
     -e TYPE=MAGMA
 
-> **NOTE** there are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2"
+By default, the "stable" channel is used, but you can set `MAGMA_CHANNEL` to "dev" to access dev channel versions.
+
+> **NOTE** there are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2", "1.16.5", etc.
 
 
 ### Running a Mohist server
@@ -567,6 +564,20 @@ docker run -d -v /path/on/host:/data ... \
 
 In order to add mods, you have two options:
 
+### Running a Limbo server
+
+A [Limbo](https://github.com/LOOHP/Limbo) server can be run by setting `TYPE` to `LIMBO`.
+
+Configuration options with defaults:
+
+- `LIMBO_BUILD`=LATEST
+
+  The `VERSION` will be ignored so locate the appropriate value from [here](https://ci.loohpjames.com/job/Limbo/) to match the version expected by clients.
+
+- `FORCE_REDOWNLOAD`=false
+- `LIMBO_SCHEMA_FILENAME`=default.schem
+- `LEVEL`="Default;${LIMBO_SCHEMA_FILENAME}"
+
 ## Running a server with a Feed the Beast modpack
 
 > **NOTE** requires one of the Debian based images listed in [the Java versions section](#running-minecraft-server-on-different-java-version).
@@ -618,13 +629,13 @@ The following example uses `/modpacks` as the container path as the pre-download
         -e CF_SERVER_MOD=/modpacks/SkyFactory_4_Server_4.1.0.zip \
         -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
 
-#### Modpack data directory
+### Modpack data directory
 
 By default, CurseForge modpacks are expanded into the sub-directory `/data/FeedTheBeast` and executed from there. (The default location was chosen for legacy reasons, when Curse and FTB were maintained together.)
 
 The directory can be changed by setting `CF_BASE_DIR`, such as `-e CF_BASE_DIR=/data`.
 
-#### Buggy start scripts
+### Buggy start scripts
 
 Some modpacks have buggy or overly complex start scripts. You can avoid using the bundled start script and use this image's standard server-starting logic by adding `-e USE_MODPACK_START_SCRIPT=false`.
 
@@ -735,6 +746,10 @@ read-only volume attachment to ensure the clone source remains pristine.
 docker run ... -v $HOME/worlds:/worlds:ro -e WORLD=/worlds/basic
 ```
 
+The following diagram shows how this option can be used in a compose deployment with a relative directory:
+
+![](docs/world-copy-compose-project.drawio.png)
+
 ### Overwrite world on start
 The world will only be downloaded or copied if it doesn't exist already. Set `FORCE_WORLD_COPY=TRUE` to force overwrite the world on every server start.
 
@@ -787,10 +802,11 @@ To whitelist players for your Minecraft server, pass the Minecraft usernames sep
 
 If the `WHITELIST` environment variable is not used, any user can join your Minecraft server if it's publicly accessible.
 
-> NOTE: When `WHITELIST` is used the server property `white-list` will automatically get set to `true`.
+> NOTE: When `WHITELIST` is used the server properties `white-list` and `whitelist` will automatically get set to `true`.
 
 > By default, the players in `WHITELIST` are **added** to the final `whitelist.json` file by the Minecraft server. If you set `OVERRIDE_WHITELIST` to "true" then the `whitelist.json` file will be recreated on each server startup.
 
+Alternatively, you can set `ENABLE_WHITELIST=true` to only set the server properties `white-list` and `whitelist` without modifying the whitelist file. In this case the whitelist is solely managed using the `whitelist add` and `whitelist remove` commands.
 ### Op/Administrator Players
 
 To add more "op" (aka adminstrator) users to your Minecraft server, pass the Minecraft usernames separated by commas via the `OPS` environment variable, such as
@@ -812,7 +828,7 @@ The server icon which has been set doesn't get overridden by default. It can be
 
 ### Rcon
 
-To use rcon use the `ENABLE_RCON` and `RCON_PASSORD` variables.
+To use rcon use the `ENABLE_RCON` and `RCON_PASSWORD` variables.
 By default rcon port will be `25575` but can easily be changed with the `RCON_PORT` variable.
 
     docker run -d -e ENABLE_RCON=true -e RCON_PASSWORD=testing
@@ -957,7 +973,7 @@ For example:
 
 ### Message of the Day
 
-The message of the day, shown below each server entry in the UI, can be changed with the `MOTD` environment variable, such as
+The message of the day, shown below each server entry in the client UI, can be changed with the `MOTD` environment variable, such as
 
     -e MOTD="My Server"
 
@@ -967,6 +983,14 @@ If you leave it off, a default is computed from the server type and version, suc
 
 That way you can easily differentiate between several servers you may have started.
 
+The section symbol (§) and other unicode characters are automatically converted to allow [formatting codes](https://minecraft.fandom.com/wiki/Formatting_codes) to be used consistently with all server versions. For example,
+
+     -e MOTD="A §l§cMinecraft§r §nserver"
+
+renders
+
+![](docs/motd-example.png)
+
 ### PVP Mode
 
 By default, servers are created with player-vs-player (PVP) mode enabled. You can disable this with the `PVP`
@@ -998,6 +1022,10 @@ For example (just the `-e` bits):
 
     -e LEVEL_TYPE=flat -e 'GENERATOR_SETTINGS=3;minecraft:bedrock,3*minecraft:stone,52*minecraft:sandstone;2;'
 
+In Minecraft 1.13+ you need to pass json ([generator site](https://misode.github.io/world/)) like this (details see [here](https://github.com/itzg/docker-minecraft-server/issues/999#issuecomment-907849644)):
+
+    -e LEVEL_TYPE=flat -e 'GENERATOR_SETTINGS={"biome":"minecraft:the_void","layers":[{"block":"minecraft:bedrock","height":1},{"block":"minecraft:stone","height":10},{"block":"minecraft:dirt","height":1}],"structures":{"structures":{}}}'
+
 ### Custom Server Resource Pack
 
 You can set a link to a custom resource pack and set it's checksum using the `RESOURCE_PACK` and `RESOURCE_PACK_SHA1` options respectively, the default is blank:
@@ -1006,16 +1034,18 @@ You can set a link to a custom resource pack and set it's checksum using the `RE
 
 **NOTE:** `:` and `=` must be escaped using `\`. The checksum plain-text hexadecimal.
 
-### World Save Name
+### Level / World Save Name
 
 You can either switch between world saves or run multiple containers with different saves by using the `LEVEL` option,
 where the default is "world":
 
     docker run -d -e LEVEL=bonus ...
 
-**NOTE:** if running multiple containers be sure to either specify a different `-v` host directory for each
+> **NOTE:** if running multiple containers be sure to either specify a different `-v` host directory for each
 `LEVEL` in use or don't use `-v` and the container's filesystem will keep things encapsulated.
 
+> **INFO** Refer to the [data directory](#data-directory) section for a visual description of where the `$LEVEL` directory is situated.
+
 ### Online mode
 
 By default, server checks connecting players against Minecraft's account database. If you want to create an offline server or your server is not connected to the internet, you can disable the server to try connecting to minecraft.net to authenticate players with environment variable `ONLINE_MODE`, like this
@@ -1045,6 +1075,7 @@ Allows users to use flight on your server while in Survival mode, if they have a
 | PREVENT_PROXY_CONNECTIONS         | prevent-proxy-connections         |
 | USE_NATIVE_TRANSPORT              | use-native-transport              |
 | ENFORCE_WHITELIST                 | enforce-whitelist                 |
+| ENABLE_WHITELIST                  | white-list and whitelist          |
 
 ## Miscellaneous Options
 
@@ -1207,13 +1238,25 @@ For some cases, if e.g. after removing mods, it could be necessary to startup mi
 
 ### Interactive and Color Console
 
-If you would like to attach to the Minecraft server console with color and interactive capabilities, then add
+If you would like to `docker attach` to the Minecraft server console with color and interactive capabilities, then add
 
 ```
   -e EXEC_DIRECTLY=true
 ```
 
-> **NOTE** this will bypass graceful server shutdown handling when using `docker stop`, so be sure to use `rcon-cli` or console commands to `stop` the server.
+> **NOTES**
+>
+> This feature doesn't work via rcon, so you will need to `docker attach` to the container. Use the sequence Ctrl-P, Ctrl-Q to detach. 
+> 
+> This will bypass graceful server shutdown handling when using `docker stop`, so be sure the server console's `stop` command.
+> 
+> Make to enable stdin and tty with `-it` when using `docker run` or `stdin_open: true` and `tty: true` when using docker compose.
+
+### Server Shutdown Options
+
+To allow time for players to finish what they're doing during a graceful server shutdown, set `STOP_SERVER_ANNOUNCE_DELAY` to a number of seconds to delay after an announcement is posted by the server.
+
+> **NOTE** be sure to adjust Docker's shutdown timeout accordingly, such as using [the -t option on docker-compose down](https://docs.docker.com/compose/reference/down/).
 
 ### OpenJ9 Specific Options
 
@@ -1234,7 +1277,7 @@ By default the vanilla log file will grow without limit. The logger can be recon
 
 > **NOTE** this will interfere with interactive/color consoles [as described in the section above](#interactive-and-color-console)
 
-## Timezone Configuration
+### Timezone Configuration
 
 You can configure the timezone to match yours by setting the `TZ` environment variable:
 
@@ -1291,7 +1334,11 @@ disable that by passing `-e GUI=FALSE`.
 
 ### Stop Duration
 
-When the container is signalled to stop, the Minecraft process wrapper will attempt to send a "stop" command via RCON or console and waits for the process to gracefully finish. By defaul it waits 60 seconds, but that duration can be configured by setting the environment variable `STOP_DURATION` to the number of seconds.
+When the container is signalled to stop, the Minecraft process wrapper will attempt to send a "stop" command via RCON or console and waits for the process to gracefully finish. By default it waits 60 seconds, but that duration can be configured by setting the environment variable `STOP_DURATION` to the number of seconds.
+
+### Setup only
+
+If you are using a host-attached data directory, then you can have the image setup the Minecraft server files and stop prior to launching the server process by setting `SETUP_ONLY` to `true`. 
 
 ## Autopause
 
@@ -1305,7 +1352,7 @@ 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](#max-tick-time).
 
-> **NOTE:** Non-vanilla versions might have their own configuration file, you might have to disable their watchdogs separately (e.g. PAPER Servers).
+> **NOTE:** 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.
 

examples/docker-compose-fabric.yml

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

examples/docker-compose-rlcraft.yml

@@ -0,0 +1,27 @@
+version: '3.8'
+
+services:
+  rlcraft:
+    image: itzg/minecraft-server:java8
+    container_name: rlcraft
+    volumes:
+    - rlcraft-modpack:/modpacks:ro
+    - rlcraft-data:/data
+    environment:
+      EULA: "true"
+      TYPE: "FORGE"
+      VERSION: "1.12.2"
+      FORGEVERSION: "14.23.5.2855"
+      DIFFICULTY: "hard"
+      MAX_TICK_TIME: "-1"
+      VIEW_DISTANCE: "6"
+      ALLOW_FLIGHT: "true"
+      MEMORY: "4G"
+      GENERIC_PACK: "/modpacks/RLCraft_Server_Pack_1.12.2_Beta_v2.8.2.zip"
+    ports:
+      - 25565:25565
+    restart: unless-stopped
+
+volumes:
+  rlcraft-data:
+  rlcraft-modpack:

examples/docker-compose-spiget.yml

@@ -0,0 +1,17 @@
+version: "3"
+
+services:
+  mc:
+    # Only using IMAGE variable to allow for local testing
+    image: ${IMAGE:-itzg/minecraft-server}
+    ports:
+      - 25565:25565
+    environment:
+      EULA: "TRUE"
+      TYPE: SPIGOT
+      SPIGET_RESOURCES: 9089,34315,3836
+    volumes:
+      - data:/data
+
+volumes:
+  data: {}

files/autopause/autopause-fcns.sh

@@ -5,15 +5,15 @@ current_uptime() {
 }
 
 java_running() {
-  [[ $( ps -a -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^S.*$ ]]
+  [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^S.*$ ]]
 }
 
 java_process_exists() {
-  [[ -n "$(ps -a -o comm | grep 'java')" ]]
+  [[ -n "$(ps -ax -o comm | grep 'java')" ]]
 }
 
 rcon_client_exists() {
-  [[ -n "$(ps -a -o comm | grep 'rcon-cli')" ]]
+  [[ -n "$(ps -ax -o comm | grep 'rcon-cli')" ]]
 }
 
 mc_server_listening() {

files/autopause/knockd-config.cfg

@@ -3,10 +3,10 @@
 [unpauseMCServer-server]
  sequence = 25565
  seq_timeout = 1
- command = /sbin/su-exec minecraft:minecraft /autopause/resume.sh
+ command = /usr/sbin/gosu minecraft:minecraft /autopause/resume.sh
  tcpflags = syn
 [unpauseMCServer-rcon]
  sequence = 25575
  seq_timeout = 1
- command = /sbin/su-exec minecraft:minecraft /autopause/resume.sh
+ command = /usr/sbin/gosu minecraft:minecraft /autopause/resume.sh
  tcpflags = syn

files/autopause/pause.sh

@@ -2,7 +2,7 @@
 
 . /start-utils
 
-if [[ $( ps -a -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^S.*$ ]] ; then
+if [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^S.*$ ]] ; then
   # save world
   rcon-cli save-all >/dev/null
 

files/autopause/resume.sh

@@ -2,7 +2,7 @@
 
 . /start-utils
 
-if [[ $( ps -a -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^T.*$ ]] ; then
+if [[ $( ps -ax -o stat,comm | grep 'java' | awk '{ print $1 }') =~ ^T.*$ ]] ; then
   logAutopauseAction "Knocked, resuming Java process"
   pkill -CONT java
 fi

start

@@ -40,7 +40,7 @@ if ! isTrue "${SKIP_SUDO:-false}" && [ $(id -u) = 0 ]; then
     echo 'hosts: files dns' > /etc/nsswitch.conf
   fi
 
-  exec su-exec ${runAsUser}:${runAsGroup} ${SCRIPTS:-/}start-configuration $@
+  exec gosu ${runAsUser}:${runAsGroup} ${SCRIPTS:-/}start-configuration $@
 else
   exec ${SCRIPTS:-/}start-configuration $@
 fi

start-configuration

@@ -56,7 +56,7 @@ fi
 
 if ! which java > /dev/null; then
   log "Fixing PATH to include java"
-  PATH="${PATH}:/usr/bin"
+  PATH="${PATH}:/opt/java/openjdk/bin"
 fi
 
 export VERSIONS_JSON=https://launchermeta.mojang.com/mc/game/version_manifest.json
@@ -98,6 +98,12 @@ case "${TYPE^^}" in
   ;;
 
   FORGE)
+    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-deployForge "$@"
   ;;
 
@@ -105,7 +111,17 @@ case "${TYPE^^}" in
     exec ${SCRIPTS:-/}start-deployFabric "$@"
   ;;
 
+  FTBA)
+    exec ${SCRIPTS:-/}start-deployFTBA "$@"
+  ;;
+
   FTB|CURSEFORGE)
+    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-deployCF "$@"
   ;;
 
@@ -153,11 +169,15 @@ case "${TYPE^^}" in
     exec ${SCRIPTS:-/}start-deployCanyon "$@"
   ;;
 
+  LIMBO)
+    exec ${SCRIPTS:-/}start-deployLimbo "$@"
+  ;;
+
   *)
       log "Invalid type: '$TYPE'"
       log "Must be: VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, FTBA (multiarch-only),"
       log "         CURSE_INSTANCE, CURSEFORGE, SPONGEVANILLA, TUINITY, PURPUR"
-      log "         CUSTOM, MAGMA, MOHIST, CATSERVER, YATOPIA, AIRPLANE, CANYON"
+      log "         CUSTOM, MAGMA, MOHIST, CATSERVER, YATOPIA, AIRPLANE, CANYON, LIMBO"
       exit 1
   ;;
 

start-deployAirplane

@@ -5,23 +5,38 @@ IFS=$'\n\t'
 . ${SCRIPTS:-/}start-utils
 isDebugging && set -x
 
-JAVA_VER=$(java -version 2>&1 | head -1 | cut -d'"' -f2 | sed '/^1\./s///' | cut -d'.' -f1)
-
-if [ "${JAVA_VER}" = "8" ]; then
-  JDK=8
-else
-  JDK=11
-fi
-
-if [ "${VERSION}" != "LATEST" ]; then
-  log "ERROR: Airplane server type only supports VERSION=LATEST"
+if [ "${VERSION}" != "LATEST" ] && [ "${VERSION}" != "1.16" ] && [ "${VERSION}" != "1.17" ] && [ "${VERSION}" != "PURPUR" ] && [ "${VERSION}" != "PURPUR-1.16" ] ; then
+  log "ERROR: Airplane server type only supports VERSION=LATEST, VERSION=1.17, VERSION=1.16, VERSION=PURPUR or VERSION=PURPUR-1.16. Note that these are branches, not #.#.# versions."
   exit 1
 fi
 
-export SERVER=airplane-${VANILLA_VERSION}-jdk${JDK}.jar
+: ${AIRPLANE_BUILD:=lastSuccessfulBuild}
+: ${AIRPLANE_TYPE:=airplane}
 
-if [ ! -f "$SERVER" ] || isTrue "$FORCE_REDOWNLOAD"; then
-    downloadUrl="https://dl.airplane.gg/latest/Airplane-JDK${JDK}/launcher-airplane.jar"
+if  [ "${VERSION}" = "LATEST" ] || [ "${VERSION}" = "1.17" ]; then
+  AIRPLANE_BRANCH="1.17"
+fi
+
+if [ "${VERSION}" = "1.16" ]; then
+  AIRPLANE_BRANCH="1.16"
+fi
+
+if [ "${VERSION}" = "PURPUR" ]; then
+  AIRPLANE_BRANCH="Purpur-1.17"
+  AIRPLANE_TYPE="airplanepurpur"
+fi
+
+if [ "${VERSION}" = "PURPUR-1.16" ]; then
+  AIRPLANE_BRANCH="Purpur-1.16"
+  AIRPLANE_TYPE="airplanepurpur"
+fi
+
+log "Using Airplane-${AIRPLANE_BRANCH} branch"
+
+export SERVER=airplane-${AIRPLANE_BRANCH}-${AIRPLANE_BUILD}.jar
+
+if [ ! -f "$SERVER" ] || isTrue "${FORCE_REDOWNLOAD:-false}"; then
+    downloadUrl="https://ci.tivy.ca/job/Airplane-${AIRPLANE_BRANCH}/${AIRPLANE_BUILD}/artifact/launcher-${AIRPLANE_TYPE}.jar"
     log "Downloading Airplane from $downloadUrl ..."
     curl -fsSL -o "$SERVER" "$downloadUrl"
     if [ ! -f "$SERVER" ]; then

start-deployBukkitSpigot

@@ -64,7 +64,11 @@ function downloadSpigot {
   fi
 
   if [[ -z $downloadUrl ]]; then
-    downloadUrl="https://cdn.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VANILLA_VERSION}.jar"
+    if versionLessThan 1.16.5; then
+      downloadUrl="https://cdn.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VANILLA_VERSION}.jar"
+    else
+      downloadUrl="https://download.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VANILLA_VERSION}.jar"
+    fi
   fi
 
   setServerVar

start-deployFTBA

@@ -30,7 +30,13 @@ if ! [ -f "${ftbInstallMarker}" ] || [ $(cat "${ftbInstallMarker}") != "${FTB_MO
   ftbInstaller=/data/ftb-installer
   if ! [[ -f "${ftbInstaller}" ]]; then
     log "Downloading FTB installer"
-    curl -fsSL https://api.modpacks.ch/public/modpack/1/1/server/linux -o "${ftbInstaller}"
+    if [ "$(uname -m)" == "aarch64" ]; then
+      log "Downloading ARM installer"
+      curl -fsSL https://api.modpacks.ch/public/modpack/1/1/server/arm/linux -o "${ftbInstaller}"
+    else
+      log "Downloading x86 installer"
+      curl -fsSL https://api.modpacks.ch/public/modpack/1/1/server/linux -o "${ftbInstaller}"
+    fi
     chmod +x "${ftbInstaller}"
   fi
 

start-deployFabric

@@ -3,54 +3,43 @@ set -eu
 
 . ${SCRIPTS:-/}start-utils
 
+requireVar VANILLA_VERSION
 export TYPE=FABRIC
+export SERVER=fabric-server-${VANILLA_VERSION}.jar
 
-FABRIC_INSTALLER=${FABRIC_INSTALLER:-}
-FABRIC_INSTALLER_URL=${FABRIC_INSTALLER_URL:-}
-FABRIC_INSTALLER_VERSION=${FABRIC_INSTALLER_VERSION:-${FABRICVERSION:-LATEST}}
-if [[ -z $FABRIC_INSTALLER && -z $FABRIC_INSTALLER_URL ]]; then
-  log "Checking Fabric version information."
-  case $FABRIC_INSTALLER_VERSION in
-    LATEST)
+isDebugging && set -x
+
+if [[ ! -e ${SERVER} ]]; then
+
+  : ${FABRIC_INSTALLER:=}
+  : ${FABRIC_INSTALLER_URL:=}
+  : ${FABRIC_INSTALLER_VERSION:=${FABRICVERSION:-LATEST}}
+
+  if [[ -z $FABRIC_INSTALLER && -z $FABRIC_INSTALLER_URL ]]; then
+    log "Checking Fabric version information."
+    if [[ ${FABRIC_INSTALLER_VERSION^^} = LATEST ]]; then
       FABRIC_INSTALLER_VERSION=$(maven-metadata-release https://maven.fabricmc.net/net/fabricmc/fabric-installer/maven-metadata.xml)
-      ;;
-  esac
+    fi
 
-  FABRIC_INSTALLER="/tmp/fabric-installer-${FABRIC_INSTALLER_VERSION}.jar"
-  markerVersion=$FABRIC_INSTALLER_VERSION
+    FABRIC_INSTALLER="fabric-installer-${FABRIC_INSTALLER_VERSION}.jar"
+    FABRIC_INSTALLER_URL="https://maven.fabricmc.net/net/fabricmc/fabric-installer/${FABRIC_INSTALLER_VERSION}/fabric-installer-${FABRIC_INSTALLER_VERSION}.jar"
+  elif [[ -z $FABRIC_INSTALLER ]]; then
+    FABRIC_INSTALLER="fabric-installer.jar"
+  elif [[ ! -e $FABRIC_INSTALLER ]]; then
+    log "ERROR: the given Fabric installer doesn't exist : $FABRIC_INSTALLER"
+    exit 2
+  fi
 
-elif [[ -z $FABRIC_INSTALLER ]]; then
-  FABRIC_INSTALLER="/tmp/fabric-installer.jar"
-  markerVersion=custom
-elif [[ ! -e $FABRIC_INSTALLER ]]; then
-  log "ERROR: the given Fabric installer doesn't exist : $FABRIC_INSTALLER"
-  exit 2
-fi
-
-installMarker="/data/.fabric-installed-${VANILLA_VERSION}-${markerVersion}"
-
-debug Checking for installMarker ${installMarker}
-if [[ ! -e $installMarker ]]; then
   if [[ ! -e $FABRIC_INSTALLER ]]; then
-    if [[ -z $FABRIC_INSTALLER_URL ]]; then
-      log "Downloading installer version $FABRIC_INSTALLER_VERSION"
-      downloadUrl="https://maven.fabricmc.net/net/fabricmc/fabric-installer/${FABRIC_INSTALLER_VERSION}/fabric-installer-${FABRIC_INSTALLER_VERSION}.jar"
-      log "...trying $downloadUrl"
-      curl -o $FABRIC_INSTALLER -fsSL $downloadUrl
-    else
-      log "Downloading $FABRIC_INSTALLER_URL ..."
-      if ! curl -o $FABRIC_INSTALLER -fsSL $FABRIC_INSTALLER_URL; then
-        log "Failed to download from given location $FABRIC_INSTALLER_URL"
-        exit 2
-      fi
+    log "Downloading $FABRIC_INSTALLER_URL ..."
+    if ! curl -o $FABRIC_INSTALLER -fsSL $FABRIC_INSTALLER_URL; then
+      log "Failed to download from given location $FABRIC_INSTALLER_URL"
+      exit 2
     fi
   fi
 
-  if isDebugging; then
-    debug "Installing Fabric ${VANILLA_VERSION} using $FABRIC_INSTALLER"
-  else
-    log "Installing Fabric using $FABRIC_INSTALLER"
-  fi
+  log "Installing Fabric ${VANILLA_VERSION} using $FABRIC_INSTALLER"
+
   tries=3
   set +e
   while ((--tries >= 0)); do
@@ -67,13 +56,9 @@ if [[ ! -e $installMarker ]]; then
     log "Fabric failed to install after several tries." >&2
     exit 10
   fi
-  export SERVER=fabric-server-launch.jar
-  log "Using server $SERVER"
-  echo $SERVER > $installMarker
 
-else
-  export SERVER=$(< $installMarker)
+  mv fabric-server-launch.jar ${SERVER}
 fi
 
-# Contineut to Final Setup
+# Continue to Final Setup
 exec ${SCRIPTS:-/}start-finalSetupWorld $@

start-deployForge

@@ -1,7 +1,6 @@
 #!/bin/bash
 
 . ${SCRIPTS:-/}start-utils
-export TYPE=FORGE
 : ${FORGEVERSION:=RECOMMENDED}
 isDebugging && set -x
 
@@ -47,7 +46,7 @@ elif [[ ! -e $FORGE_INSTALLER ]]; then
   log "ERROR: the given Forge installer doesn't exist : $FORGE_INSTALLER"
   exit 2
 else
-  shortForgeVersion=$VANILLA_VERSION-custom
+  shortForgeVersion=$VANILLA_VERSION-${FORGE_INSTALLER_CUSTOM_VERSION:-custom}
 fi
 
 installMarker="/data/.forge-installed-$shortForgeVersion"

start-deployLimbo

@@ -0,0 +1,64 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+. ${SCRIPTS:-/}start-utils
+isDebugging && set -x
+
+: ${LIMBO_BUILD:=LATEST}
+: ${FORCE_REDOWNLOAD:=false}
+: ${LIMBO_SCHEMA_FILENAME:=default.schem}
+: ${LEVEL:=Default;${LIMBO_SCHEMA_FILENAME}}
+# defaults to localhost, if this is not set
+: ${SERVER_IP:=0.0.0.0}
+
+export LEVEL SERVER_IP
+
+if [[ ${LIMBO_BUILD^^} == LATEST ]]; then
+  LIMBO_BUILD=lastStableBuild
+fi
+
+baseUrl="https://ci.loohpjames.com/job/Limbo/${LIMBO_BUILD}"
+buildInfoUrl="${baseUrl}/api/json"
+buildJson=$(curl -fsSL "${buildInfoUrl}")
+if [ $? != 0 ]; then
+  log "ERROR failed to get build info from ${buildInfoUrl} (status=$?)"
+  exit 1
+fi
+
+if [[ ${LIMBO_BUILD} = lastStableBuild ]]; then
+  LIMBO_BUILD=$(jq -r '.number' <<<${buildJson})
+  log "Resolved latest Limbo build to ${LIMBO_BUILD}"
+fi
+artifactPath=$(jq -r '.artifacts[] | select(.fileName|test("^Limbo-")) | .relativePath' <<<${buildJson})
+defaultSchemaPath=$(jq -r '.artifacts[] | select(.fileName|test(".*\\.schem")) | .relativePath' <<<${buildJson})
+
+export SERVER="limbo-${LIMBO_BUILD}.jar"
+
+if [ ! -f "$SERVER" ] || isTrue "$FORCE_REDOWNLOAD"; then
+    downloadUrl="${baseUrl}/artifact/${artifactPath}"
+    log "Downloading Limbo from $downloadUrl ..."
+    if ! curl -fsSL -o "$SERVER" "$downloadUrl"; then
+      log "ERROR: failed to download from $downloadUrl (status=$?)"
+      exit 3
+    fi
+
+fi
+
+if [ ! -f "${LIMBO_SCHEMA_FILENAME}" ]; then
+  log "Downloading default schem file"
+  if ! curl -o "${LIMBO_SCHEMA_FILENAME}" -fsSL "${baseUrl}/artifact/${defaultSchemaPath}"; then
+      log "ERROR: failed to download schema file $baseUrl (status=$?)"
+      exit 3
+  fi
+fi
+
+if [[ ${LEVEL} != *\;* ]]; then
+  LEVEL="${LEVEL};${LIMBO_SCHEMA_FILENAME}"
+fi
+export LEVEL
+
+export SKIP_LOG4J_CONFIG=true
+
+# Continue to Final Setup
+exec ${SCRIPTS:-/}start-finalSetupWorld $@

start-deployMagma

@@ -1,18 +1,93 @@
 #!/bin/bash
 
 . ${SCRIPTS:-/}start-utils
+export SKIP_LOG4J_CONFIG=true
 
-export SERVER="/data/magma-server-${VANILLA_VERSION}.jar"
+isDebugging && set -x
 
-# Always download since new updates of each base version are published frequently
-if ! curl -o /data/magma-server-${VANILLA_VERSION}.jar -fsSL \
-  https://api.magmafoundation.org/api/resources/Magma/${VANILLA_VERSION}/stable/latest/download; then
-  log "ERROR unable to download version ${VANILLA_VERSION} of Magma"
-  log "      Check https://magmafoundation.org/ for available versions"
+: ${VANILLA_VERSION?}
+# stable, dev
+: ${MAGMA_CHANNEL:=stable}
+
+
+magmaDownloadServer() {
+  url=${1?}
+  tagName=${2?}
+  markerFile=${3?}
+
+  export SERVER="/data/magma-server-${VANILLA_VERSION}.jar"
+
+  log "Downloading Magma server file for ${VANILLA_VERSION} @ ${tagName}"
+  if ! curl -o /data/magma-server-${VANILLA_VERSION}.jar -fsSL "$url"; then
+    log "ERROR failed to download Magma server from $url (status=$?)"
+    exit 1
+  fi
+
+  echo -n "$SERVER" > "$markerFile"
+}
+
+magmaHandleInstaller() {
+  url=${1?}
+  tagName=${2?}
+  markerFile=${3?}
+
+  installerFile="magma-installer-${VANILLA_VERSION}-${tagName}.jar"
+  log "Downloading Magma installer file for ${VANILLA_VERSION} @ ${tagName}"
+  if ! curl -o "$installerFile" -fsSL "$url"; then
+    log "ERROR failed to download Magma installer from $url (status=$?)"
+    exit 1
+  fi
+
+  echo "forge" > "$markerFile"
+
+  export FORGE_INSTALLER="$installerFile"
+  export FORGE_INSTALLER_CUSTOM_VERSION="$tagName"
+
+  # now hand off the rest to forge
+  exec ${SCRIPTS:-/}start-deployForge "$@"
+}
+
+latestMeta=$(curl -fsSL https://api.magmafoundation.org/api/resources/Magma/${VANILLA_VERSION}/${MAGMA_CHANNEL}/latest || exit $?)
+if [ $? != 0 ]; then
+  log "ERROR failed to locate latest Magma info for ${VANILLA_VERSION} in channel ${MAGMA_CHANNEL} (error=$?)"
   exit 1
 fi
 
-export SKIP_LOG4J_CONFIG=true
+tagName=$(echo "${latestMeta}" | jq -r '.tag_name')
+markerFile=".magma-installed-${VANILLA_VERSION}-${tagName}"
+if [ -f "${markerFile}" ]; then
+  installedTagName=$(cat "${markerFile}")
+fi
+
+if [ ! -f "${markerFile}" ]; then
+
+  if versionLessThan 1.16; then
+    assetType=server
+  else
+    assetType=installer
+  fi
+
+  assetUrl=$(echo "${latestMeta}" | jq -r ".assets | .[].browser_download_url | select(test(\"${assetType}\"))")
+  if [ $? != 0 ] || [ -z "$assetUrl" ]; then
+    log "ERROR failed to extract ${assetType} asset type for ${VANILLA_VERSION} in channel ${MAGMA_CHANNEL}"
+    exit 1
+  fi
+
+  if [[ ${assetType} = server ]]; then
+    magmaDownloadServer "$assetUrl" "$tagName" "$markerFile"
+  else
+    magmaHandleInstaller "$assetUrl" "$tagName" "$markerFile"
+  fi
+else
+  export SERVER=$(cat "${markerFile}")
+
+  if [[ $SERVER == "forge" ]]; then
+    export FORGE_INSTALLER="magma-installer-${VANILLA_VERSION}-${tagName}.jar"
+    export FORGE_INSTALLER_CUSTOM_VERSION="$tagName"
+    # now hand off the rest to forge
+    exec ${SCRIPTS:-/}start-deployForge "$@"
+  fi
+fi
 
 # Continue to Final Setup
 exec ${SCRIPTS:-/}start-finalSetupWorld $@

start-deployPurpur

@@ -10,7 +10,7 @@ isDebugging && set -x
 : ${FORCE_REDOWNLOAD:=false}
 
 if [[ ${PURPUR_BUILD} == LATEST ]]; then
-  PURPUR_BUILD=$(curl -fsSL "https://purpur.pl3x.net/api/v1/purpur/${VANILLA_VERSION}" |
+  PURPUR_BUILD=$(curl -fsSL "https://api.pl3x.net/v2/purpur/${VANILLA_VERSION}" |
     jq -r '.builds.latest' || echo "")
   if [[ -z ${PURPUR_BUILD} ]]; then
     log "ERROR: Failed to locate a Purpur build for ${VANILLA_VERSION}."
@@ -22,7 +22,7 @@ fi
 export SERVER="purpur-${VANILLA_VERSION}-${PURPUR_BUILD}.jar"
 
 if [ ! -f "$SERVER" ] || isTrue "$FORCE_REDOWNLOAD"; then
-    downloadUrl="https://purpur.pl3x.net/api/v1/purpur/${VANILLA_VERSION}/${PURPUR_BUILD}/download"
+    downloadUrl="https://api.pl3x.net/v2/purpur/${VANILLA_VERSION}/${PURPUR_BUILD}/download"
     log "Downloading Purpur from $downloadUrl ..."
     if ! curl -fsSL -o "$SERVER" "$downloadUrl"; then
       log "ERROR: failed to download from $downloadUrl (status=$?)"

start-deployTuinity

@@ -3,16 +3,16 @@
 . ${SCRIPTS:-/}start-utils
 
 if [ "${VERSION}" != "LATEST" ]; then
-  log "ERROR: Tunity server type only supports VERSION=LATEST"
+  log "ERROR: Tuinity server type only supports VERSION=LATEST"
   exit 1
 fi
 
-: ${TUNITY_BUILD:=lastSuccessfulBuild}
-export SERVER=tunity-${VANILLA_VERSION}-${TUNITY_BUILD}.jar
+: ${TUINITY_BUILD:=lastSuccessfulBuild}
+export SERVER=tuinity-${VANILLA_VERSION}-${TUINITY_BUILD}.jar
 
 if [ ! -f "$SERVER" ] || [ -n "$FORCE_REDOWNLOAD" ]; then
-    downloadUrl="https://ci.codemc.io/job/Spottedleaf/job/Tuinity/${TUNITY_BUILD}/artifact/tuinity-paperclip.jar"
-    log "Downloading Tunity (build $TUNITY_BUILD) from $downloadUrl ..."
+    downloadUrl="https://ci.codemc.io/job/Spottedleaf/job/Tuinity/${TUINITY_BUILD}/artifact/tuinity-paperclip.jar"
+    log "Downloading Tuinity (build $TUINITY_BUILD) from $downloadUrl ..."
     curl -fsSL -o "$SERVER" "$downloadUrl"
     if [ ! -f "$SERVER" ]; then
       log "ERROR: failed to download from $downloadUrl (status=$?)"

start-finalSetupModpack

@@ -154,7 +154,10 @@ fi
 if [[ "${GENERIC_PACK}" ]]; then
   if isURL "${GENERIC_PACK}"; then
     log "Downloading generic pack ..."
-    curl -fsSL -o /tmp/generic_pack.zip "${GENERIC_PACK}"
+    if ! curl -fsSL -o /tmp/generic_pack.zip "${GENERIC_PACK}"; then
+      log "ERROR: failed to download ${GENERIC_PACK}"
+      exit 2
+    fi
     GENERIC_PACK=/tmp/generic_pack.zip
   fi
 

start-finalSetupMounts

@@ -25,16 +25,16 @@ fi
 
 if [ -d /mods ]; then
   log "Copying any mods over..."
-  mkdir -p $COPY_MODS_DEST
-  rsync -a --out-format="update:%f:Last Modified %M" "${rsyncArgs[@]}" --prune-empty-dirs --update /mods/ $COPY_MODS_DEST
+  mkdir -p "${COPY_MODS_DEST}"
+  rsync -a --out-format="update:%f:Last Modified %M" "${rsyncArgs[@]}" --prune-empty-dirs --update /mods/ "${COPY_MODS_DEST}"
 fi
 
 : ${COPY_CONFIG_DEST:="/data/config"}
 
 if [ -d /config ]; then
-  log "Copying any configs from /config to $COPY_CONFIG_DEST"
-  mkdir -p $COPY_CONFIG_DEST
-  rsync -a --out-format="update:%f:Last Modified %M" "${rsyncArgs[@]}" --prune-empty-dirs --update /config/ $COPY_CONFIG_DEST
+  log "Copying any configs from /config to ${COPY_CONFIG_DEST}"
+  mkdir -p "${COPY_CONFIG_DEST}"
+  rsync -a --out-format="update:%f:Last Modified %M" "${rsyncArgs[@]}" --prune-empty-dirs --update /config/ "${COPY_CONFIG_DEST}"
 fi
 
 exec ${SCRIPTS:-/}start-finalSetupServerProperties $@

start-finalSetupServerProperties

@@ -19,7 +19,7 @@ function setServerProp {
       sed -i "/^${prop}\s*=/ c ${prop}=${var//\\/\\\\}" "$SERVER_PROPERTIES"
     else
       log "Adding ${prop} with '${var}' in ${SERVER_PROPERTIES}"
-      echo "${prop}=${var//\\/\\\\}" >> "$SERVER_PROPERTIES"
+      echo "${prop}=${var}" >> "$SERVER_PROPERTIES"
     fi
   else
     isDebugging && log "Skip setting ${prop}"
@@ -27,7 +27,7 @@ function setServerProp {
 }
 
 function customizeServerProps {
-  if [ -n "$WHITELIST" ]; then
+  if [ -n "$WHITELIST" ] || isTrue ${ENABLE_WHITELIST:-false}; then
     log "Creating whitelist"
     setServerProp "whitelist" "true"
     setServerProp "white-list" "true"
@@ -56,7 +56,7 @@ function customizeServerProps {
   setServerProp "server-name" "$SERVER_NAME"
   setServerProp "server-ip" "$SERVER_IP"
   setServerProp "server-port" "$SERVER_PORT"
-  setServerProp "motd" "$MOTD"
+  setServerProp "motd" "$(echo $MOTD | java -jar /usr/share/asciify/asciify.jar)"
   setServerProp "allow-nether" "$ALLOW_NETHER"
   setServerProp "announce-player-achievements" "$ANNOUNCE_PLAYER_ACHIEVEMENTS"
   setServerProp "enable-command-block" "$ENABLE_COMMAND_BLOCK"

start-minecraftFinalSetup

@@ -173,6 +173,10 @@ function copyFilesForCurseForge() {
 }
 
 mcServerRunnerArgs="--stop-duration ${STOP_DURATION:-60}s"
+if [[ ${STOP_SERVER_ANNOUNCE_DELAY} ]]; then
+  mcServerRunnerArgs="${mcServerRunnerArgs} --stop-server-announce-delay ${STOP_SERVER_ANNOUNCE_DELAY}s"
+fi
+
 if [[ ${TYPE} == "CURSE_INSTANCE" ]]; then
     if isTrue ${DEBUG_EXEC}; then
       set -x
@@ -225,6 +229,10 @@ EOF
   else
     exec mc-server-runner ${mcServerRunnerArgs} "${finalArgs[@]}"
   fi
+elif [[ -x run.sh ]]; then
+  log "Using Forge supplied run.sh script..."
+  echo $JVM_XX_OPTS $JVM_OPTS $expandedDOpts > user_jvm_args.txt
+  exec mc-server-runner ${mcServerRunnerArgs} --shell bash run.sh
 else
   # If we have a bootstrap.txt file... feed that in to the server stdin
   if [ -f /data/bootstrap.txt ]; then

start-spiget

@@ -6,6 +6,7 @@ IFS=$'\n\t'
 handleDebugMode
 
 : ${SPIGET_RESOURCES:=}
+: ${SPIGET_DOWNLOAD_TOLERANCE:=5} # in minutes
 
 containsJars() {
   file=${1?}
@@ -26,6 +27,49 @@ getResourceFromSpiget() {
 
   log "Downloading resource ${resource} ..."
 
+  mkdir -p /data/plugins
+
+  versionfile="/data/plugins/.${resource}-version.json"
+  versionfileNew="/tmp/.${resource}-version.json"
+
+  if [ -f "$versionfile" ]; then
+    if [[ -n $(find "$versionfile" -mmin +${SPIGET_DOWNLOAD_TOLERANCE}) ]]; then
+      urlVersion="https://api.spiget.org/v2/resources/${resource}/versions/latest"
+      if ! curl -o "${versionfileNew}" -fsSL -H "User-Agent: itzg/minecraft-server" "${extraCurlArgs[@]}" "${urlVersion}"; then
+        log "ERROR failed to download resource version meta data '${resource}' from ${urlVersion}"
+        exit 2
+      fi
+
+      installedVersion=$(jq -r '.name' $versionfile)
+      newVersion=$(jq -r '.name' $versionfileNew)
+      
+      if [ "$installedVersion" = "$newVersion" ]; then
+        log "resource '${resource}' not downloaded because installed version '${installedVersion}' already up to date ('${newVersion}')"
+        mv "${versionfileNew}" "${versionfile}"
+      else
+        if downloadResourceFromSpiget "${resource}"; then
+          mv "${versionfileNew}" "${versionfile}"
+        fi
+      fi
+    else
+      log "resource '${resource}' not checked because version meta file newer than '${SPIGET_DOWNLOAD_TOLERANCE}' minutes"
+    fi
+  else
+    if downloadResourceFromSpiget "${resource}"; then
+      urlVersion="https://api.spiget.org/v2/resources/${resource}/versions/latest"
+      if ! curl -o "${versionfileNew}" -fsSL -H "User-Agent: itzg/minecraft-server" "${extraCurlArgs[@]}" "${urlVersion}"; then
+        log "ERROR failed to download resource version meta data '${resource}' from ${urlVersion}"
+        exit 2
+      fi
+      mv "${versionfileNew}" "${versionfile}"
+    fi
+  fi
+
+}
+
+downloadResourceFromSpiget() {
+  resource=${1?}
+
   tmpfile="/tmp/${resource}.zip"
   url="https://api.spiget.org/v2/resources/${resource}/download"
   if ! curl -o "${tmpfile}" -fsSL -H "User-Agent: itzg/minecraft-server" "${extraCurlArgs[@]}" "${url}"; then
@@ -33,7 +77,6 @@ getResourceFromSpiget() {
     exit 2
   fi
 
-  mkdir -p /data/plugins
   if containsJars "${tmpfile}"; then
     log "Extracting contents of resource ${resource} into plugins"
     unzip -o -q -d /data/plugins "${tmpfile}"

tests/docker-compose.test.yml

@@ -17,5 +17,4 @@ services:
       - itzg/minecraft-server:latest
     environment:
       EULA: "TRUE"
-      VERSION: "1.16.5"