Allow embedded comments in newline-comma lists

.github/workflows/verify-pr.yml

@@ -44,7 +44,7 @@ jobs:
             platforms: linux/amd64
             mcVersion: 1.12.2
             # Pin version for Java 8
-            mcHelperVersion: 1.42.1
+#            mcHelperVersion: 1.42.1
     env:
       IMAGE_TO_TEST: ${{ github.repository_owner }}/minecraft-server:test-${{ matrix.variant }}-${{ github.run_id }}
     runs-on: ubuntu-22.04

Dockerfile

@@ -48,7 +48,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.49.2
+ARG MC_HELPER_VERSION=1.50.0
 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

@@ -92,6 +92,16 @@ docker run -it --rm \
   itzg/minecraft-server
 ```
 
+In a compose file, include the volume mount in the `volumes` section of the container definition:
+
+```yaml
+services:
+  mc:
+    # ... usual container definition
+    volumes:
+      - /path/to/mc-image-helper/build/install/mc-image-helper:/usr/share/mc-image-helper:ro
+```
+
 For Go base tools, run
 
 ```shell

docs/requirements.txt

@@ -1,7 +1,7 @@
-mkdocs-material == 9.6.21
-mkdocs-autorefs == 1.4.3
-mkdocstrings[python] == 0.30.1
-mkdocs-literate-nav == 0.6.2
-mdx-gh-links == 0.4
-mkdocs-click == 0.9.0
+mkdocs-material == 9.6.21
+mkdocs-autorefs == 1.4.3
+mkdocstrings[python] == 0.30.1
+mkdocs-literate-nav == 0.6.2
+mdx-gh-links == 0.4
+mkdocs-click == 0.9.0
 mkdocs-static-i18n == 1.3.0

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

@@ -216,6 +216,17 @@ If needing to iterate on the options above, set `CF_FORCE_SYNCHRONIZE` to "true"
 !!! important
     These options are provided to empower you to get your server up and running quickly. Please help out by reporting an issue with the respective mod project. Ideally mod developers should [use correct registrations for one-sided client mods](https://docs.minecraftforge.net/en/latest/concepts/sides/#writing-one-sided-mods). Understandably, those code changes may be non-trivial, so mod authors can also add "Client" to the game versions when publishing.
 
+!!! tip "Embedded comments"
+
+    Comments can be embedded in the list using the `#` character.
+
+    ```yaml
+          CF_EXCLUDE_MODS: |
+            # Exclude client-side mods not published correctly
+            creative-core
+            default-options
+    ```
+
 ## Excluding Overrides Files
 
 Modpack zip files typically include an `overrides` subdirectory that may contain config files, world data, and extra mod files. All of those files will be extracted into the `/data` path of the container. If any of those files, such as incompatible mods, need to be excluded from extraction, then the `CF_OVERRIDES_EXCLUSIONS` variable can be set with a comma or newline delimited list of ant-style paths ([see below](#ant-style-paths)) to exclude, relative to the overrides (or `/data`) directory. 

examples/auto-curseforge/atm10/docker-compose.yml

@@ -18,6 +18,7 @@ services:
       # CF_FILENAME_MATCHER: "1.17"
       MEMORY: 4G
       CF_OVERRIDES_EXCLUSIONS: |
+        # Not applicable for server side
         shaderpacks/**
     volumes:
       # Use managed volume by default, but can change to a relative path like

examples/auto-curseforge/rad2/compose.yaml

@@ -16,6 +16,7 @@ services:
       # Optional: select a specific version/file
       #CF_FILENAME_MATCHER: "0.2.34"
       CF_EXCLUDE_MODS: |
+        # Exclude client-side mods not published correctly
         creative-core
         default-options
         itemphysic-lite
@@ -25,6 +26,7 @@ services:
       MEMORY: 4G
     volumes:
       - mc-data:/data
+      - C:\Users\geoff\git\mc-image-helper\build\install\mc-image-helper:/usr/share/mc-image-helper:ro
 
 volumes:
   mc-data: {}

examples/auto-curseforge/skyfactory5/compose.yml

@@ -1,24 +1,24 @@
-services:
-  mc:
-    image: itzg/minecraft-server
-    environment:
-      EULA: true
-      # https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/
-      MODPACK_PLATFORM: AUTO_CURSEFORGE
-#      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/skyfactory-5/files/6290684
-      CF_SLUG: skyfactory-5
-      # Comment out the following to get the latest version or pick a version from
-      # https://www.curseforge.com/minecraft/modpacks/skyfactory-5/files/all?page=1&pageSize=20
-      CF_FILENAME_MATCHER: 5.0.8
-      # Allocate API key from https://console.curseforge.com/
-      # and set in .env file making sure to double up dollar signs, such as
-      # CF_API_KEY=$$2a$$10$$....
-      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
-      CF_API_KEY: ${CF_API_KEY}
-      MEMORY: 4G
-    ports:
-      - "25565:25565"
-    volumes:
-      - mc-data:/data
-volumes:
-  mc-data:
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      # https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/
+      MODPACK_PLATFORM: AUTO_CURSEFORGE
+#      CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/skyfactory-5/files/6290684
+      CF_SLUG: skyfactory-5
+      # Comment out the following to get the latest version or pick a version from
+      # https://www.curseforge.com/minecraft/modpacks/skyfactory-5/files/all?page=1&pageSize=20
+      CF_FILENAME_MATCHER: 5.0.8
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
+      CF_API_KEY: ${CF_API_KEY}
+      MEMORY: 4G
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+volumes:
+  mc-data:

examples/curseforge-files/docker-compose.yml

@@ -1,18 +1,19 @@
-services:
-  mc:
-    image: itzg/minecraft-server
-    environment:
-      EULA: true
-      TYPE: FORGE
-      # Allocate API key from https://console.curseforge.com/
-      # and set in .env file making sure to double up dollar signs, such as
-      # CF_API_KEY=$$2a$$10$$....
-      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
-      CF_API_KEY: ${CF_API_KEY}
-      VERSION: 1.19.2
-      CURSEFORGE_FILES: |
-        geckolib
-        aquaculture
-        naturalist
-    ports:
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      TYPE: FORGE
+      # Allocate API key from https://console.curseforge.com/
+      # and set in .env file making sure to double up dollar signs, such as
+      # CF_API_KEY=$$2a$$10$$....
+      # Refer to https://docker-minecraft-server.readthedocs.io/en/latest/types-and-platforms/mod-platforms/auto-curseforge/#api-key
+      CF_API_KEY: ${CF_API_KEY}
+      VERSION: 1.19.2
+      CURSEFORGE_FILES: |
+        geckolib # some comment
+        # Removing temporarily
+        #aquaculture
+        naturalist
+    ports:
       - "25565:25565"

examples/modrinth/version-from-modrinth-projects/compose.yml

@@ -1,15 +1,15 @@
-services:
-  mc:
-    image: itzg/minecraft-server
-    environment:
-      EULA: true
-      TYPE: paper
-      MODRINTH_PROJECTS: |
-        viaversion
-        viabackwards
-        griefprevention
-        discordsrv
-      VERSION_FROM_MODRINTH_PROJECTS: true
-      MEMORY: 2G
-    ports:
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      TYPE: paper
+      MODRINTH_PROJECTS: |
+        viaversion
+        viabackwards
+        griefprevention
+        discordsrv
+      VERSION_FROM_MODRINTH_PROJECTS: true
+      MEMORY: 2G
+    ports:
       - "25565:25565"

scripts/start-setupModpack

@@ -312,7 +312,7 @@ function handleCurseForgeFiles() {
   # since we want CURSEFORGE_FILES to expand
   mc-image-helper curseforge-files \
     "${args[@]}" \
-    ${CURSEFORGE_FILES}
+    "${CURSEFORGE_FILES}"
 }
 
 handlePackwiz