build: upgrade easy-add to 0.8.4 (#2686)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Dockerfile

@@ -25,7 +25,7 @@ EXPOSE 25565
 ARG APPS_REV=1
 ARG GITHUB_BASEURL=https://github.com
 
-ARG EASY_ADD_VERSION=0.8.2
+ARG EASY_ADD_VERSION=0.8.4
 ADD ${GITHUB_BASEURL}/itzg/easy-add/releases/download/${EASY_ADD_VERSION}/easy-add_${TARGETOS}_${TARGETARCH}${TARGETVARIANT} /usr/bin/easy-add
 RUN chmod +x /usr/bin/easy-add
 
@@ -44,12 +44,12 @@ RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${MC_MONITOR_VERSION} --var app=mc-monitor --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_SERVER_RUNNER_VERSION=1.11.0
+ARG MC_SERVER_RUNNER_VERSION=1.11.1
 RUN easy-add --var os=${TARGETOS} --var arch=${TARGETARCH}${TARGETVARIANT} \
   --var version=${MC_SERVER_RUNNER_VERSION} --var app=mc-server-runner --file {{.app}} \
   --from ${GITHUB_BASEURL}/itzg/{{.app}}/releases/download/{{.version}}/{{.app}}_{{.version}}_{{.os}}_{{.arch}}.tar.gz
 
-ARG MC_HELPER_VERSION=1.37.11
+ARG MC_HELPER_VERSION=1.38.5
 ARG MC_HELPER_BASE_URL=${GITHUB_BASEURL}/itzg/mc-image-helper/releases/download/${MC_HELPER_VERSION}
 # used for cache busting local copy of mc-image-helper
 ARG MC_HELPER_REV=1

docs/commands.md

@@ -19,7 +19,9 @@ docker exec mc rcon-cli stop
 
 _The `-i` is not needed in this case._
 
-If rcon is disabled you can send commands by passing them as arguments to the packaged `mc-send-to-console` script. For example, a player can be op'ed in the container `mc` with: 
+## When RCON is disabled
+
+If rcon is disabled you can send commands by passing them as arguments to the packaged `mc-send-to-console` script after setting the env var `CREATE_CONSOLE_IN_PIPE` to "true". For example, a player can be op'ed in the container `mc` with: 
 
 ```shell
 docker exec mc mc-send-to-console op player
@@ -27,9 +29,26 @@ docker exec mc mc-send-to-console op player
             +- container name     +- Minecraft commands start here
 ```
 
-In order to attach and interact with the Minecraft server, add `-it` when starting the container, such as
+## Enabling interactive console
 
+In order to attach and interact with the Minecraft server make sure to enable TTY and keep stdin open.
+
+!!! example
+
+    With `docker run` use the `-it` arguments:
+
+    ```shell
     docker run -d -it -p 25565:25565 --name mc itzg/minecraft-server
+    ```
+
+    or with a compose file:
+
+    ```yaml
+    services:
+      minecraft:
+        stdin_open: true
+        tty: true
+    ```
 
 With that you can attach and interact at any time using
 
@@ -37,9 +56,6 @@ With that you can attach and interact at any time using
 
 and then Control-p Control-q to **detach**.
 
-For remote access, configure your Docker daemon to use a `tcp` socket (such as `-H tcp://0.0.0.0:2375`)
-and attach from another machine:
+!!! info "RCON is required for fully interactive, color console"
 
-    docker -H $HOST:2375 attach mc
-
-Unless you're on a home/private LAN, you should [enable TLS access](https://docs.docker.com/articles/https/).
+    RCON must be enabled, which is the default, in order to use a fully interactive console with auto-completion and colorized log output. 

docs/configuration/server-properties.md

@@ -128,6 +128,11 @@ To change the behavior when the whitelist file already exists, set the variable
 
 To [enforce the whitelist changes immediately](https://minecraft.wiki/w/Server.properties#enforce-whitelist) when whitelist commands are used , set `ENFORCE_WHITELIST` to "true". If managing the whitelist file manually, `ENABLE_WHITELIST` can be set to "true" to set the `white-list` property.
 
+!!! tip "Changing user API provider"
+
+    The usernames provided for whitelist and ops processing are resolved using either [PlayerDB](https://playerdb.co/) or [Mojang's API](https://wiki.vg/Mojang_API#Username_to_UUID). The default uses PlayerDB, but can be changed by setting the environment variable `USER_API_PROVIDER` to "mojang". Sometimes one or the other service can become overloaded, which is why there is the ability to switch providers.
+
+
 ### Op/Administrator Players
 
 Similar to the whitelist, users can be provisioned as operators (aka administrators) to your Minecraft server by

docs/misc/examples.md

@@ -36,10 +36,9 @@ By using [Lazytainer](https://github.com/vmorganp/Lazytainer) with the [docker-m
 version: "3"
 services:
   lazytainer:
-    container_name: lazytainer
     image: ghcr.io/vmorganp/lazytainer:master
     environment:
-      - VERBOSE=false
+      VERBOSE: false
     ports:
       - 25565:25565
     volumes:
@@ -54,13 +53,11 @@ services:
   mc:
     image: itzg/minecraft-server
     environment:
-      - EULA=TRUE
-      - TYPE=PURPUR
-      - MEMORY=4G
-      - TZ=Europe/Berlin
-      - OVERRIDE_SERVER_PROPERTIES=TRUE
+      EULA: TRUE
+      TYPE: PAPER
+      MEMORY: 4G
     volumes:
-      - /opt/container_volumes/minecraft/data:/data
+      - ./data:/data
     labels:
       - lazytainer.group=minecraft
     depends_on:
@@ -69,6 +66,5 @@ services:
     tty: true
     stdin_open: true
     restart: unless-stopped
-networks: {}
 ```
 [Source](https://github.com/itzg/docker-minecraft-server/blob/master/examples/lazytainer/docker-compose.yml)

docs/requirements.txt

@@ -1,5 +1,5 @@
 mkdocs == 1.5.3
-mkdocs-material == 9.5.7
+mkdocs-material == 9.5.11
 mkdocs-autorefs == 0.5.0
 mkdocstrings == 0.24.0
 mkdocs-literate-nav == 0.6.1

docs/types-and-platforms/mod-platforms/auto-curseforge.md

@@ -207,12 +207,36 @@ Ant-style paths can include the following globbing/wildcard symbols:
 ## World/Level Data
 
 Some modpacks come with world/save data via a worlds file and/or the overrides provided with the modpack. Either approach can be selected to set the `LEVEL` to the resulting saves directory by setting `CF_SET_LEVEL_FROM` to either:
+
 - `WORLD_FILE`
 - `OVERRIDES`
 
+## Ignore missing files
+
+Some mods use temporary files from the modpack and delete them when finished. Others will patch themselves and "disable" the original mod jar, such as gregtech. In order to avoid the installer from detecting the absent file(s) and re-installing, those files can be ignored by passing a comma or newline delimited list to `CF_IGNORE_MISSING_FILES`.
+
+!!! hint
+
+    A warning log will indicate what files were found to be missing from the previous installation run, such as
+
+    ```
+    Re-installing due to missing files from modpack: [mods/gregtech-2.6.2-beta.jar]
+    ```
+
+!!! example
+
+    In a Compose file
+    ```yaml
+      environment:
+        CF_IGNORE_MISSING_FILES: |
+          mods/gregtech-2.6.2-beta.jar
+    ```
+
+
 ## Extra options
 
 Other configuration available:
+
 - `CF_PARALLEL_DOWNLOADS` (default is 4): specify how many parallel mod downloads to perform
 - `CF_OVERRIDES_SKIP_EXISTING` (default is false): if set, files in the overrides that already exist in the data directory are skipped. **NOTE** world data is always skipped, if present.
 - `CF_FORCE_REINSTALL_MODLOADER` (default is false): this can be set to `true` to force the modpack's declared modloader, such as Forge, to be reinstalled. This is useful if some of the modloader's files become corrupted.

docs/types-and-platforms/server-types/hybrids.md

@@ -8,7 +8,7 @@ A [Magma](https://magmafoundation.org/) server, which is a combination of Forge
 
 !!! note
 
-    The Magma project [has been terminated](https://git.magmafoundation.org/magmafoundation/magma-1-20-x/-/commit/4e7abe37403c47d09b74b77bcfc26a19b18f5891). Please use Magma Maintained for 1.12.2, 1.18.2, 1.19.3, and 1.20.1, or Ketting for 1.20.2+.
+    The Magma project has been terminated ([original link died](https://git.magmafoundation.org/magmafoundation/magma-1-20-x/-/commit/4e7abe37403c47d09b74b77bcfc26a19b18f5891), [alternate statement on their discord](https://discord.com/channels/612695539729039411/647287352833605662/1174412642962649198) ). Please use Magma Maintained for 1.12.2, 1.18.2, 1.19.3, and 1.20.1, or Ketting for 1.20.1+.
 
     There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2", "1.16.5", etc.
 
@@ -25,18 +25,15 @@ A [Magma Maintained](https://github.com/magmamaintained/) server, which is a alt
 
 ### Ketting
 
-A [Ketting](https://github.com/kettingpowered/Ketting-1-20-x) server, which is a alternative project of Magma 1.20.2+, can be used with
+A [Ketting](https://github.com/kettingpowered/Ketting-1-20-x) server, which is an alternative project of Magma 1.20.1+, can be used with
 
     -e TYPE=KETTING
 
-There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.20.2" or later.
-
-In addition, `FORGE_VERSION` and `KETTING_VERSION` must be specified. You can find the supported `FORGE_VERSION` in the [project page](https://github.com/kettingpowered/Ketting-1-20-x), and `KETTING_VERSION` in the [release page](https://github.com/kettingpowered/Ketting-1-20-x/releases).
-
-!!! note
-
-    The length of `KETTING_VERSION` is 8, not 7 since it is taken from an abbreviated git commit hash. The value can be found in a jar file link on an Assets section for each releases.
+There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.20.1" or later.
 
+`FORGE_VERSION` and `KETTING_VERSION` may be specified; however, they will be defaulted by the [Ketting launcher](https://github.com/kettingpowered/kettinglauncher) otherwise.
+Available Ketting Versions may be found at [https://github.com/kettingpowered/Ketting-1-20-x/packages/2041866/versions](https://github.com/kettingpowered/Ketting-1-20-x/packages/2041866/versions).
+The Version structure is `MinecraftVersion-ForgeVersion-KettingVersion` (e.g. `1.20.1-47.2.20-0.1.4` is for Minecraft `1.20.1`, Forge `47.2.20` and Ketting `0.1.4`).
 
 ### Mohist
 

examples/docker-compose.yml

@@ -4,6 +4,8 @@ version: '3'
 services:
   minecraft:
     image: itzg/minecraft-server
+    stdin_open: true
+    tty: true
     ports:
       - "25565:25565"
     volumes:

examples/lazytainer/docker_compose.yml

@@ -1,10 +1,9 @@
 version: "3"
 services:
   lazytainer:
-    container_name: lazytainer
     image: ghcr.io/vmorganp/lazytainer:master
     environment:
-      - VERBOSE=false
+      VERBOSE: false
     ports:
       - 25565:25565
     volumes:
@@ -19,13 +18,11 @@ services:
   mc:
     image: itzg/minecraft-server
     environment:
-      - EULA=TRUE
-      - TYPE=PURPUR
-      - MEMORY=4G
-      - TZ=Europe/Berlin
-      - OVERRIDE_SERVER_PROPERTIES=TRUE
+      EULA: TRUE
+      TYPE: PAPER
+      MEMORY: 4G
     volumes:
-      - /opt/container_volumes/minecraft/data:/data
+      - ./data:/data
     labels:
       - lazytainer.group=minecraft
     depends_on:
@@ -34,4 +31,3 @@ services:
     tty: true
     stdin_open: true
     restart: unless-stopped
-networks: {}

files/cf-exclude-include.json

@@ -59,6 +59,11 @@
       "excludes": [
         "modernfix"
       ]
+    },
+    "create-arcane-engineering": {
+      "forceIncludes": [
+        "just-enough-resources-jer"
+      ]
     }
   }
 }

scripts/start-configuration

@@ -240,7 +240,6 @@ case "${TYPE^^}" in
   ;;
 
   KETTING)
-    evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployKetting" "$@"
   ;;
 

scripts/start-deployAutoCF

@@ -11,6 +11,7 @@ set -eu
 : "${CF_PARALLEL_DOWNLOADS:=4}"
 : "${CF_FORCE_SYNCHRONIZE:=false}"
 : "${CF_FORCE_REINSTALL_MODLOADER:=false}"
+: "${CF_IGNORE_MISSING_FILES:=}"
 : "${CF_EXCLUDE_INCLUDE_FILE=https://raw.githubusercontent.com/itzg/docker-minecraft-server/master/files/cf-exclude-include.json}"
 : "${CF_EXCLUDE_MODS:=}"
 : "${CF_FORCE_INCLUDE_MODS:=}"
@@ -24,6 +25,8 @@ resultsFile=/data/.install-curseforge.env
 
 isDebugging && set -x
 
+ensureRemoveAllModsOff "MOD_PLATFORM=AUTO_CURSEFORGE"
+
 args=(
   --results-file="$resultsFile"
 )
@@ -48,6 +51,9 @@ fi
 if [[ ${CF_OVERRIDES_EXCLUSIONS} ]]; then
   args+=(--overrides-exclusions="$CF_OVERRIDES_EXCLUSIONS")
 fi
+if [[ ${CF_IGNORE_MISSING_FILES} ]]; then
+  args+=(--ignore-missing-files="$CF_IGNORE_MISSING_FILES")
+fi
 args+=(
   --force-synchronize="$CF_FORCE_SYNCHRONIZE"
   --force-reinstall-modloader="$CF_FORCE_REINSTALL_MODLOADER"

scripts/start-deployBukkitSpigot

@@ -4,7 +4,7 @@
 . "${SCRIPTS:-/}start-utils"
 isDebugging && set -x
 
-set -e
+set -eo pipefail
 
 function buildSpigotFromSource {
   if [[ ${TYPE^^} = *BUKKIT ]] && ! versionLessThan "1.14"; then
@@ -25,14 +25,14 @@ function buildSpigotFromSource {
 
   case ${TYPE^^} in
     SPIGOT)
-      if ! mv spigot-*.jar /data/${SERVER}; then
+      if ! mv spigot-*.jar "/data/${SERVER}"; then
         log "ERR failed to build Spigot"
         cat /data/spigot_build.log
         exit 1
       fi
       ;;
     *BUKKIT)
-      if ! mv craftbukkit-*.jar /data/${SERVER}; then
+      if ! mv craftbukkit-*.jar "/data/${SERVER}"; then
         log "ERR failed to build Spigot"
         cat /data/spigot_build.log
         exit 1
@@ -61,11 +61,14 @@ function downloadSpigot {
   esac
 
   if [[ ${VERSION^^} = LATEST ]]; then
-    VERSION=$(restify https://getbukkit.org/download/spigot --attribute='property=og:title' | jq -r '.[0] | .attributes | select(.property == "og:title") | .content | split(" ") | .[-1]')
+    if ! VERSION=$(restify https://getbukkit.org/download/spigot --attribute='property=og:title' | jq -r '.[0] | .attributes | select(.property == "og:title") | .content | split(" ") | .[-1]'); then
+      log "ERROR: failed to retrieve latest version from https://getbukkit.org/download/spigot -- site might be down"
+      exit 1
+    fi
   fi
 
   if [[ -z $downloadUrl ]]; then
-    if versionLessThan 1.16.5 || ([[ ${getbukkitFlavor} = "craftbukkit" ]] && [[ ${VERSION} = "1.16.5" ]]); then
+    if versionLessThan 1.16.5 || { [[ ${getbukkitFlavor} = "craftbukkit" ]] && [[ ${VERSION} = "1.16.5" ]] ; }; then
       downloadUrl="https://cdn.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VERSION}.jar"
     else
       downloadUrl="https://download.getbukkit.org/${getbukkitFlavor}/${getbukkitFlavor}-${VERSION}.jar"
@@ -82,7 +85,7 @@ function downloadSpigot {
   fi
   log "Downloading $match from $downloadUrl ..."
   curl -fsSL -o "$SERVER" $curlArgs "$downloadUrl"
-  if [[ $? != 0 || $(grep -c "DOCTYPE html" $SERVER) != 0 ]]; then
+  if [[ $? != 0 || $(grep -c "DOCTYPE html" "$SERVER") != 0 ]]; then
     cat <<EOF
 
 ERROR: failed to download from $downloadUrl
@@ -130,4 +133,4 @@ fi
 # Normalize on Spigot for operations below
 export FAMILY=SPIGOT
 
-exec ${SCRIPTS:-/}start-spiget "$@"
+exec "${SCRIPTS:-/}start-spiget" "$@"

scripts/start-deployKetting

@@ -4,26 +4,27 @@
 . "${SCRIPTS:-/}start-utils"
 isDebugging && set -x
 
-: "${FORGE_VERSION:=${FORGEVERSION:-RECOMMENDED}}"
-: "${KETTING_VERSION:=}"
-: "${KETTING_TAG:=${KETTING_VERSION:0:7}}"
+if ! SERVER=$(mc-image-helper github download-latest-asset \
+  --output-directory=/data \
+  --name-pattern="kettinglauncher-.+?(?<!-sources)\.jar" \
+  kettingpowered/kettinglauncher
+  ); then
+    log "ERROR: failed to download Ketting launcher"
+    exit 1
+fi
+
+export SERVER
 
 resolveVersion
 
-if ! downloadUrl="https://github.com/kettingpowered/Ketting-1-20-x/releases/download/${KETTING_TAG}/ketting-${VERSION}-${FORGE_VERSION}-${KETTING_VERSION}-server.jar"; then
-  log "ERROR failed to locate latest Ketting download for ${VERSION}. Is that version supported?"
-  exit 1
+EXTRA_ARGS+="-minecraftVersion $VERSION"
+if [[ ${KETTING_VERSION:-} ]]; then
+  EXTRA_ARGS+="-kettingVersion $KETTING_VERSION"
 fi
-
-if [[ $downloadUrl == null ]]; then
-  log "ERROR Ketting does not seem to be available for $VERSION"
-  exit 1
-fi
-
-if ! SERVER=$(get --output-filename --skip-up-to-date --output /data "$downloadUrl"); then
-  log "ERROR: failed to download Ketting server jar from $downloadUrl"
-  exit 1
+if [[ ${FORGE_VERSION:-} ]]; then
+  EXTRA_ARGS+="-forgeVersion $FORGE_VERSION"
 fi
+export EXTRA_ARGS
 
 export SERVER
 export FAMILY=HYBRID

scripts/start-deployModrinth

@@ -19,6 +19,8 @@ fi
 
 isDebugging && set -x
 
+ensureRemoveAllModsOff "MOD_PLATFORM=MODRINTH"
+
 args=(
   --results-file="$resultsFile"
   --project="${MODRINTH_MODPACK}"

scripts/start-finalExec

@@ -203,11 +203,6 @@ if [[ ${INIT_MEMORY} || ${MAX_MEMORY} ]]; then
 fi
 
 function copyFilesForCurseForge() {
-  # copy player modification files unconditionally since their
-  # processing into json is additive anyway
-  [ -f /data/ops.txt ] && cp -f /data/ops.txt "${FTB_DIR}/"
-  [ -f /data/white-list.txt ] && cp -f /data/white-list.txt "${FTB_DIR}/"
-
   if [ ! -e "${FTB_DIR}/server-icon.png" ] && [ -e /data/server-icon.png ]; then
     cp -f /data/server-icon.png "${FTB_DIR}/"
   fi

scripts/start-setupModpack

@@ -83,6 +83,9 @@ fi
 function handleListings() {
   if usesMods && usesPlugins; then
       if [[ "$MODS" ]]; then
+
+        ensureRemoveAllModsOff "MODS is set"
+
         mkdir -p "$MODS_OUT_DIR"
         mc-image-helper mcopy \
           --glob=*.jar \
@@ -91,6 +94,7 @@ function handleListings() {
           "$MODS"
       fi
       if [[ "$PLUGINS" ]]; then
+        ensureRemoveAllModsOff "PLUGINS is set"
         mkdir -p "$PLUGINS_OUT_DIR"
         mc-image-helper mcopy \
           --glob=*.jar \
@@ -100,6 +104,7 @@ function handleListings() {
       fi
 
       if [[ "$MODS_FILE" ]]; then
+        ensureRemoveAllModsOff "MODS_FILE is set"
         mkdir -p "$MODS_OUT_DIR"
         mc-image-helper mcopy \
           --file-is-listing \
@@ -108,6 +113,7 @@ function handleListings() {
           "$MODS_FILE"
       fi
       if [[ "$PLUGINS_FILE" ]]; then
+        ensureRemoveAllModsOff "PLUGINS_FILE is set"
         mkdir -p "$PLUGINS_OUT_DIR"
         mc-image-helper mcopy \
           --file-is-listing \
@@ -123,6 +129,7 @@ function handleListings() {
     fi
 
     if [[ "$MODS" || "$PLUGINS" ]]; then
+      ensureRemoveAllModsOff "MODS or PLUGINS is set"
       mkdir -p "$outDir"
       mc-image-helper mcopy \
         --glob=*.jar \
@@ -132,6 +139,7 @@ function handleListings() {
     fi
 
     if [[ "$MODS_FILE" || "$PLUGINS_FILE" ]]; then
+      ensureRemoveAllModsOff "MODS_FILE or PLUGINS_FILE is set"
       mkdir -p "$outDir"
       mc-image-helper mcopy \
         --file-is-listing \
@@ -237,7 +245,7 @@ function handleModrinthProjects() {
   fi
 
   if [[ $MODRINTH_PROJECTS ]] && isFamily HYBRID FORGE FABRIC SPIGOT; then
-    if isFamily HYBRID FORGE; then
+    if isFamily HYBRID; then
       loader=forge
     else
       loader="${TYPE,,}"

scripts/start-setupRbac

@@ -22,6 +22,11 @@ elif [[ -v OVERRIDE_WHITELIST ]] && isTrue "${OVERRIDE_WHITELIST}"; then
 fi
 
 sharedArgs=(--version="$VERSION")
+if [[ ${FTB_DIR:-} ]]; then
+  sharedArgs+=(--output-directory="$FTB_DIR")
+else
+  sharedArgs+=(--output-directory=/data)
+fi
 
 if [[ -v OPS_FILE ]]; then
   existing="$EXISTING_OPS_FILE"

scripts/start-utils

@@ -347,4 +347,13 @@ function resolveFamily() {
       ;;
   esac
   export FAMILY
+}
+
+function ensureRemoveAllModsOff() {
+  reason=${1?}
+
+  if isTrue "${REMOVE_OLD_MODS:-false}"; then
+    log "WARNING using REMOVE_OLDS_MODS interferes with $reason -- it is now disabled"
+    REMOVE_OLD_MODS=false
+  fi
 }

tests/setuponlytests/cf_files/listing.txt

@@ -1 +1 @@
-architectury-api@4.11.93
+architectury-api@4.12.94