docs: added example for All of Fabric 7 (#2575)

.github/workflows/build-multiarch.yml

@@ -118,7 +118,7 @@ jobs:
 
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v5.2.0
+        uses: docker/metadata-action@v5.4.0
         with:
           # NOTE for forks: if your Docker Hub organization doesn't match your Github repo's,
           # then the use of ${{ github.repository_owner }} will need to be replaced.

Dockerfile

@@ -49,7 +49,7 @@ 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.4
+ARG MC_HELPER_VERSION=1.37.6
 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/misc/contributing/development.md

@@ -46,24 +46,26 @@ popd
 
 Using the baseline image, an interactive container can be started to iteratively run the scripts to be developed. By attaching the current workspace directory, you can use the local editor of your choice to iteratively modify scripts while using the container to run them.
 
-```shell script
+```shell
 docker run -it --rm -v ${PWD}:/scripts -e SCRIPTS=/scripts/ --entrypoint bash mc-dev
 ```
 
 From within the container you can run individual scripts via the attached `/scripts/` path; however, be sure to set any environment variables expected by the scripts by either `export`ing them manually:
 
-```shell script
+```shell
 export VERSION=1.12.2
 /scripts/start-magma
 ```
 
 ...or pre-pending script execution:
 
-```shell script
+```shell
 VERSION=1.12.2 /scripts/start-magma
 ```
 
-> NOTE: You may want to temporarily add an `exit` statement near the end of your script to isolate execution to just the script you're developing.
+!!! note
+
+    You may want to temporarily add an `exit` statement near the end of your script to isolate execution to just the script you're developing.
 
 ## Using development copy of tools
 

docs/requirements.txt

@@ -1,9 +1,9 @@
 mkdocs == 1.5.3
 mkdocs-material-extensions == 1.3.1
-mkdocs-material == 9.4.14
+mkdocs-material == 9.5.3
 mkdocs-autorefs == 0.5.0
 mkdocstrings == 0.24.0
 mkdocs-literate-nav == 0.6.1
-mdx-gh-links == 0.3.1
+mdx-gh-links == 0.4
 mkdocs-click == 0.8.1
 mkdocs-static-i18n == 1.2.0

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

@@ -1,5 +1,9 @@
 # Manual CurseForge server packs
 
+!!! warning "Deprecated"
+
+    This mod platform type is deprecated. Please use [AUTO_CURSEFORGE](auto-curseforge.md) for new deployments.
+
 Enable this server mode by setting `MOD_PLATFORM` or `TYPE` to "CURSEFORGE" along with the following specific variables.
 
 You need to specify a modpack to run, using the `CF_SERVER_MOD` environment

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

@@ -40,7 +40,7 @@ In both of the cases above, there is no need for the `VERSION` or `FORGE_VERSION
 
 ### NeoForge
 
-Support for [NeoForge](https://neoforged.net/) is also provided. A NeoForge server can be automatically managed by setting `TYPE` to "NEOFORGE". `VERSION` specifies the Minecraft version and `NEOFORGE_VERSION` can be set to select a specific sub-version. By default, the latest NeoForge version available for the requested Minecraft version will be used.
+Support for [NeoForge](https://neoforged.net/) is also provided. A NeoForge server can be automatically managed by setting `TYPE` to "NEOFORGE". `VERSION` specifies the Minecraft version and `NEOFORGE_VERSION` can be set to select a specific version, "latest", or "beta". By default, the latest, non-beta NeoForge version available for the requested Minecraft version will be used.
 
 !!! example
 
@@ -52,6 +52,6 @@ Support for [NeoForge](https://neoforged.net/) is also provided. A NeoForge serv
     ```yaml
         environment:
           TYPE: NEOFORGE
-          VERSION: "1.20.1"
-          NEOFORGE_VERSION: "47.1.79"
+          VERSION: "1.20.4"
+          NEOFORGE_VERSION: "beta"
     ```

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

@@ -8,14 +8,24 @@ A [Magma](https://magmafoundation.org/) server, which is a combination of Forge
 
 !!! note
 
-The Magma project [has benn terminated](https://git.magmafoundation.org/magmafoundation/magma-1-20-x/-/commit/4e7abe37403c47d09b74b77bcfc26a19b18f5891). Please use Ketting for 1.20.2+.
+    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+.
 
-There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2", "1.16.5", etc.
+    There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2", "1.16.5", etc.
 
+### Magma Maintained
+A [Magma Maintained](https://github.com/magmamaintained/) server, which is a alternative project of Magma, can be used with
+
+    -e TYPE=MAGMA_MAINTAINED
+
+!!! note
+
+    There are limited base versions supported, so you will also need to set `VERSION`, such as "1.12.2", "1.18.2", "1.19.3", or "1.20.1".
+
+    In addition, `FORGE_VERSION` and `MAGMA_MAINTAINED_TAG` must be specified. You can find the supported `FORGE_VERSION` and `MAGMA_MAINTAINED_TAG` in a releases page for each repositories.
 
 ### Ketting
 
-A [Ketting](https://github.com/kettingpowered/Ketting-1-20-x) server, which is a alternative project of Magma 1.20+, can be used with
+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
 
     -e TYPE=KETTING
 
@@ -25,7 +35,7 @@ In addition, `FORGE_VERSION` and `KETTING_VERSION` must be specified. You can fi
 
 !!! 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.
+    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.
 
 
 ### Mohist
@@ -36,7 +46,7 @@ A [Mohist](https://github.com/MohistMC/Mohist) server can be used with
 
 !!! note
 
-There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2"
+    There are limited base versions supported, so you will also need to  set `VERSION`, such as "1.12.2"
 
 By default the latest build will be used; however, a specific build number can be selected by setting `MOHIST_BUILD`, such as
 

docs/variables.md

@@ -1,5 +1,11 @@
 
-### **OS OPTIONS**
+!!! warning
+
+    The variables listed on this page are manually documented and may be out-of-date or inaccurate. 
+
+    All other documentation pages are actively maintained, so please use the search box above to find the desired topic.
+
+### General options
 <table>
     <thead>
         <tr>
@@ -108,7 +114,7 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
     </tbody>
 </table>
 
-### **SERVER**
+### Server
 
 <table>
     <thead>
@@ -448,7 +454,7 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
     </tbody>
 </table>
 
-### **CUSTOM RESOURCE PACK**
+### Custom resource pack
 
 <table>
     <thead>
@@ -481,7 +487,7 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
     </tbody>
 </table>
 
-### **WHITELIST**
+### Whitelist
 
 <table>
     <thead>
@@ -520,7 +526,7 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
     </tbody>
 </table>
 
-### **RCON**
+### RCON
 
 <table>
     <thead>
@@ -589,7 +595,7 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
     </tbody>
 </table>
 
-### **AUTOPAUSE**
+### Auto-Pause
 
 !!! note
 
@@ -652,7 +658,7 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
 
 
 
-### **AUTOSTOP**
+### Auto-Stop
 
 !!! note
 
@@ -702,11 +708,11 @@ alternatively, you can mount: <code>/etc/localtime:/etc/localtime:ro
 </table>
 
 
-### **CURSEFORGE**
+### CurseForge
 
-!!! note
-
-     A CurseForge API key is required to use a CurseForge type server. Go to their [developer console](https://console.curseforge.com/), generate an API key, and set the environment variable CF_API_KEY
+!!! tip
+    
+    Refer to the [main documentation page](types-and-platforms/mod-platforms/auto-curseforge.md) for more details and up-to-date information.
 
 <table>
     <thead>

examples/.gitignore

@@ -1,3 +1,4 @@
 data/
 modpacks/
-.env
+.env
+downloads/

examples/aof7/docker-compose.yml

@@ -0,0 +1,37 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      MOD_PLATFORM: AUTO_CURSEFORGE
+      # from .env
+      CF_API_KEY: ${CF_API_KEY}
+      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-of-fabric-7
+#      CF_FILENAME_MATCHER: 1.2.2
+      CF_OVERRIDES_EXCLUSIONS: |
+        mods/iris*.jar
+        mods/sodium*.jar
+      MEMORY: 4G
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+      - ./downloads:/downloads
+      # Manually download the following and put into the 'downloads' directory next to this compose file
+      #
+      #  Mod                          Filename                                   Download page
+      #  ===========================  =========================================  ====================================================================================
+      #  Fish of Thieves              [Fabric 1.20.1] Fish of Thieves v3.0.3     https://www.curseforge.com/minecraft/mc-mods/fish-of-thieves/files/4958329
+      #  Only Hammers [FORGE/FABRIC]  OnlyHammers-1.20.1-0.6-Fabric              https://www.curseforge.com/minecraft/mc-mods/only-hammers-forge-fabric/files/4832068
+      #  Sprinklerz                   sprinklerz-0.5_fabric.jar                  https://www.curseforge.com/minecraft/mc-mods/sprinklerz/files/4835664
+      #  Frog Legs (Fabric/Forge)     FrogLegs-v2.0.0-1.20.1-Fabric.jar          https://www.curseforge.com/minecraft/mc-mods/froglegs/files/4917818
+      #  TrimsEffects                 [FABRIC] TrimsEffects - MC 1.20.X - 1.1.0  https://www.curseforge.com/minecraft/mc-mods/trimseffects/files/4954156
+      #  Display Case                 Display Case-fabric-1.20-1.0.8.jar         https://www.curseforge.com/minecraft/mc-mods/displaycase/files/4921333
+      #  Structory: Towers            Structory Towers 1.20.4 v1.0.6             https://www.curseforge.com/minecraft/mc-mods/structory-towers/files/4937875
+      #  Packet Fixer                 Packet Fixer Fabric 1.2.1                  https://www.curseforge.com/minecraft/mc-mods/packet-fixer/files/4884316
+      #  Perfect Plushies             Perfect Plushies 1.9.0 [Fabric]            https://www.curseforge.com/minecraft/mc-mods/perfect-plushies/files/4985767
+      #  Structory                    Structory 1.20.2 v1.3.4                    https://www.curseforge.com/minecraft/mc-mods/structory/files/4937872
+
+volumes:
+  mc-data: {}
+

examples/atm9/docker-compose.yml

@@ -0,0 +1,22 @@
+version: "3.8"
+
+services:
+  mc:
+    image: itzg/minecraft-server
+    ports:
+      - "25565:25565"
+    environment:
+      EULA: "true"
+      MOD_PLATFORM: AUTO_CURSEFORGE
+      # allocate from https://console.curseforge.com/ and set in .env file
+      CF_API_KEY: ${CF_API_KEY}
+      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-9
+      # Optional: select a specific version/file
+      #CF_FILENAME_MATCHER: "0.2.34"
+      MEMORY: 4G
+    volumes:
+      - mc-data:/data
+      - ./downloads:/downloads
+
+volumes:
+  mc-data: {}

examples/neoforge/docker-compose.yml

@@ -0,0 +1,14 @@
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      TYPE: NEOFORGE
+      VERSION: latest
+      NEOFORGE_VERSION: beta
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc:/data
+volumes:
+  mc: {}

scripts/start-configuration

@@ -234,6 +234,11 @@ case "${TYPE^^}" in
     exec "${SCRIPTS:-/}start-deployMagma" "$@"
   ;;
 
+  MAGMA_MAINTAINED)
+    evaluateJavaCompatibilityForForge
+    exec "${SCRIPTS:-/}start-deployMagmaMaintained" "$@"
+  ;;
+
   KETTING)
     evaluateJavaCompatibilityForForge
     exec "${SCRIPTS:-/}start-deployKetting" "$@"

scripts/start-deployMagmaMaintained

@@ -0,0 +1,38 @@
+#!/bin/bash
+
+# shellcheck source=start-utils
+. "${SCRIPTS:-/}start-utils"
+isDebugging && set -x
+
+: "${FORGE_VERSION:=}"
+: "${MAGMA_MAINTAINED_TAG:=}"
+
+resolveVersion
+
+if [ -z $MAGMA_MAINTAINED_TAG ]; then
+  log "ERROR the variable MAGMA_MAINTAINED_TAG is not specified"
+  exit 1
+fi
+
+# Magma-1.12.2/releases/download/88659fb/Magma-1.12.2-88659fb-server.jar
+# Magma-1.20.1/releases/download/adec9ce/magma-1.20.1-47.2.17-adec9ce-server.jar
+if [[ ${VERSION} = "1.12.2" ]]; then
+  fileName="Magma-${VERSION}-${MAGMA_MAINTAINED_TAG}-server.jar"
+else
+  if [ -z $FORGE_VERSION ]; then
+    log "ERROR the variable FORGE_VERSION is not specified"
+    exit 1
+  fi
+  fileName="magma-${VERSION}-${FORGE_VERSION}-${MAGMA_MAINTAINED_TAG}-server.jar"
+fi
+downloadUrl="https://github.com/magmamaintained/Magma-${VERSION}/releases/download/${MAGMA_MAINTAINED_TAG}/${fileName}"
+
+if ! SERVER=$(get --output-filename --skip-up-to-date --output /data "$downloadUrl"); then
+  log "ERROR: failed to download Magma Maintained server jar from $downloadUrl"
+  exit 1
+fi
+
+export SERVER
+export FAMILY=HYBRID
+
+exec "${SCRIPTS:-/}start-spiget" "$@"

scripts/start-finalExec

@@ -88,7 +88,7 @@ elif versionLessThan 1.18.1; then
   fi
 fi
 
-if isTrue ${ENABLE_ROLLING_LOGS:-false}; then
+if isTrue "${ENABLE_ROLLING_LOGS:-false}"; then
   if ! ${canUseRollingLogs}; then
     log "ERROR: Using rolling logs is currently not possible in the selected version due to CVE-2021-44228"
     exit 1
@@ -139,7 +139,7 @@ fi
 if isTrue "${USE_AIKAR_FLAGS}"; then
   # From https://mcflags.emc.gs/
 
-  if (( $(normalizeMemSize "${MAX_MEMORY}") >= $(normalizeMemSize 12g) )); then
+  if [[ $MAX_MEMORY ]] && (( $(normalizeMemSize "${MAX_MEMORY}") >= $(normalizeMemSize 12g) )); then
     log "Using Aikar's >12GB flags"
     G1NewSizePercent=40
     G1MaxNewSizePercent=50