Corrected default of UID/GID via start script (#1471)

Fixes #1469

.github/workflows/build-multiarch.yml

@@ -18,52 +18,70 @@ jobs:
       matrix:
         variant:
           - java17
+          - java17-jdk
           - java17-openj9
           - java17-alpine
           - java8
           - java8-multiarch
           - java8-openj9
+          - java8-jdk
           - java11
           - java11-openj9
+          - java11-jdk
         include:
+        # JAVA 17:
           - variant: java17
+            baseImage: eclipse-temurin:17-jre
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: LATEST
+          - variant: java17-jdk
             baseImage: eclipse-temurin:17
             platforms: linux/amd64,linux/arm/v7,linux/arm64
             mcVersion: LATEST
           - variant: java17-openj9
-            baseImage: ibm-semeru-runtimes:open-17-jdk
+            baseImage: ibm-semeru-runtimes:open-17-jre
             platforms: linux/amd64,linux/arm64
             mcVersion: LATEST
           - variant: java17-alpine
-            baseImage: eclipse-temurin:17-jdk-alpine
+            baseImage: eclipse-temurin:17-jre-alpine
             platforms: linux/amd64
             mcVersion: LATEST
-          - variant: java8
-            baseImage: openjdk:8-jdk-alpine3.8
-            platforms: linux/amd64
-            mcVersion: 1.12.2
-          - variant: java8-multiarch
-            baseImage: eclipse-temurin:8-jdk
-            platforms: linux/amd64,linux/arm64
-            mcVersion: 1.12.2
-          - variant: java8-openj9
-            baseImage: ibm-semeru-runtimes:open-8-jdk
-            platforms: linux/amd64,linux/arm64
-            mcVersion: 1.12.2
+        # JAVA 11:
           - variant: java11
+            baseImage: adoptopenjdk:11-jre-hotspot
+            platforms: linux/amd64,linux/arm/v7,linux/arm64
+            mcVersion: 1.16.5
+          - variant: java11-jdk
             baseImage: adoptopenjdk:11-jdk-hotspot
             platforms: linux/amd64,linux/arm/v7,linux/arm64
             mcVersion: 1.16.5
           - variant: java11-openj9
-            baseImage: ibm-semeru-runtimes:open-11-jdk
+            baseImage: ibm-semeru-runtimes:open-11-jre
             platforms: linux/amd64,linux/arm64
             mcVersion: 1.16.5
+        # JAVA 8: NOTE: Unable to go past 8u312 because of Forge dependencies
+          - variant: java8
+            baseImage: openjdk:8-jre-alpine3.9
+            platforms: linux/amd64
+            mcVersion: 1.12.2
+          - variant: java8-multiarch
+            baseImage: eclipse-temurin:8u312-b07-jre
+            platforms: linux/amd64,linux/arm64
+            mcVersion: 1.12.2
+          - variant: java8-jdk
+            baseImage: eclipse-temurin:8u312-b07-jdk
+            platforms: linux/amd64,linux/arm64
+            mcVersion: 1.12.2
+          - variant: java8-openj9
+            baseImage: ibm-semeru-runtimes:open-8u312-b07-jre
+            platforms: linux/amd64,linux/arm64
+            mcVersion: 1.12.2
     env:
       IMAGE_TO_TEST: ${{ github.repository_owner }}/minecraft-server:test-${{ matrix.variant }}-${{ github.run_id }}
     runs-on: ubuntu-20.04
     steps:
       - name: Checkout
-        uses: actions/checkout@v2.4.0
+        uses: actions/checkout@v3
         with:
           # for build-files step
           fetch-depth: 0
@@ -97,13 +115,8 @@ jobs:
           username: ${{ secrets.DOCKER_USER }}
           password: ${{ secrets.DOCKER_PASSWORD }}
 
-      - name: Calculate build files revision
-        id: build-files
-        run: |
-          echo "::set-output name=REV::$(git log -1 --format=%H build)"
-
       - name: Build for test
-        uses: docker/build-push-action@v2.9.0
+        uses: docker/build-push-action@v2.10.0
         with:
           platforms: linux/amd64
           tags: ${{ env.IMAGE_TO_TEST }}
@@ -114,19 +127,20 @@ jobs:
           push: false
           build-args: |
             BASE_IMAGE=${{ matrix.baseImage }}
-            BUILD_FILES_REV=${{ steps.build-files.outputs.REV }}
           cache-from: type=gha,scope=${{ matrix.variant }}
           # no cache-to to avoid cross-cache update from next build step
 
       - name: Run tests
         env:
           MINECRAFT_VERSION: ${{ matrix.mcVersion }}
+          VARIANT: ${{ matrix.variant }}
+          MODS_FORGEAPI_KEY: ${{ secrets.MODS_FORGEAPI_KEY }}
         run: |
           tests/test.sh
 
       - name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v2.9.0
+        uses: docker/build-push-action@v2.10.0
         with:
           platforms: ${{ matrix.platforms }}
           push: ${{ github.ref_type == 'tag' || github.ref_name == 'master' }}

.github/workflows/ci.yml

@@ -21,13 +21,13 @@ jobs:
     runs-on: ubuntu-20.04
 
     steps:
-      - uses: actions/checkout@v2.4.0
+      - uses: actions/checkout@v3
 
       - name: Setup Docker Buildx
         uses: docker/setup-buildx-action@v1
 
       - name: Build
-        uses: docker/build-push-action@v2.9.0
+        uses: docker/build-push-action@v2.10.0
         with:
           context: .
           platforms: linux/amd64

.github/workflows/generate-toc.yml

@@ -11,11 +11,11 @@ jobs:
     runs-on: ubuntu-latest
     timeout-minutes: 5
     steps:
-      - uses: actions/checkout@v2.4.0
+      - uses: actions/checkout@v3
       - run: |
           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.13.1
+      - uses: stefanzweifel/git-auto-commit-action@v4.14.0
         with:
           commit_message: "docs: Auto update markdown TOC"

.github/workflows/pr.yml

@@ -11,20 +11,19 @@ on:
 
 env:
   IMAGE_TO_TEST: itzg/minecraft-server:test-${{ github.repository_owner }}-${{ github.run_id }}
-  MODS_FORGEAPI_KEY: ${{ secrets.MODS_FORGEAPI_KEY }}
 
 jobs:
   test:
     runs-on: ubuntu-20.04
 
     steps:
-      - uses: actions/checkout@v2.4.0
+      - uses: actions/checkout@v3
 
       - name: Setup Docker Buildx
         uses: docker/setup-buildx-action@v1
 
       - name: Build
-        uses: docker/build-push-action@v2.9.0
+        uses: docker/build-push-action@v2.10.0
         with:
           context: .
           platforms: linux/amd64
@@ -33,6 +32,9 @@ jobs:
           cache-from: type=gha
 
       - name: Run tests
+        env:
+          MODS_FORGEAPI_KEY: ${{ secrets.MODS_FORGEAPI_KEY }}
+          MINECRAFT_VERSION: LATEST
         run: |
           tests/test.sh
 
@@ -53,7 +55,7 @@ jobs:
 
       - name: Push
         if: contains(github.event.pull_request.labels.*.name, 'ci/push-image')
-        uses: docker/build-push-action@v2.9.0
+        uses: docker/build-push-action@v2.10.0
         with:
           context: .
           platforms: linux/amd64,linux/arm/v7,linux/arm64

.github/workflows/stale-check.yml

@@ -12,7 +12,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Process Stale Issues
-        uses: actions/stale@v4.1.0
+        uses: actions/stale@v5
         with:
           stale-issue-label: status/stale
           stale-pr-label: status/stale

.gitignore

@@ -3,3 +3,4 @@
 /.idea/
 *.iml
 /gh-md-toc
+personal-build-and-develop.*

DEVELOPMENT.md

@@ -23,10 +23,17 @@ $env:IMAGE_TO_TEST="mc-dev"
 docker build -t $env:IMAGE_TO_TEST .
 pushd "tests/setuponlytests/$env:FOLDER_TO_TEST/"
 docker-compose run mc
-docker-compose down --remove-orphans
+docker-compose down -v --remove-orphans
 popd
 ```
 
+PowerShell: Building different images of Java for testing
+```powershell
+$env:BASE_IMAGE='eclipse-temurin:8u312-b07-jre'
+$env:IMAGE_TO_TEST="mc-dev"
+docker build --build-arg BASE_IMAGE=$env:BASE_IMAGE -t $env:IMAGE_TO_TEST .
+```
+
 Bash: (Example of building and testing ForgeAPI)
 ```bash
 export MODS_FORGEAPI_KEY='$2a$...'
@@ -35,7 +42,7 @@ export IMAGE_TO_TEST="mc-dev"
 docker build -t $IMAGE_TO_TEST .
 pushd tests/setuponlytests/$FOLDER_TO_TEST/
 docker-compose run mc
-docker-compose down --remove-orphans
+docker-compose down -v --remove-orphans
 popd
 ```
 

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.16.6
+ARG MC_HELPER_VERSION=1.16.11
 ARG MC_HELPER_BASE_URL=https://github.com/itzg/mc-image-helper/releases/download/v${MC_HELPER_VERSION}
 RUN curl -fsSL ${MC_HELPER_BASE_URL}/mc-image-helper-${MC_HELPER_VERSION}.tgz \
   | tar -C /usr/share -zxf - \
@@ -57,13 +57,7 @@ WORKDIR /data
 
 STOPSIGNAL SIGTERM
 
-ENV UID=1000 GID=1000 \
-  MEMORY="1G" \
-  TYPE=VANILLA VERSION=LATEST \
-  ENABLE_RCON=true RCON_PORT=25575 RCON_PASSWORD=minecraft \
-  ENABLE_AUTOPAUSE=false AUTOPAUSE_TIMEOUT_EST=3600 AUTOPAUSE_TIMEOUT_KN=120 AUTOPAUSE_TIMEOUT_INIT=600 \
-  AUTOPAUSE_PERIOD=10 AUTOPAUSE_KNOCK_INTERFACE=eth0 \
-  ENABLE_AUTOSTOP=false AUTOSTOP_TIMEOUT_EST=3600 AUTOSTOP_TIMEOUT_INIT=1800 AUTOSTOP_PERIOD=10
+ENV TYPE=VANILLA VERSION=LATEST EULA=""
 
 COPY --chmod=755 scripts/start* /
 COPY --chmod=755 bin/ /usr/local/bin/
@@ -72,8 +66,9 @@ COPY --chmod=644 files/server.properties /tmp/server.properties
 COPY --chmod=644 files/log4j2.xml /tmp/log4j2.xml
 COPY --chmod=755 files/autopause /autopause
 COPY --chmod=755 files/autostop /autostop
+COPY --chmod=755 files/rconcmds /rconcmds
 
-RUN dos2unix /start* /autopause/* /autostop/*
+RUN dos2unix /start* /autopause/* /autostop/* /rconcmds/*
 
 ENTRYPOINT [ "/start" ]
 HEALTHCHECK --start-period=1m CMD mc-health

README.md

@@ -33,6 +33,14 @@ By default, the container will download the latest version of the "vanilla" [Min
    * [Versions](#versions)
    * [Running Minecraft server on different Java version](#running-minecraft-server-on-different-java-version)
       * [Deprecated Image Tags](#deprecated-image-tags)
+   * [Related Projects](#related-projects)
+      * [<a href="https://github.com/itzg/docker-minecraft-bedrock-server">itzg/minecraft-bedrock-server</a>](#itzgminecraft-bedrock-server)
+      * [<a href="https://github.com/itzg/mc-router">mc-router</a>](#mc-router)
+      * [<a href="https://github.com/itzg/docker-bungeecord/">itzg/bungeecord</a>](#itzgbungeecord)
+      * [<a href="https://github.com/itzg/docker-mc-backup">itzg/mc-backup</a>](#itzgmc-backup)
+      * [<a href="https://github.com/itzg/rcon-cli">rcon-cli</a>](#rcon-cli)
+      * [<a href="https://github.com/itzg/mc-monitor">mc-monitor</a>](#mc-monitor)
+      * [<a href="https://github.com/itzg/mc-image-helper">mc-image-helper</a>](#mc-image-helper)
    * [Healthcheck](#healthcheck)
    * [Deployment Templates and Examples](#deployment-templates-and-examples)
       * [Helm Charts](#helm-charts)
@@ -135,6 +143,7 @@ By default, the container will download the latest version of the "vanilla" [Min
       * [Setup only](#setup-only)
       * [Enable Flare Flags](#enable-flare-flags)
       * [Enable timestamps in init logs](#enable-timestamps-in-init-logs)
+      * [Use RCON commands](#use-rcon-commands)
    * [Autopause](#autopause)
       * [Description](#description)
       * [Enabling Autopause](#enabling-autopause)
@@ -142,7 +151,8 @@ By default, the container will download the latest version of the "vanilla" [Min
    * [Running on RaspberryPi](#running-on-raspberrypi)
    * [Contributing](#contributing)
 
-<!-- Added by: runner, at: Sat Feb 12 02:37:53 UTC 2022 -->
+<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
+<!-- Added by: runner, at: Sat Apr  2 20:38:28 UTC 2022 -->
 
 <!--te-->
 
@@ -287,16 +297,17 @@ the server jar remain in the `/data` directory. It is safe to remove those._
 
 When using the image `itzg:/minecraft-server` without a tag, the `latest` image tag is implied from the table below. To use a different version of Java, please use an alternate tag to run your Minecraft server container.
 
-| Tag name       | Java version | Linux  | JVM Type | Architecture      |
-| -------------- | -------------|--------|----------|-------------------|
-| latest         | 17           | Debian | Hotspot  | amd64,arm64,armv7 |
-| java8          | 8            | Alpine | Hotspot  | amd64             |
+| Tag name        | Java version | Linux  | JVM Type | Architecture      |
+|-----------------|-------------|--------|----------|-------------------|
+| latest          | 17          | Debian | Hotspot  | amd64,arm64,armv7 |
+| java8           | 8           | Alpine | Hotspot  | amd64             |
 | java8-multiarch | 8           | Debian | Hotspot  | amd64,arm64,armv7 |
-| java8-openj9   | 8            | Debian | OpenJ9   | amd64             |
-| java11         | 11           | Debian | Hotspot  | amd64,arm64,armv7 |
-| java11-openj9  | 11           | Debian | OpenJ9   | amd64             |
-| java17         | 17           | Ubuntu | Hotspot  | amd64,arm64,armv7 |
-| java17-openj9  | 17           | Debian | OpenJ9   | amd64             |
+| java8-openj9    | 8           | Debian | OpenJ9   | amd64             |
+| java11          | 11          | Debian | Hotspot  | amd64,arm64,armv7 |
+| java11-openj9   | 11          | Debian | OpenJ9   | amd64             |
+| java17          | 17          | Ubuntu | Hotspot  | amd64,arm64,armv7 |
+| java17-openj9   | 17          | Debian | OpenJ9   | amd64             |
+| java17-alpine   | 17          | Alpine | Hotspot  | amd64             |
 
 For example, to use Java version 8 on any supported architecture:
 
@@ -316,6 +327,36 @@ The following image tags have been deprecated and are no longer receiving update
 - multiarch-latest
 - java16/java16-openj9
 
+## Related Projects
+
+### [itzg/minecraft-bedrock-server](https://github.com/itzg/docker-minecraft-bedrock-server)
+
+Docker image that runs a Minecraft Bedrock server.
+
+### [mc-router](https://github.com/itzg/mc-router)
+
+Lightweight multiplexer/proxy for Minecraft Java servers. Provided as a stand-alone application and a Docker image.
+
+### [itzg/bungeecord](https://github.com/itzg/docker-bungeecord/)
+
+Docker image that runs a proxy powered by Bungeecord, Velocity, or Waterfall
+
+### [itzg/mc-backup](https://github.com/itzg/docker-mc-backup)
+
+Docker image that runs as a side-car container to backup world data.
+
+### [rcon-cli](https://github.com/itzg/rcon-cli)
+
+A tool that is bundled with this image to provide CLI access to an RCON endpoint.
+
+### [mc-monitor](https://github.com/itzg/mc-monitor)
+
+A tool that is bundled with this image that provides health checks and metrics reporting, such as a Prometheus exporter or a telegraf data source.
+
+### [mc-image-helper](https://github.com/itzg/mc-image-helper)
+
+A tool that is bundled with this image to provide complex, re-usable preparation operations. 
+
 ## Healthcheck
 
 This image contains [mc-monitor](https://github.com/itzg/mc-monitor) and uses
@@ -499,10 +540,10 @@ A [Pufferfish](https://github.com/pufferfish-gg/Pufferfish) server, which is "a
 
     -e TYPE=PUFFERFISH
 
-> NOTE: The `VERSION` variable is used to select a Pufferfish branch to download from. The available options are "LATEST" and "1.18"
+> NOTE: The `VERSION` variable is used to select branch latest, 1.18, or 1.17. Use PUFFERFISH_BUILD to really select the SERVER VERSION number.
 
 Extra variables:
-- `PUFFERFISH_BUILD=lastSuccessfulBuild` : set a specific Pufferfish build to use
+- `PUFFERFISH_BUILD=lastSuccessfulBuild` : set a specific Pufferfish build to use. Example: selecting build 47 => 1.18.1, or build 50 => 1.18.2 etc
 - `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 built-in [Flare](https://blog.airplane.gg/flare) profiler
 
@@ -568,7 +609,7 @@ Enable SpongeVanilla server mode by adding a `-e TYPE=SPONGEVANILLA` to your com
     
 By default the container will run the latest `STABLE` version.
 If you want to run a specific version, you can add `-e SPONGEVERSION=1.11.2-6.1.0-BETA-19` to your command-line.
-
+    
 Beware that current [Sponge](https://www.spongepowered.org) `STABLE` versions for Minecraft 1.12 require using [the Java 8 tag](#running-minecraft-server-on-different-java-version):
     
     docker run -d -v /path/on/host:/data -e TYPE=SPONGEVANILLA \
@@ -613,8 +654,8 @@ Crucible is only available for 1.7.10, so be sure to set `VERSION=1.7.10`.
 [Feed the Beast application](https://www.feed-the-beast.com/) modpacks are supported by using `-e TYPE=FTBA` (**note** the "A" at the end of the type). This server type will automatically take care of downloading and installing the modpack and appropriate version of Forge, so the `VERSION` does not need to be specified.
 
 ### Environment Variables:
-- `FTB_MODPACK_ID`: **required**, the numerical ID of the modpack to install. The ID can be located by [finding the modpack](https://www.feed-the-beast.com/modpack) and using the "ID" displayed next to the name
-- `FTB_MODPACK_VERSION_ID`: optional, the numerical Id of the version to install. If not specified, the latest version will be installed. The "Version ID" can be obtained by drilling into the Versions tab and clicking a specific version.
+- `FTB_MODPACK_ID`: **required**, the numerical ID of the modpack to install. The ID can be located by [finding the modpack](https://www.feed-the-beast.com/modpack) and hovering over the name of the modpack, [as shown here](docs/ftba-identifier-popup.png).
+- `FTB_MODPACK_VERSION_ID`: optional, the numerical Id of the version to install. If not specified, the latest version will be installed. The "Version ID" can be obtained by drilling into the Versions tab and hovering over the version name, [as shown here](docs/ftba-version-id-popup.png).
 
 ### Upgrading
 
@@ -933,6 +974,7 @@ VANILLATWEAKS_FILE: /config/vt-datapacks.json,/config/vt-craftingtweaks.json,/co
 Datapacks Json:
 ```json
 {
+  "type": "datapacks",
   "version": "1.18",
   "packs": {
     "survival": [
@@ -1487,6 +1529,9 @@ To let the JVM calculate the heap size from the container declared memory limit,
 
 General JVM options can be passed to the Minecraft Server invocation by passing a `JVM_OPTS`
 environment variable. The JVM requires `-XX` options to precede `-X` options, so those can be declared in `JVM_XX_OPTS`. Both variables are space-delimited, raw JVM arguments.
+```
+-e JVM_OPTS="-someJVMOption someJVMOptionValue"
+```
 
 For some cases, if e.g. after removing mods, it could be necessary to startup minecraft with an additional `-D` parameter like `-Dfml.queryResult=confirm`. To address this you can use the environment variable `JVM_DD_OPTS`, which builds the params from a given list of values separated by space, but without the `-D` prefix. To make things running under systems (e.g. Plesk), which doesn't allow `=` inside values, a `:` (colon) could be used instead. The upper example would look like this:
 `JVM_DD_OPTS=fml.queryResult:confirm`, and will be converted to `-Dfml.queryResult=confirm`.
@@ -1615,6 +1660,73 @@ To also include the timestamp with each log, set `LOG_TIMESTAMP` to "true". The
 [init] 2022-02-05 16:58:33+00:00 Starting the Minecraft server...
 ```
 
+### Use RCON commands
+
+Feature is used run commands when the server starts, client connects, or client disconnects.
+**Notes:**
+* On client connect we only know there was a connection, and not who connected. RCON commands will need to be used for that.
+* Using '|-' is preferred for yaml, this make sure only the correct new lines are in place for the commands.
+
+**On Server Start:**
+
+```yaml
+      RCON_CMDS_STARTUP:  |-
+        /gamerule doFireTick false
+        /pregen start 200
+```
+
+**On Client Connection:**
+
+```yaml
+      RCON_CMDS_ON_CONNECT:  |-
+        /team join New @a[team=]
+```
+
+**On Client Disconnect:**
+
+```yaml
+      RCON_CMDS_ON_DISCONNECT:  |-
+        /gamerule doFireTick true
+```
+
+**On First Client Connect**
+
+```yaml
+      RCON_CMDS_FIRST_CONNECT: |-
+        /pregen stop
+```
+
+**On Last Client Disconnect**
+
+```yaml
+      RCON_CMDS_LAST_DISCONNECT: |-
+        /kill @e[type=minecraft:boat]
+        /pregen start 200
+
+```
+
+**Example of rules for new players**
+
+Uses team NEW and team OLD to track players on the server. So move player with no team to NEW, run a command, move them to team OLD.
+[Reference Article](https://www.minecraftforum.net/forums/minecraft-java-edition/redstone-discussion-and/2213523-detect-players-first-join)
+
+```yaml
+      RCON_CMDS_STARTUP:  |-
+        /pregen start 200
+        /gamerule doFireTick false
+        /team add New
+        /team add Old
+      RCON_CMDS_ON_CONNECT: |-
+        /team join New @a[team=]
+        /give @a[team=New] birch_boat
+        /team join Old @a[team=New]
+      RCON_CMDS_FIRST_CONNECT: |-
+        /pregen stop
+      RCON_CMDS_LAST_DISCONNECT: |-
+        /kill @e[type=minecraft:boat]
+        /pregen start 200
+```
+
 ## Autopause
 
 ### Description

bin/mc-send-to-console

@@ -12,4 +12,8 @@ if [ ! -p "${CONSOLE_IN_NAMED_PIPE}" ]; then
   exit 1
 fi
 
-gosu minecraft bash -c "echo $* > '${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}'"
+if [ "$(id -u)" = 0 ]; then
+  gosu minecraft bash -c "echo $* > '${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}'"
+else
+  echo "$@" > "${CONSOLE_IN_NAMED_PIPE:-/tmp/minecraft-console-in}"
+fi

build/alpine/install-packages.sh

@@ -10,6 +10,7 @@ apk add --no-cache -U \
     su-exec \
     coreutils \
     findutils \
+    procps \
     shadow \
     bash \
     curl iputils \
@@ -21,6 +22,5 @@ apk add --no-cache -U \
     nano \
     sudo \
     knock \
-    ttf-dejavu \
     tar \
     zstd

build/ubuntu/install-packages.sh

@@ -22,7 +22,6 @@ apt-get install -y \
   nano \
   unzip \
   zstd \
-  knockd \
-  ttf-dejavu
+  knockd
 
 apt-get clean

examples/docker-compose-rconcmd.yml

@@ -0,0 +1,36 @@
+version: '3'
+
+services:
+  minecraft:
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    ports:
+      - "25565:25565"
+    volumes:
+      - "mc:/data"
+    environment:
+      EULA: "TRUE"
+      TYPE: FABRIC
+      MODS_FORGEAPI_PROJECTIDS: 433175
+      MODS_FORGEAPI_KEY: ${MODS_FORGEAPI_KEY}
+      MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES: "TRUE"
+      REMOVE_OLD_FORGEAPI_MODS: "TRUE"
+      # YAML Heredoc, be sure to use '|-' this will remove the first newline and final new line.
+      # This is versus '|' that will leaving with two empty strings at top and bottom.
+      RCON_CMDS_STARTUP:  |-
+        /gamerule doFireTick false
+        /team add New
+        /team add Old
+        /chunky radius 1000
+        /chunky start
+      RCON_CMDS_ON_CONNECT: |-
+        /team join New @a[team=]
+        /give @a[team=New] birch_boat
+        /team join Old @a[team=New]
+      RCON_CMDS_FIRST_CONNECT: |-
+        /chunky pause
+      RCON_CMDS_LAST_DISCONNECT: |-
+        /kill @e[type=minecraft:boat]
+        /chunky continue
+    restart: unless-stopped
+volumes:
+  mc: {}

examples/docker-compose-simple.yml

@@ -3,6 +3,8 @@ version: "3.8"
 services:
   mc:
     image: itzg/minecraft-server
+    tty: true
+    stdin_open: true
     ports:
       - 25565:25565
     environment:

examples/docker-compose-spiget.yml

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

files/autopause/autopause-fcns.sh

@@ -20,12 +20,16 @@ mc_server_listening() {
   mc-monitor status --host localhost --port "$SERVER_PORT" --timeout 10s >& /dev/null
 }
 
-java_clients_connected() {
+java_clients_connections() {
   local connections
   if java_running ; then
     connections=$(mc-monitor status --host localhost --port "$SERVER_PORT" --show-player-count)
   else
     connections=0
   fi
-  (( connections > 0 ))
+  echo $connections
+}
+
+java_clients_connected() {
+  (( $(java_clients_connections) > 0 ))
 }

files/autopause/knockd-config.cfg

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

files/rconcmds/rcon-cmds-daemon.sh

@@ -0,0 +1,101 @@
+#!/bin/bash
+
+: "${RCON_CMDS_STARTUP:=}"
+: "${RCON_CMDS_ON_CONNECT:=}"
+: "${RCON_CMDS_ON_DISCONNECT:=}"
+: "${RCON_CMDS_FIRST_CONNECT:=}"
+: "${RCON_CMDS_LAST_DISCONNECT:=}"
+: "${RCON_CMDS_PERIOD:=10}"
+
+# needed for the clients connected function residing in autopause
+# shellcheck source=/autopause/autopause-fcns.sh
+. /autopause/autopause-fcns.sh
+
+# shellcheck source=start-utils
+. ${SCRIPTS:-/}start-utils
+
+run_command(){
+  rcon_cmd="$1"
+  logRcon "running - $rcon_cmd"
+  output=$(rcon-cli "$rcon_cmd")
+  logRcon "$output"
+}
+
+
+# wait for java process to be started
+while :
+do
+  if java_process_exists ; then
+    break
+  fi
+  sleep 0.1
+done
+
+CLIENTCONNECTIONS=0
+STATE=INIT
+
+while :
+do
+  case X$STATE in
+  XINIT)
+    # Server startup
+    if mc_server_listening ; then
+      logRcon "MCServer is listening, running startup"
+      if [[ "$RCON_CMDS_STARTUP" ]]; then
+        while read -r cmd; do
+          run_command "$cmd"
+        done <<< "$RCON_CMDS_STARTUP"
+      fi
+      if 
+        [[ -z "$RCON_CMDS_ON_CONNECT" ]] && 
+        [[ -z "$RCON_CMDS_ON_DISCONNECT" ]] && 
+        [[ -z "$RCON_CMDS_FIRST_CONNECT" ]] && 
+        [[ -z "$RCON_CMDS_LAST_DISCONNECT" ]]
+      then
+        logRcon "No addition rcon commands are given, stopping rcon cmd service"
+        exit 0
+      fi
+      STATE=II
+    fi
+    ;;
+  XII)
+    CURR_CLIENTCONNECTIONS=$(java_clients_connections)
+    # First client connection
+    # Setting priority run order: on first client connection is usually to STOP maintence, aka DO THIS FIRST
+    if (( CURR_CLIENTCONNECTIONS > 0 )) && (( CLIENTCONNECTIONS == 0 )) && [[ "$RCON_CMDS_FIRST_CONNECT" ]]; then
+        logRcon "First Clients has Connected, running first connect cmds"
+        while read -r cmd; do
+          run_command "$cmd"
+        done <<< "$RCON_CMDS_FIRST_CONNECT"
+    fi
+
+    # When a client joins
+    if (( CURR_CLIENTCONNECTIONS > CLIENTCONNECTIONS )) && [[ "$RCON_CMDS_ON_CONNECT" ]]; then
+        logRcon "Clients have Connected, running connect cmds"
+        while read -r cmd; do
+          run_command "$cmd"
+        done <<< "$RCON_CMDS_ON_CONNECT"
+    # When a client leaves
+    elif (( CURR_CLIENTCONNECTIONS < CLIENTCONNECTIONS )) && [[ "$RCON_CMDS_ON_DISCONNECT" ]]; then
+        logRcon "Clients have Disconnected, running disconnect cmds"
+        while read -r cmd; do
+          run_command "$cmd"
+        done <<< "$RCON_CMDS_ON_DISCONNECT"
+    fi
+
+    # Last client connection
+    # Setting priority run order: on last client connection is usually to START maintence, aka DO THIS LAST
+    if (( CURR_CLIENTCONNECTIONS == 0 )) && (( CLIENTCONNECTIONS > 0 )) && [[ "$RCON_CMDS_LAST_DISCONNECT" ]]; then
+        logRcon "ALL Clients have Disconnected, running last disconnect cmds"
+        while read -r cmd; do
+          run_command "$cmd"
+        done <<< "$RCON_CMDS_LAST_DISCONNECT"
+    fi
+    CLIENTCONNECTIONS=$CURR_CLIENTCONNECTIONS
+    ;;
+  *)
+    logRcon "Error: invalid state: $STATE"
+    ;;
+  esac
+  sleep "$RCON_CMDS_PERIOD"
+done

files/sudoers-mc

@@ -1,2 +1,2 @@
-%minecraft ALL=(ALL) NOPASSWD:/usr/bin/pkill
-%minecraft ALL=(ALL) NOPASSWD:/usr/sbin/knockd
+minecraft ALL=(ALL) NOPASSWD:/usr/bin/pkill
+minecraft ALL=(ALL) NOPASSWD:/usr/sbin/knockd

scripts/start

@@ -3,6 +3,9 @@
 # shellcheck source=start-utils
 . "${SCRIPTS:-/}start-utils"
 
+: "${UID:=1000}"
+: "${GID:=1000}"
+
 umask 0002
 chmod g+w /data
 

scripts/start-autopause

@@ -4,7 +4,19 @@
 . "${SCRIPTS:-/}start-utils"
 
 : "${SERVER_PORT:=25565}"
+: "${ENABLE_AUTOPAUSE:=false}"
+: "${AUTOPAUSE_TIMEOUT_EST:=3600}"
+: "${AUTOPAUSE_TIMEOUT_KN:=120}"
+: "${AUTOPAUSE_TIMEOUT_INIT:=600}"
+: "${AUTOPAUSE_PERIOD:=10}"
+: "${AUTOPAUSE_KNOCK_INTERFACE:=eth0}"
 export SERVER_PORT
+export ENABLE_AUTOPAUSE
+export AUTOPAUSE_TIMEOUT_EST
+export AUTOPAUSE_TIMEOUT_KN
+export AUTOPAUSE_TIMEOUT_INIT
+export AUTOPAUSE_PERIOD
+export AUTOPAUSE_KNOCK_INTERFACE
 
 log "Autopause functionality enabled"
 

scripts/start-autostop

@@ -4,7 +4,15 @@
 . "${SCRIPTS:-/}start-utils"
 
 : "${SERVER_PORT:=25565}"
+: "${ENABLE_AUTOSTOP:=false}"
+: "${AUTOSTOP_TIMEOUT_EST:=3600}"
+: "${AUTOSTOP_TIMEOUT_INIT:=1800}"
+: "${AUTOSTOP_PERIOD:=10}"
 export SERVER_PORT
+export ENABLE_AUTOSTOP
+export AUTOSTOP_TIMEOUT_EST
+export AUTOSTOP_TIMEOUT_INIT
+export AUTOSTOP_PERIOD
 
 log "Autostop functionality enabled"
 

scripts/start-configuration

@@ -7,7 +7,18 @@ IFS=$'\n\t'
 
 : "${EULA:=}"
 : "${PROXY:=}"
+: "${ENABLE_AUTOPAUSE:=false}"
+: "${ENABLE_AUTOSTOP:=false}"
+: "${RCON_CMDS_STARTUP:=}"
+: "${RCON_CMDS_ON_CONNECT:=}"
+: "${RCON_CMDS_ON_DISCONNECT:=}"
+: "${RCON_CMDS_FIRST_CONNECT:=}"
+: "${RCON_CMDS_LAST_DISCONNECT:=}"
+: "${RCON_CMDS_PERIOD:=10}"
 : "${RCON_PASSWORD_FILE:=}"
+: "${RCON_PASSWORD:=minecraft}"
+: "${RCON_PORT:=25575}"
+export RCON_PASSWORD RCON_PORT
 
 shopt -s nullglob
 
@@ -66,11 +77,27 @@ if [[ $RCON_PASSWORD_FILE ]]; then
     log ""
 fi
 
-# Some Docker management UIs grab all the image declared variables and present them for configuration.
-# When upgrading images across Java versions, that creates a mismatch in PATH's expected by base image.
-if ! which java > /dev/null; then
-  log "ERROR: PATH should not be explicitly passed into the container"
-  log "       Remove configuration of that variable."
+function fixJavaPath() {
+  # Some Docker management UIs grab all the image declared variables and present them for configuration.
+  # When upgrading images across Java versions, that creates a mismatch in PATH's expected by base image.
+  if ! which java > /dev/null; then
+    log "ERROR: your Docker provider has an annoying flaw where it"
+    log "       tries to set PATH even though the container establishes"
+    log "       a very specific value."
+    sleep 2
+    # now find where java might be
+    for d in /opt/java/openjdk/bin /usr/bin; do
+      if [ -x "${d}/java" ]; then
+        PATH="${PATH}:${d}"
+        return 0
+      fi
+    done
+    return 1
+  fi
+}
+
+if ! fixJavaPath; then
+  log "ERROR: could not locate path that contains java"
   exit 1
 fi
 
@@ -94,7 +121,9 @@ case "X$VERSION" in
   ;;
 esac
 export VANILLA_VERSION
-log "Resolved version given ${VERSION} into ${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}"
 
 cd /data || exit 1
 
@@ -108,6 +137,18 @@ if isTrue "${ENABLE_AUTOSTOP}"; then
   ${SCRIPTS:-/}start-autostop
 fi
 
+if 
+  [[ "$RCON_CMDS_STARTUP" ]] ||
+  [[ "$RCON_CMDS_ON_CONNECT" ]] ||
+  [[ "$RCON_CMDS_ON_DISCONNECT" ]] || 
+  [[ "$RCON_CMDS_FIRST_CONNECT" ]] || 
+  [[ "$RCON_CMDS_LAST_DISCONNECT" ]]
+then
+  log "Starting RCON commands"
+  # shellcheck source=start-rconcmds
+  ${SCRIPTS:-/}start-rconcmds
+fi
+
 if versionLessThan 1.7; then
   echo "
 MC_HEALTH_EXTRA_ARGS=(

scripts/start-deployForge

@@ -99,7 +99,7 @@ resolve_versions() {
     log "Checking Forge version information."
     case $FORGEVERSION in
       LATEST)
-        if ! FORGE_VERSION=$(get --json-path ".promos['$VANILLA_VERSION-latest']" "$promosUrl"); then
+        if ! FORGE_VERSION=$(get --json-path ".promos['$VANILLA_VERSION-latest']" --json-value-when-missing "" "$promosUrl"); then
           log "ERROR: Version $VANILLA_VERSION is not supported by Forge"
           log "       Refer to http://files.minecraftforge.net/ for supported versions"
           exit 2
@@ -107,8 +107,8 @@ resolve_versions() {
         ;;
 
       RECOMMENDED)
-        if ! FORGE_VERSION=$(get -s --json-path ".promos['$VANILLA_VERSION-recommended']" "$promosUrl"); then
-          if ! FORGE_VERSION=$(get --json-path ".promos['$VANILLA_VERSION-latest']" "$promosUrl"); then
+        if ! FORGE_VERSION=$(get -s --json-path ".promos['$VANILLA_VERSION-recommended']" --json-value-when-missing "" "$promosUrl"); then
+          if ! FORGE_VERSION=$(get --json-path ".promos['$VANILLA_VERSION-latest']" --json-value-when-missing "" "$promosUrl"); then
             log "ERROR: Version $VANILLA_VERSION is not supported by Forge"
             log "       Refer to http://files.minecraftforge.net/ for supported versions"
             exit 2

scripts/start-deployPufferfish

@@ -1,39 +1,40 @@
 #!/bin/bash
 
-. ${SCRIPTS:-/}start-utils
+# shellcheck source=start-utils
+. "${SCRIPTS:-/}start-utils"
+
 set -euo pipefail
 isDebugging && set -x
 
 IFS=$'\n\t'
 
-if [ "${VERSION}" != "LATEST" ] && [ "${VERSION}" != "1.18" ] ; then
-  log "ERROR: Pufferfish server type only supports VERSION=LATEST, VERSION=1.18. Note that these are branches, not #.#.# versions."
+if [[ "${MAJOR_VANILLA_VERSION}" != "1.18" ]] && [[ "${MAJOR_VANILLA_VERSION}" != "1.17" ]]; then
+  log "ERROR: Pufferfish server type only supports versions 1.18 or 1.17, use PUFFERFISH_BUILD to select the the correct build 47 => 1.18.1, 50 => 1.18.2 etc"
   exit 1
 fi
 
-: ${PUFFERFISH_BUILD:=lastSuccessfulBuild}
+: "${PUFFERFISH_BUILD:=lastSuccessfulBuild}"
 
-if  [ "${VERSION}" = "LATEST" ] || [ "${VERSION}" = "1.18" ]; then
-  PUFFERFISH_BRANCH="1.18"
-  PUFFERFISH_VERSION="1.18.1-R0.1"
-fi
+PUFFERFISH_BUILD_JSON=$(curl -X GET -s "https://ci.pufferfish.host/job/Pufferfish-${MAJOR_VANILLA_VERSION}/${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",
+PUFFERFISH_BUILD_FILENAME=$(jq -n "$PUFFERFISH_BUILD_JSON" | jq -jc '.artifacts[].fileName // empty' )
+PUFFERFISH_BUILD_DOWNLOAD_URL="${PUFFERFISH_BUILD_URL}artifact/build/libs/${PUFFERFISH_BUILD_FILENAME}"
 
-log "Using Pufferfish-${PUFFERFISH_BRANCH} branch"
-
-export SERVER=pufferfish-${PUFFERFISH_BRANCH}-${PUFFERFISH_BUILD}.jar
+# Setting server to the Jar filename for export.
+export SERVER=$PUFFERFISH_BUILD_FILENAME
 
 log "Removing old Pufferfish versions ..."
 shopt -s nullglob
 for f in pufferfish-*.jar; do
-  [[ $f != $SERVER ]] && rm $f
+  [[ $f != "$SERVER" ]] && rm "$f"
 done
 
-if [ ! -f "$SERVER" ] || isTrue "${FORCE_REDOWNLOAD:-false}"; then
-    artifact="build/libs/pufferfish-paperclip-${PUFFERFISH_VERSION}-SNAPSHOT-reobf.jar"
-    downloadUrl="https://ci.pufferfish.host/job/Pufferfish-${PUFFERFISH_BRANCH}/${PUFFERFISH_BUILD}/artifact/${artifact}"
-    log "Downloading Pufferfish from $downloadUrl ..."
-    if ! get -o "$SERVER" "$downloadUrl"; then
-      log "ERROR: failed to download from $downloadUrl (status=$?)"
+if [[ ! -f "$SERVER" ]] || isTrue "${FORCE_REDOWNLOAD:-false}"; then
+    log "Downloading Pufferfish from $PUFFERFISH_BUILD_DOWNLOAD_URL ..."
+    if ! get -o "$SERVER" "$PUFFERFISH_BUILD_DOWNLOAD_URL"; then
+      log "ERROR: failed to download from $PUFFERFISH_BUILD_DOWNLOAD_URL (status=$?)"
       exit 3
     fi
 fi
@@ -41,4 +42,4 @@ fi
 # Normalize on Spigot for later operations
 export FAMILY=SPIGOT
 
-exec ${SCRIPTS:-/}start-spiget "$@"
+exec "${SCRIPTS:-/}start-spiget" "$@"

scripts/start-deploySpongeVanilla

@@ -24,12 +24,14 @@ esac
 if [ -z $SPONGEVERSION ]; then
   log "Choosing Version for Sponge"
   if [ "$SPONGEBRANCH" == "stable" ]; then
-    export 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
-    export 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
 export SERVER="spongevanilla-$SPONGEVERSION.jar"
 
 if [ ! -e $SERVER ] || [ -n "$FORCE_REDOWNLOAD" ]; then

scripts/start-deployVanilla

@@ -8,27 +8,25 @@ set -o pipefail
 export SERVER="minecraft_server.${VANILLA_VERSION// /_}.jar"
 
 if [ ! -e "$SERVER" ] || [ -n "$FORCE_REDOWNLOAD" ]; then
-  log "Downloading $SERVER ..."
+  log "Locating download for $SERVER ..."
   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')
   result=$?
   if [ $result != 0 ]; then
-    log "ERROR failed to obtain version manifest URL ($result)"
+    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 $VANILLA_VERSION"
     exit 1
   fi
   debug "Found version manifest at $versionManifestUrl"
 
-  serverDownloadUrl=$(get --json-path '$.downloads.server.url' "${versionManifestUrl}")
-  result=$?
-  if [ $result != 0 ]; then
-    log "ERROR failed to obtain version manifest from $versionManifestUrl ($result)"
+  if ! serverDownloadUrl=$(get --json-path '$.downloads.server.url' "${versionManifestUrl}"); then
+    log "ERROR: failed to obtain version manifest from $versionManifestUrl ($result)"
     exit 1
   elif [ "$serverDownloadUrl" = "null" ]; then
-    log "ERROR version $VANILLA_VERSION does not provide a server download"
+    log "ERROR: there is not a server download for version $VANILLA_VERSION"
     exit 1
   fi
 
@@ -36,7 +34,7 @@ if [ ! -e "$SERVER" ] || [ -n "$FORCE_REDOWNLOAD" ]; then
   get -o "$SERVER" "$serverDownloadUrl"
   result=$?
   if [ $result != 0 ]; then
-    log "ERROR failed to download server from $serverDownloadUrl ($result)"
+    log "ERROR: failed to download server from $serverDownloadUrl ($result)"
     exit 1
   fi
 fi

scripts/start-finalExec

@@ -5,16 +5,35 @@
 isDebugging && set -x
 
 if [ -n "$ICON" ]; then
-    if [ ! -e server-icon.png ] || [ "${OVERRIDE_ICON}" == "TRUE" ]; then
+    if [ ! -e server-icon.png ] || isTrue "${OVERRIDE_ICON}"; then
       log "Using server icon from $ICON..."
-      # Not sure what it is yet...call it "img"
-      curl -sSL -o /tmp/icon.img $ICON
-      specs=$(identify /tmp/icon.img | awk '{print $2,$3}')
-      if [ "$specs" = "PNG 64x64" ]; then
-        mv /tmp/icon.img /data/server-icon.png
+      if isURL "$ICON"; then
+        # Not sure what it is yet...call it "img"
+        if ! get -o /tmp/icon.img "$ICON"; then
+          log "ERROR: failed to download icon from $ICON"
+          exit 1
+        fi
+        ICON=/tmp/icon.img
+        iconSrc="url"
+      elif [ -f "$ICON" ]; then
+        iconSrc="file"
+      else
+        log "ERROR: $ICON does not appear to be a URL or existing file"
+        exit 1
+      fi
+      read -r -a specs < <(identify "$ICON" | awk 'NR == 1 { print $2, $3 }')
+      if [ "${specs[0]} ${specs[1]}" = "PNG 64x64" ]; then
+        if [ $iconSrc = url ]; then
+          mv -f /tmp/icon.img /data/server-icon.png
+        else
+          cp -f "$ICON" /data/server-icon.png
+        fi
+      elif [ "${specs[0]}" = GIF ]; then
+        log "Converting GIF image to 64x64 PNG..."
+        convert "$ICON"[0] -resize 64x64! /data/server-icon.png
       else
         log "Converting image to 64x64 PNG..."
-        convert /tmp/icon.img -resize 64x64! /data/server-icon.png
+        convert "$ICON" -resize 64x64! /data/server-icon.png
       fi
     fi
 fi
@@ -91,6 +110,7 @@ if [[ ${GUI,,} = false ]]; then
   EXTRA_ARGS+=" nogui"
 fi
 
+: "${MEMORY:=1G}"
 : "${INIT_MEMORY:=${MEMORY}}"
 : "${MAX_MEMORY:=${MEMORY}}"
 

scripts/start-rconcmds

@@ -0,0 +1,36 @@
+#!/bin/bash
+
+# shellcheck source=start-utils
+. "${SCRIPTS:-/}start-utils"
+
+: "${RCON_CMDS_STARTUP:=}"
+: "${RCON_CMDS_ON_CONNECT:=}"
+: "${RCON_CMDS_ON_DISCONNECT:=}"
+: "${RCON_CMDS_FIRST_CONNECT:=}"
+: "${RCON_CMDS_LAST_DISCONNECT:=}"
+: "${RCON_CMDS_PERIOD:=10}"
+: "${SERVER_PORT:=25565}"
+export RCON_CMDS_STARTUP
+export RCON_CMDS_ON_CONNECT
+export RCON_CMDS_ON_DISCONNECT
+export RCON_CMDS_FIRST_CONNECT
+export RCON_CMDS_LAST_DISCONNECT
+export RCON_CMDS_PERIOD
+export SERVER_PORT
+
+log "Rcon cmds functionality enabled"
+
+isDebugging && set -x
+
+if ! [[ $RCON_CMDS_PERIOD =~ ^[0-9]+$ ]]; then
+  RCON_CMDS_PERIOD=10
+  export RCON_CMDS_PERIOD
+  log "Warning: RCON_CMDS_PERIOD is not numeric, set to 10 (seconds)"
+fi
+if [ "$RCON_CMDS_PERIOD" -eq "0" ] ; then
+  RCON_CMDS_PERIOD=10
+  export RCON_CMDS_PERIOD
+  log "Warning: RCON_CMDS_PERIOD must not be 0, set to 10 (seconds)"
+fi
+
+/rconcmds/rcon-cmds-daemon.sh &

scripts/start-setupForgeApiMods

@@ -17,6 +17,7 @@ FORGEAPI_BASE_URL=${FORGEAPI_BASE_URL:-https://api.curseforge.com/v1}
 RELEASE_NUMBER_FILTER=1
 MINECRAFT_GAME_ID=432
 FILTER_BY_FAMILY=false
+DOWNLOADED_MODIDS=()
 out_dir=/data/mods
 
 # shellcheck source=start-utils
@@ -24,8 +25,8 @@ out_dir=/data/mods
 isDebugging && set -x
 
 # Remove old mods/plugins
-if isTrue "${REMOVE_OLD_FORGEAPI_MODS}" && [ -z "${MODS_FORGEAPI_KEY}" ]; then
-  removeOldMods /data/mods
+if isTrue "${REMOVE_OLD_FORGEAPI_MODS}"; then
+  removeOldMods "/data/mods"
 fi
 
 # Family filter is on by default for Forge, Fabric, and Bukkit
@@ -56,7 +57,7 @@ updateReleaseNumber(){
 }
 
 retrieveVersionTypeNumber(){
-  VERSION_NAME="Minecraft ${VANILLA_VERSION%.*}"
+  VERSION_NAME="Minecraft ${MAJOR_VANILLA_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}'')
@@ -76,7 +77,7 @@ retrieveVersionTypeNumber(){
 }
 
 modFileByProjectID(){
-  project_id=$(echo $1 | tr -d '"')
+  project_id=$(echo "$1" | tr -d '"')
   project_id_release_type=$2
   project_id_file_name=$3
   unset PROJECT_FILE
@@ -104,8 +105,8 @@ modFileByProjectID(){
     total_count=$(jq -n "$project_files" | jq -c '.pagination.totalCount' )
 
     # Checking for a individual release type input, if not use global
-    if [ $project_id_release_type ]; then
-      updateReleaseNumber $project_id_release_type
+    if [ "$project_id_release_type" ]; then
+      updateReleaseNumber "$project_id_release_type"
       unset project_id_release_type 
     else
       updateReleaseNumber $MODS_FORGEAPI_RELEASES
@@ -113,38 +114,38 @@ modFileByProjectID(){
 
     # grabs the highest ID of the releaseTypes selected.
     # Default is 1 for Release, Beta is 2, and Alpha is 3. Using less than we can validate highest release.
-    if [ $project_id_file_name ]; then
+    if [ "$project_id_file_name" ]; then
       # Looks for file by name
       current_project_file=$(jq -n "$project_files" | jq --arg FILE_NAME "$project_id_file_name" -jc '
         .data | map(select(.fileName<=($FILE_NAME))) | .[0] // empty')
     elif $( ! isTrue "$MODS_FORGEAPI_IGNORE_GAMETYPE" ) && $FILTER_BY_FAMILY ; then
       # Looks for file by version and server type in lowercase
-      current_project_file=$(jq -n "$project_files" | jq --arg RELEASE_FILTER "$RELEASE_NUMBER_FILTER" --arg GAME_TYPE ${FAMILY,,} -jc '
-        .data | sort_by(.id) | reverse | map(select(.gameVersions[] | ascii_downcase | contains ($GAME_TYPE))) | map(select(.releaseType<=($RELEASE_FILTER|tonumber))) | .[0] // empty')
+      current_project_file=$(jq -n "$project_files" | jq --arg RELEASE_FILTER "$RELEASE_NUMBER_FILTER" --arg GAME_TYPE "${FAMILY,,}" --arg VERSION "$VANILLA_VERSION" -jc '
+        .data | sort_by(.id) | reverse | map(select(.gameVersions[] | ascii_downcase | contains ($GAME_TYPE))) |  map(select(.gameVersions[] | contains ($VERSION))) | map(select(.releaseType<=($RELEASE_FILTER|tonumber))) | .[0] // empty')
     else
       # Looks for file by version only.
-      current_project_file=$(jq -n "$project_files" | jq --arg RELEASE_FILTER "$RELEASE_NUMBER_FILTER" -jc '
-        .data | sort_by(.id) | reverse | map(select(.releaseType<=($RELEASE_FILTER|tonumber))) | .[0] // empty')
+      current_project_file=$(jq -n "$project_files" | jq --arg RELEASE_FILTER "$RELEASE_NUMBER_FILTER" --arg VERSION "$VANILLA_VERSION" -jc '
+        .data | sort_by(.id) | reverse | map(select(.gameVersions[] | contains ($VERSION))) | map(select(.releaseType<=($RELEASE_FILTER|tonumber))) | .[0] // empty')
     fi
 
     # Logic to grab the latest release over the entire pagination
     if [ ! "$PROJECT_FILE" ]; then
       PROJECT_FILE=$current_project_file
     elif [ "$current_project_file" ]; then
-      current_project_file_id=$(jq -n "$current_project_file" | jq -jc '.id' )
-      PROJECT_FILE_ID=$(jq -n "$PROJECT_FILE" | jq -jc '.id' )
+      current_project_file_id=$(jq -n "$current_project_file" | jq -jc '.id // empty' )
+      PROJECT_FILE_ID=$(jq -n "$PROJECT_FILE" | jq -jc '.id // empty' )
       if (( current_project_file_id > PROJECT_FILE_ID )); then
         PROJECT_FILE=$current_project_file
       fi
     fi
     
     # check to see if we have gone to far or lost our index and exit with an error
-    if [ -z "$index" ] || [ -z "$total_count" ] || [ $index -ge $total_count ]; then
+    if [ -z "$index" ] || [ -z "$total_count" ] || [ $index -ge "$total_count" ]; then
       log "ERROR: Unable to retrieve any files for ${project_id} from ForgeAPI also Validate files have release type associated with no. ${RELEASE_NUMBER_FILTER}"
       exit 2
     fi
     # Increment start index to new set.
-    index=$(($index + $pageSize))
+    index=$((index + pageSize))
   done
   if [ ! "$PROJECT_FILE" ]; then
     log "ERROR: Unable to retrieve any files for ${project_id}, Release Type: ${RELEASE_NUMBER_FILTER}, FAMILY_TYPE: ${FAMILY,,}"
@@ -157,17 +158,22 @@ downloadModPackfromModFile() {
     log "ERROR: Project File not found from the ForgeAPI"
     exit 2
   fi
-
-  # grabs needed values from our json return
-  file_name=$(jq -n "$PROJECT_FILE" | jq -jc '.fileName' )
-  download_url=$(jq -n "$PROJECT_FILE" | jq -jc '.downloadUrl' )
-  
   # trys to make the output directory incase it doesnt exist.
   mkdir -p "$out_dir"
-  echo "Downloading ${download_url}"
-  if ! get --skip-up-to-date -o "${out_dir}/${file_name}" $download_url ; then
-    log "ERROR: failed to download from ${download_url}"
-    exit 2
+
+  # grabs needed values from our json return
+  file_name=$(jq -n "$PROJECT_FILE" | jq -jc '.fileName // empty' )
+  download_url=$(jq -n "$PROJECT_FILE" | jq -jc '.downloadUrl // empty' )
+  mod_id=$(jq -n "$PROJECT_FILE" | jq -jc '.modId // empty' )
+
+  if [ ! -f "${out_dir}/${file_name}" ]; then
+    echo "Downloading ${download_url}"
+    # Track the mods we have downloaded.
+    DOWNLOADED_MODIDS+=("${mod_id}")
+    if ! get --skip-up-to-date -o "${out_dir}/${file_name}" "${download_url}"; then
+      log "ERROR: failed to download from ${download_url}"
+      exit 2
+    fi
   fi
 }
 
@@ -177,30 +183,15 @@ downloadDependencies(){
     required_dependencies=$(jq -n "$dependencies" | jq --arg REQUIRED_FILTER "3" -jc '
       map(select(.relationType==($REQUIRED_FILTER|tonumber)))')
     if [ "$required_dependencies" ]; then
-      jq -n "$required_dependencies" | jq -c '.[]?' | while read current_dependency; do
+      while read -r current_dependency; do
         mod_id=$(jq -n "$current_dependency" | jq -jc '.modId' )
-
-        # BROKEN: Example Voice mod keeps returning the voice mod file id instead of the mod file id.
-        # file_id=$(jq -n "$current_dependency" | jq -jc '.fileId' )
-        # dependency_data=$(curl -X GET -s \
-        #   "${FORGEAPI_BASE_URL}/mods/${mod_id}/files/${file_id}/download-url" \
-        #   -H 'Accept: application/json' -H 'x-api-key: '${MODS_FORGEAPI_KEY}'')  
-        # if [ ! "$dependency_data" ]; then
-        #   log "ERROR: unable to retrieve dependency data files for ${project_id} from ForgeAPI"
-        #   exit 2
-        # fi
-        # dependency_download_url=$(jq -n "$dependency_data" | jq -jc '.data' )
-        # echo "Downloading dependency ${dependency_download_url}"
-        # if ! get -o "${out_dir}/" $dependency_download_url ; then 
-        #   log "ERROR: failed to download dependency from ${dependency_download_url}"
-        #   exit 2
-        # fi
-
-        # Using current mod path and release to go get the REQUIRED DEPENDENCY
-        # NOTE: we are ASUMING it will be release.
-        modFileByProjectID $mod_id "release"
-        downloadModPackfromModFile
-      done
+        # Validate we have not tried to download the mod yet.
+        if [[ ! "${DOWNLOADED_MODIDS[*]}" =~ $mod_id ]]; then
+          modFileByProjectID "$mod_id" "release"
+          downloadModPackfromModFile
+        fi
+      # needs to be piped in to keep look in main process
+      done < <(jq -n "$required_dependencies" | jq -c '.[]?')
     fi
   fi
 }
@@ -215,18 +206,22 @@ if [ "$MODS_FORGEAPI_FILE" ] && [ -z "$MODS_FORGEAPI_PROJECTIDS" ]; then
   fi
 
   # Needs loop here to look up release types befor calling download.
-  jq -c '.[]?' $MODS_FORGEAPI_FILE | while read current_project; do
+  while read -r current_project; do
     # Per stack overflow we can use //empty to return empty string that works with -z
     project_id=$(jq -n "$current_project" | jq -r '.projectId // empty' )
     current_release_type=$(jq -n "$current_project" | jq -r '.releaseType // empty' )
     current_file_name=$(jq -n "$current_project" | jq -r '.fileName // empty' )
 
-    modFileByProjectID $project_id $current_release_type $current_file_name
-    downloadModPackfromModFile
-    if isTrue "${MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES}"; then
-      downloadDependencies
+    # Validate we have not tried to download the mod yet.
+    if [[ ! "${DOWNLOADED_MODIDS[*]}" =~ $project_id ]]; then
+      modFileByProjectID "$project_id" "$current_release_type" "$current_file_name"
+      downloadModPackfromModFile
+      if isTrue "${MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES}"; then
+        downloadDependencies
+      fi
     fi
-  done
+  # needs to be piped in to keep look in main process
+  done < <(jq -c '.[]?' $MODS_FORGEAPI_FILE)
 fi
 
 # Use only project ids and global release data.
@@ -234,10 +229,13 @@ if [ "$MODS_FORGEAPI_PROJECTIDS" ] && [ -z "$MODS_FORGEAPI_FILE" ]; then
   ensureModKey
   updateFamilyFilter
   for project_id in ${MODS_FORGEAPI_PROJECTIDS//,/ }; do
-    modFileByProjectID $project_id 
-    downloadModPackfromModFile
-    if isTrue "${MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES}"; then
-      downloadDependencies
+    # Validate we have not tried to download the mod yet.
+    if [[ ! "${DOWNLOADED_MODIDS[*]}" =~ $project_id ]]; then
+      modFileByProjectID $project_id 
+      downloadModPackfromModFile
+      if isTrue "${MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES}"; then
+        downloadDependencies
+      fi
     fi
   done
 fi

scripts/start-setupServerProperties

@@ -4,6 +4,7 @@
 . "${SCRIPTS:-/}start-utils"
 
 : "${SERVER_PROPERTIES:=/data/server.properties}"
+: "${ENABLE_RCON:=true}"
 
 # FUNCTIONS
 function setServerPropValue {

scripts/start-spiget

@@ -2,11 +2,14 @@
 set -euo pipefail
 IFS=$'\n\t'
 
-. ${SCRIPTS:-/}start-utils
+# shellcheck source=start-utils
+. "${SCRIPTS:-/}start-utils"
 handleDebugMode
 
-: ${SPIGET_RESOURCES:=}
-: ${SPIGET_DOWNLOAD_TOLERANCE:=5} # in minutes
+: "${SPIGET_RESOURCES:=}"
+: "${SPIGET_DOWNLOAD_TOLERANCE:=5}" # in minutes
+
+acceptArgs=(--accept application/zip --accept application/java-archive --accept application/octet-stream)
 
 containsJars() {
   file=${1?}
@@ -17,7 +20,7 @@ containsJars() {
     if [[ $line =~ $pat ]]; then
       return 0
     fi
-  done <<<$(unzip -l "$file")
+  done < <(unzip -l "$file" | tail -n +4)
 
   return 1
 }
@@ -31,7 +34,7 @@ containsPlugin() {
     if [[ $line =~ $pat ]]; then
       return 0
     fi
-  done <<<$(unzip -l "$file")
+  done < <(unzip -l "$file" | tail -n +4)
 
   return 1
 }
@@ -49,7 +52,7 @@ getResourceFromSpiget() {
   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
+      if ! get -o "${versionfileNew}" "${urlVersion}"; then
         log "ERROR failed to download resource version meta data '${resource}' from ${urlVersion}"
         exit 2
       fi
@@ -71,7 +74,7 @@ getResourceFromSpiget() {
   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
+      if ! get -o "${versionfileNew}" "${urlVersion}"; then
         log "ERROR failed to download resource version meta data '${resource}' from ${urlVersion}"
         exit 2
       fi
@@ -84,29 +87,35 @@ getResourceFromSpiget() {
 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
-    log "ERROR failed to download resource '${resource}' from ${url}"
-    exit 2
+  resourceUrl="https://api.spiget.org/v2/resources/${resource}"
+  if ! outfile=$(get_silent --output-filename -o /tmp "${acceptArgs[@]}" "${resourceUrl}/download"); then
+    log "ERROR: failed to download resource '${resource}' from ${resourceUrl}/download"
+    if externalUrl=$(get --json-path '$.file.externalUrl' "${resourceUrl}"); then
+      log "       Visit $externalUrl to pre-download the resource"
+      log "       instead of using SPIGET_RESOURCES"
+    fi
+    exit 1
   fi
 
-  if containsJars "${tmpfile}"; then
-    log "Extracting contents of resource ${resource} into plugins"
-    unzip -o -q -d /data/plugins "${tmpfile}"
-    rm "${tmpfile}"
-  elif containsPlugin "${tmpfile}"; then
+  if ! fileType=$(get --json-path '.file.type' "${resourceUrl}"); then
+    log "ERROR: failed to retrieve file type of resource $resource"
+    exit 1
+  fi
+  if containsPlugin "${outfile}"; then
     log "Moving resource ${resource} into plugins"
-    mv "${tmpfile}" "/data/plugins/${resource}.jar"
+    mv "$outfile" /data/plugins
+  elif containsJars "${outfile}"; then
+    log "Extracting contents of resource ${resource} into plugins"
+    extract "$outfile" /data/plugins
+    rm "$outfile"
   else
-    log "ERROR downloaded resource '${resource}' seems to be not a valid plugin"
+    log "ERROR: file for resource ${resource} has an unexpected file type: ${fileType}"
     exit 2
   fi
-
 }
 
 if [[ ${SPIGET_RESOURCES} ]]; then
-  if isTrue ${REMOVE_OLD_MODS:-false}; then
+  if isTrue "${REMOVE_OLD_MODS:-false}"; then
     removeOldMods /data/plugins
     REMOVE_OLD_MODS=false
   fi
@@ -118,4 +127,4 @@ if [[ ${SPIGET_RESOURCES} ]]; then
   done
 fi
 
-exec ${SCRIPTS:-/}start-setupWorld $@
+exec "${SCRIPTS:-/}start-setupWorld" "$@"

scripts/start-utils

@@ -8,6 +8,11 @@ function join_by() {
   printf "%s" "${@/#/$d}"
 }
 
+function get_major_version() {
+  version=$1
+  echo "$version" | cut -d. -f 1-2
+}
+
 function isURL() {
   local value=$1
 
@@ -117,6 +122,10 @@ function logAutostopAction() {
   echo "[$(date -Iseconds)] [Autostop] $*"
 }
 
+function logRcon() {
+  echo "[Rcon loop] $*"
+}
+
 function normalizeMemSize() {
   local scale=1
   case ${1,,} in
@@ -188,6 +197,14 @@ function get() {
   mc-image-helper "${flags[@]}" get "$@"
 }
 
+function get_silent() {
+  local flags=(-s)
+  if isTrue "${DEBUG_GET:-false}"; then
+    flags+=("--debug")
+  fi
+  mc-image-helper "${flags[@]}" get "$@"
+}
+
 function isFamily() {
   for f in "${@}"; do
     if [[ ${FAMILY^^} == "${f^^}" ]]; then
@@ -225,7 +242,7 @@ function extract() {
   type=$(file -b --mime-type "${src}")
   case "${type}" in
     application/zip)
-      unzip -q -d "${destDir}" "${src}"
+      unzip -o -q -d "${destDir}" "${src}"
       ;;
     application/x-tar|application/gzip|application/x-gzip|application/x-bzip2|application/zstd|application/x-zstd)
       tar -C "${destDir}" -xf "${src}"

tests/setuponlytests/curseforge/docker-compose.yml

@@ -0,0 +1,16 @@
+version: "3"
+
+services:
+  mc:
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server:java8-multiarch}
+    environment:
+      EULA: "true"
+      SETUP_ONLY: "TRUE"
+      TYPE: CURSEFORGE
+      CF_SERVER_MOD: /modpacks/pack.zip
+      INIT_MEMORY: 2G
+      MAX_MEMORY: 6G
+    volumes:
+      - ./data:/data
+      - ./modpacks:/modpacks:ro
+

tests/setuponlytests/curseforge/require.sh

@@ -0,0 +1 @@
+[[ $VARIANT == java8* ]] || exit 1

tests/setuponlytests/curseforge/verify.sh

@@ -0,0 +1,2 @@
+mc-image-helper assert fileExists "/data/FeedTheBeast/forge-installer.jar"
+mc-image-helper assert fileExists "/data/FeedTheBeast/forge.jar"

tests/setuponlytests/defaults/docker-compose.yml

@@ -0,0 +1,11 @@
+version: "3"
+
+services:
+  mc:
+    restart: "no"
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "TRUE"
+      SETUP_ONLY: "TRUE"
+    volumes:
+      - ./data:/data

tests/setuponlytests/defaults/verify.sh

@@ -0,0 +1,3 @@
+mc-image-helper assert propertyEquals --file=server.properties --property=rcon.password --expect=minecraft
+mc-image-helper assert propertyEquals --file=server.properties --property=rcon.port --expect=25575
+mc-image-helper assert propertyEquals --file=server.properties --property=enable-rcon --expect=true

tests/setuponlytests/forgeapimods_file/require.sh

@@ -1 +1,2 @@
-[[ $MODS_FORGEAPI_KEY ]] || exit 1
+[[ $MINECRAFT_VERSION == LATEST ]] || exit 1
+[[ $MODS_FORGEAPI_KEY ]] || exit 1

tests/setuponlytests/forgeapimods_gametype/require.sh

@@ -1 +1,2 @@
-[[ $MODS_FORGEAPI_KEY ]] || exit 1
+[[ $MINECRAFT_VERSION == LATEST ]] || exit 1
+[[ $MODS_FORGEAPI_KEY ]] || exit 1

tests/setuponlytests/forgeapimods_projectids/docker-compose.yml

@@ -16,7 +16,7 @@ services:
       VERSION: ${MINECRAFT_VERSION:-LATEST}
       MODS_FORGEAPI_DOWNLOAD_DEPENDENCIES: "TRUE"
       # Contains mix of Forge and Fabric mods
-      MODS_FORGEAPI_PROJECTIDS: 306612,416089,220318
+      MODS_FORGEAPI_PROJECTIDS: 416089,419697
       # Allows for Beta releases of 416089 the Fabric Voice Mod 
       MODS_FORGEAPI_RELEASES: BETA
       MODS_FORGEAPI_KEY: ${MODS_FORGEAPI_KEY}

tests/setuponlytests/forgeapimods_projectids/require.sh

@@ -1 +1,2 @@
-[[ $MODS_FORGEAPI_KEY ]] || exit 1
+[[ $MINECRAFT_VERSION == LATEST ]] || exit 1
+[[ $MODS_FORGEAPI_KEY ]] || exit 1

tests/setuponlytests/forgeapimods_projectids/verify.sh

@@ -1,4 +1,6 @@
-mc-image-helper assert fileExists "/data/mods/BiomesOPlenty*"
-mc-image-helper assert fileExists "/data/mods/TerraBlender*"
-mc-image-helper assert fileExists "/data/mods/voicechat-fabric*"
+# No family filter applied, DO NOT use Fabric or Forge specific name validation as it may cause random breakage.
+mc-image-helper assert fileExists "/data/mods/voicechat-fabric-1*"
+# Should be pull v4 and higher for 1.18.2:
+mc-image-helper assert fileExists "/data/mods/architectury-4*"
 mc-image-helper assert fileExists "/data/mods/fabric-api*"
+

tests/setuponlytests/icon-file-exact/docker-compose.yml

@@ -0,0 +1,17 @@
+version: "3"
+
+services:
+  mc:
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "true"
+      SETUP_ONLY: "true"
+      ICON: /extra/4737386_minecraft_squircle_icon_64x64.png
+      # the following are only used to speed up test execution
+      TYPE: CUSTOM
+      CUSTOM_SERVER: /servers/fake.jar
+      VERSION: 1.18.1
+    volumes:
+      - ./data:/data
+      - ./extra:/extra
+      - ./fake.jar:/servers/fake.jar

tests/setuponlytests/icon-file-exact/verify.sh

@@ -0,0 +1 @@
+mc-image-helper assert fileExists server-icon.png

tests/setuponlytests/icon-file-scale/docker-compose.yml

@@ -0,0 +1,17 @@
+version: "3"
+
+services:
+  mc:
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "true"
+      SETUP_ONLY: "true"
+      ICON: /extra/4737386_minecraft_squircle_icon.png
+      # the following are only used to speed up test execution
+      TYPE: CUSTOM
+      CUSTOM_SERVER: /servers/fake.jar
+      VERSION: 1.18.1
+    volumes:
+      - ./data:/data
+      - ./extra:/extra
+      - ./fake.jar:/servers/fake.jar

tests/setuponlytests/icon-file-scale/verify.sh

@@ -0,0 +1 @@
+mc-image-helper assert fileExists server-icon.png

tests/setuponlytests/icon-gif-multiframe/docker-compose.yml

@@ -0,0 +1,22 @@
+version: "3"
+
+services:
+  web:
+    image: nginx
+    volumes:
+      - ./web:/usr/share/nginx/html
+  mc:
+    depends_on:
+      - web
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "true"
+      SETUP_ONLY: "true"
+      ICON: http://web/motion-tween-example.gif
+      # the following are only used to speed up test execution
+      TYPE: CUSTOM
+      CUSTOM_SERVER: /servers/fake.jar
+      VERSION: 1.18.1
+    volumes:
+      - ./data:/data
+      - ./fake.jar:/servers/fake.jar

tests/setuponlytests/icon-gif-multiframe/verify.sh

@@ -0,0 +1 @@
+mc-image-helper assert fileExists server-icon.png

tests/setuponlytests/icon-png-atscale/docker-compose.yml

@@ -0,0 +1,22 @@
+version: "3"
+
+services:
+  web:
+    image: nginx
+    volumes:
+      - ./web:/usr/share/nginx/html
+  mc:
+    depends_on:
+      - web
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "true"
+      SETUP_ONLY: "true"
+      ICON: http://web/4737386_minecraft_squircle_icon.png
+      # the following are only used to speed up test execution
+      TYPE: CUSTOM
+      CUSTOM_SERVER: /servers/fake.jar
+      VERSION: 1.18.1
+    volumes:
+      - ./data:/data
+      - ./fake.jar:/servers/fake.jar

tests/setuponlytests/icon-png-atscale/verify.sh

@@ -0,0 +1 @@
+mc-image-helper assert fileExists server-icon.png

tests/setuponlytests/icon-png-scale/docker-compose.yml

@@ -0,0 +1,22 @@
+version: "3"
+
+services:
+  web:
+    image: nginx
+    volumes:
+      - ./web:/usr/share/nginx/html
+  mc:
+    depends_on:
+      - web
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "true"
+      SETUP_ONLY: "true"
+      ICON: http://web/4737386_minecraft_squircle_icon.png
+      # the following are only used to speed up test execution
+      TYPE: CUSTOM
+      CUSTOM_SERVER: /servers/fake.jar
+      VERSION: 1.18.1
+    volumes:
+      - ./data:/data
+      - ./fake.jar:/servers/fake.jar

tests/setuponlytests/icon-png-scale/verify.sh

@@ -0,0 +1 @@
+mc-image-helper assert fileExists server-icon.png

tests/setuponlytests/pufferfish/docker-compose.yml

@@ -0,0 +1,13 @@
+version: "3"
+
+services:
+  mc:
+    restart: "no"
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "TRUE"
+      SETUP_ONLY: "TRUE"
+      TYPE: PUFFERFISH
+      VERSION: ${MINECRAFT_VERSION:-LATEST}
+    volumes:
+      - ./data:/data

tests/setuponlytests/pufferfish/require.sh

@@ -0,0 +1 @@
+[[ $MINECRAFT_VERSION == LATEST ]] || exit 1

tests/setuponlytests/pufferfish/verify.sh

@@ -0,0 +1 @@
+mc-image-helper assert fileExists "/data/pufferfish-*.jar"

tests/setuponlytests/spiget/docker-compose.yml

@@ -0,0 +1,13 @@
+version: "3"
+
+services:
+  mc:
+    restart: "no"
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "TRUE"
+      SETUP_ONLY: "TRUE"
+      TYPE: PAPER
+      SPIGET_RESOURCES: "34315,3836,6245,2124,88135"
+    volumes:
+      - ./data:/data

tests/setuponlytests/spiget/verify.sh

@@ -0,0 +1,5 @@
+mc-image-helper assert fileExists plugins/3836.jar
+mc-image-helper assert fileExists plugins/34315.jar
+mc-image-helper assert fileExists plugins/6245.jar
+mc-image-helper assert fileExists plugins/88135.jar
+mc-image-helper assert fileExists plugins/SkinsRestorer.jar

tests/setuponlytests/spongevanilla_version_compare/docker-compose.yml

@@ -0,0 +1,15 @@
+version: "3"
+
+services:
+  mc:
+    restart: "no"
+    image: ${IMAGE_TO_TEST:-itzg/minecraft-server}
+    environment:
+      EULA: "TRUE"
+      SETUP_ONLY: "TRUE"
+      TYPE: "SPONGEVANILLA"
+      SPONGEVERSION: "1.12.2-7.3.1-RC391"
+      DIFFICULTY: "0"
+
+    volumes:
+      - ./data:/data

tests/setuponlytests/spongevanilla_version_compare/verify.sh

@@ -0,0 +1 @@
+mc-image-helper assert propertyEquals --file=server.properties --property=difficulty --expect=0

tests/setuponlytests/test.sh

@@ -5,6 +5,16 @@ IFS=$'\n\t'
 # go to script root directory
 cd "$(dirname "$0")" || exit 1
 
+outputContainerLog() {
+  logs=${1?}
+
+  echo "${folder} test scenario FAILED"
+  echo ":::::::::::: LOGS ::::::::::::::::
+$logs
+::::::::::::::::::::::::::::::::::
+"
+}
+
 # tests that only run the setup files for things like downloads and configuration.
 setupOnlyMinecraftTest(){
   folder=$1
@@ -23,18 +33,15 @@ setupOnlyMinecraftTest(){
   fi
 
   if ! logs=$(docker-compose run mc 2>&1); then
-    echo "${folder} test scenario FAILED"
-    echo ":::::::::::: LOGS ::::::::::::::::
-$logs
-::::::::::::::::::::::::::::::::::
-"
+    outputContainerLog "$logs"
     result=1
   elif [ -f verify.sh ]; then
     if ! docker run --rm --entrypoint bash -v "${PWD}/data":/data -v "${PWD}/verify.sh":/verify "${IMAGE_TO_TEST:-itzg/minecraft-server}" -e /verify; then
-      echo "${folder} verify FAILED"
+      echo "Verify ${folder} FAILED"
+      outputContainerLog "$logs"
       result=1
     else
-      echo "${folder} verify PASS"
+      echo "Verify ${folder} PASS"
     fi
   else
     echo "${folder} PASS"