Merge branch 'master' into openj9

#749

.circleci/config.yml

@@ -0,0 +1,25 @@
+version: 2
+jobs:
+  minecraft_server:
+    docker:
+      - image: circleci/buildpack-deps:stable
+    steps:
+      - checkout
+      - setup_remote_docker
+      - run:
+          name: Build image
+          command: docker build -t itzg/minecraft-server:${CIRCLE_BRANCH} .
+#      - run:
+#          name: Build arm v7 image
+#          command: docker build -t itzg/minecraft-server:${CIRCLE_BRANCH}-arm-v7 --platform linux/arm/v7 --build-arg ARCH=armv7 .
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - minecraft_server:
+          filters:
+            branches:
+              ignore:
+                - armv7
+                - multiarch

.github/workflows/build-multiarch.yml

@@ -68,6 +68,8 @@ jobs:
           platforms: linux/amd64,linux/arm/v7,linux/arm64
           push: ${{ github.event_name != 'pull_request' }}
           tags: ${{ steps.prep.outputs.tags }}
+          # ensure latest base image is used
+          pull: true
           cache-from: type=local,src=/tmp/.buildx-cache
           cache-to: type=local,dest=/tmp/.buildx-cache
           labels: |

Dockerfile

@@ -1,4 +1,4 @@
-FROM adoptopenjdk/openjdk11:alpine-jre
+FROM adoptopenjdk/openjdk8-openj9:alpine
 
 LABEL org.opencontainers.image.authors="Geoff Bourne <itzgeoff@gmail.com>"
 
@@ -70,10 +70,10 @@ COPY log4j2.xml /tmp/log4j2.xml
 WORKDIR /data
 
 ENV UID=1000 GID=1000 \
-  JVM_XX_OPTS="-XX:+UseG1GC" MEMORY="1G" \
-  TYPE=VANILLA VERSION=LATEST FORGEVERSION=RECOMMENDED SPONGEBRANCH=STABLE SPONGEVERSION= FABRICVERSION=LATEST LEVEL=world \
-  PVP=true DIFFICULTY=easy ENABLE_RCON=true RCON_PORT=25575 RCON_PASSWORD=minecraft \
-  LEVEL_TYPE=DEFAULT SERVER_PORT=25565 ONLINE_MODE=TRUE SERVER_NAME="Dedicated Server" \
+  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" \
   ENABLE_AUTOPAUSE=false AUTOPAUSE_TIMEOUT_EST=3600 AUTOPAUSE_TIMEOUT_KN=120 AUTOPAUSE_TIMEOUT_INIT=600 \
   AUTOPAUSE_PERIOD=10 AUTOPAUSE_KNOCK_INTERFACE=eth0
 

README.md

@@ -487,6 +487,30 @@ A [Tuinity](https://github.com/Spottedleaf/Tuinity) server, which is a fork of P
 
 > **NOTE** only `VERSION=LATEST` is supported
 
+## Running a Purpur server
+
+A [Purpur](https://purpur.pl3x.net/) server, which is "a fork of Paper and Tuinity with the goal of providing new and interesting configuration options".
+
+    -e TYPE=PURPUR
+
+> NOTE: the `VERSION` variable is used to lookup a build of Purpur to download
+
+Extra variables:
+- `PURPUR_BUILD=LATEST` : set a specific Purpur build to use
+- `FORCE_REDOWNLOAD=false` : set to true to force the located server jar to be re-downloaded
+
+## Running a Yatopia server
+
+A [Yatopia](https://github.com/YatopiaMC/Yatopia) server, which is a "blazing fast Tuinity fork with best in class performance".
+
+    -e TYPE=YATOPIA
+
+> NOTE: the `VERSION` variable is used to locate the Yatopia version to download
+
+Extra variables:
+- `RELEASE=stable` : set to `stable` or `latest`
+- `FORCE_REDOWNLOAD=false` : set to true to force the located server jar to be re-downloaded
+
 ## Running a Magma server
 
 A [Magma](https://magmafoundation.org/) server, which is a combination of Forge and PaperMC, can be used with
@@ -1126,6 +1150,14 @@ via a `JVM_XX_OPTS` environment variable.
 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`.
 
+The container uses [OpenJ9](https://www.eclipse.org/openj9/docs) and a couple of J9 options are
+simplified by environment variables:
+
+- `-e TUNE_VIRTUALIZED=TRUE` : enables the option to 
+  [optimize for virtualized environments](https://www.eclipse.org/openj9/docs/xtunevirtualized/)
+- `-e TUNE_NURSERY_SIZES=TRUE` : configures nursery sizes where the initial size is 50%
+  of the `MAX_MEMORY` and the max size is 80%.
+
 ### Enable Remote JMX for Profiling
 
 To enable remote JMX, such as for profiling with VisualVM or JMC, add the environment variable `ENABLE_JMX=true` and add a port forwarding of TCP port 7091, such as:

start-configuration

@@ -1,7 +1,13 @@
 #!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
 
 . ${SCRIPTS:-/}start-utils
 
+: ${EULA:=}
+: ${PROXY:=}
+: ${RCON_PASSWORD_FILE:=}
+
 shopt -s nullglob
 
 #umask 002
@@ -107,6 +113,10 @@ case "${TYPE^^}" in
   ;;
 
   FTB|CURSEFORGE)
+    log "**********************************************************************"
+    log "WARNING: The image tag itzg/minecraft-server:java8 is recommended"
+    log "         since some mods require Java 8"
+    log "**********************************************************************"
     exec ${SCRIPTS:-/}start-deployCF "$@"
   ;;
 
@@ -138,11 +148,19 @@ case "${TYPE^^}" in
     exec ${SCRIPTS:-/}start-deployCatserver "$@"
   ;;
 
+  PURPUR)
+    exec ${SCRIPTS:-/}start-deployPurpur "$@"
+  ;;
+
+  YATOPIA)
+    exec ${SCRIPTS:-/}start-deployYatopia "$@"
+  ;;
+
   *)
       log "Invalid type: '$TYPE'"
       log "Must be: VANILLA, FORGE, BUKKIT, SPIGOT, PAPER, FTBA (multiarch-only),"
-      log "         CURSE_INSTANCE, CURSEFORGE, SPONGEVANILLA,"
-      log "         CUSTOM, MAGMA, MOHIST, CATSERVER"
+      log "         CURSE_INSTANCE, CURSEFORGE, SPONGEVANILLA, TUINITY, PURPUR"
+      log "         CUSTOM, MAGMA, MOHIST, CATSERVER, YATOPIA"
       exit 1
   ;;
 

start-deployForge

@@ -1,8 +1,8 @@
 #!/bin/bash
 
 . ${SCRIPTS:-/}start-utils
-
 export TYPE=FORGE
+: ${FORGEVERSION:=RECOMMENDED}
 
 if [[ -z $FORGE_INSTALLER && -z $FORGE_INSTALLER_URL ]]; then
   norm=$VANILLA_VERSION

start-deployPaper

@@ -58,7 +58,7 @@ else
 
   log "Removing old PaperMC versions ..."
   paperJarSearchString=${SERVER/$build/[0-9]*}
-  find . -name "$paperJarSearchString" ! -name "$SERVER" -delete -print
+  find . -maxdepth 1 -name "$paperJarSearchString" ! -name "$SERVER" -delete -print
 
   log "Downloading PaperMC $VANILLA_VERSION (build $build) ..."
   curl -fsSL -o "$SERVER" "${zarg[@]}" \

start-deployPurpur

@@ -0,0 +1,38 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+. ${SCRIPTS:-/}start-utils
+isDebugging && set -x
+
+: ${VANILLA_VERSION:?}
+: ${PURPUR_BUILD:=LATEST}
+: ${FORCE_REDOWNLOAD:=false}
+
+if [[ ${PURPUR_BUILD} == LATEST ]]; then
+  PURPUR_BUILD=$(curl -fsSL "https://purpur.pl3x.net/api/v1/purpur/${VANILLA_VERSION}" |
+    jq -r '.builds.latest' || echo "")
+  if [[ -z ${PURPUR_BUILD} ]]; then
+    log "ERROR: Failed to locate a Purpur build for ${VANILLA_VERSION}."
+    log "       Please check if a download is available at https://purpur.pl3x.net/downloads/"
+    exit 3
+  fi
+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"
+    log "Downloading Purpur from $downloadUrl ..."
+    if ! curl -fsSL -o "$SERVER" "$downloadUrl"; then
+      log "ERROR: failed to download from $downloadUrl (status=$?)"
+      exit 3
+    fi
+fi
+
+# Normalize on Spigot for later operations
+export TYPE=SPIGOT
+export SKIP_LOG4J_CONFIG=true
+
+# Continue to Final Setup
+exec ${SCRIPTS:-/}start-finalSetupWorld $@

start-deploySpongeVanilla

@@ -3,6 +3,8 @@
 . ${SCRIPTS:-/}start-utils
 
 export TYPE=spongevanilla
+: ${SPONGEBRANCH:=STABLE}
+: ${SPONGEVERSION:=}
 
 # Parse branch
 log "Choosing branch for Sponge"

start-deployTuinity

@@ -20,7 +20,7 @@ if [ ! -f "$SERVER" ] || [ -n "$FORCE_REDOWNLOAD" ]; then
     fi
 fi
 
-# Normalize on Spigot for operations below
+# Normalize on Spigot for later operations
 export TYPE=SPIGOT
 
 # Continue to Final Setup

start-deployYatopia

@@ -0,0 +1,30 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+. ${SCRIPTS:-/}start-utils
+isDebugging && set -x
+
+: ${VANILLA_VERSION:?}
+: ${RELEASE:=stable}
+: ${FORCE_REDOWNLOAD:=false}
+
+requireEnum RELEASE stable latest
+
+export SERVER="yatopia-${RELEASE}-${VANILLA_VERSION}.jar"
+
+if [ ! -f "$SERVER" ] || isTrue "$FORCE_REDOWNLOAD"; then
+    downloadUrl="https://api.yatopiamc.org/v2/${RELEASE}Build/download?branch=ver/${VANILLA_VERSION}"
+    log "Downloading Yatopia from $downloadUrl ..."
+    if ! curl -fsSL -o "$SERVER" "$downloadUrl"; then
+      log "ERROR: failed to download from $downloadUrl (status=$?)"
+      exit 3
+    fi
+fi
+
+# Normalize on Spigot for later operations
+export TYPE=SPIGOT
+export SKIP_LOG4J_CONFIG=true
+
+# Continue to Final Setup
+exec ${SCRIPTS:-/}start-finalSetupWorld $@

start-finalSetupServerProperties

@@ -69,7 +69,7 @@ function customizeServerProps {
   setServerProp "max-world-size" "$MAX_WORLD_SIZE"
   setServerProp "level-name" "$LEVEL"
   setServerProp "level-seed" "$SEED"
-  setServerProp "pvp" "$PVP"
+  setServerProp "pvp" "${PVP}"
   setServerProp "generator-settings" "$GENERATOR_SETTINGS"
   setServerProp "online-mode" "$ONLINE_MODE"
   setServerProp "allow-flight" "$ALLOW_FLIGHT"

start-finalSetupWorld

@@ -4,6 +4,9 @@
 set -e
 isDebugging && set -x
 
+: ${LEVEL:=world}
+export LEVEL
+
 if [ $TYPE = "FEED-THE-BEAST" ]; then
   worldDest=$FTB_DIR/$LEVEL
 else

start-minecraftFinalSetup

@@ -83,6 +83,23 @@ if [ -n "$JVM_DD_OPTS" ]; then
       done
 fi
 
+if isTrue ${TUNE_VIRTUALIZED}; then
+  JVM_XX_OPTS="${JVM_XX_OPTS} -Xtune:virtualized"
+fi
+
+if isTrue ${TUNE_NURSERY_SIZES}; then
+  case ${MAX_MEMORY^^} in
+    *G)
+      MAX_MEMORY_MB=$(( ${MAX_MEMORY%?} * 1024 )) ;;
+    *M)
+      MAX_MEMORY_MB=${MAX_MEMORY%?} ;;
+  esac
+
+  NURSERY_MINIMUM=$(( ${MAX_MEMORY_MB} / 2 ))
+  NURSERY_MAXIMUM=$(( ${MAX_MEMORY_MB} * 4/5 ))
+  JVM_XX_OPTS="${JVM_XX_OPTS} -Xmns${NURSERY_MINIMUM}M -Xmnx${NURSERY_MAXIMUM}M"
+fi
+
 if isTrue ${ENABLE_JMX}; then
   : ${JMX_HOST:=0.0.0.0}
   : ${JMX_PORT:=7091}
@@ -168,6 +185,11 @@ function copyFilesForCurseForge() {
   cp -f /data/eula.txt "${FTB_DIR}/"
 }
 
+if ! which java > /dev/null; then
+  log "Fixing PATH to include java"
+  PATH="${PATH}:/opt/java/openjdk/bin"
+fi
+
 mcServerRunnerArgs="--stop-duration ${STOP_DURATION:-60}s"
 if [[ ${TYPE} == "CURSE_INSTANCE" ]]; then
     if isTrue ${DEBUG_EXEC}; then

start-utils

@@ -144,6 +144,20 @@ requireVar() {
   fi
 }
 
+requireEnum() {
+  var=${1?}
+  shift
+
+  for allowed in $*; do
+    if [[ ${!var} = $allowed ]]; then
+      return 0
+    fi
+  done
+
+  log "ERROR: $var must be set to one of $@"
+#  exit 1
+}
+
 function writeEula() {
   if ! echo "# Generated via Docker
 # $(date)