docs: clarify Fabric docs TYPE usage (#3387)

Dockerfile

@@ -50,7 +50,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.41.2
+ARG MC_HELPER_VERSION=1.41.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/mods-and-plugins/index.md

@@ -16,7 +16,9 @@ On the left, there are sections describing some download automation options.
 
 ## Mods vs Plugins
 
-The terms "mods" and "plugins" can be quite confusing. Generally, the rule of thumb is that "mods" are used by the types that run client side to modify rendering, add new blocks, and add behaviors server, such as [Forge](../types-and-platforms/server-types/forge.md) and [Fabric](../types-and-platforms/server-types/fabric.md). "Plugins" are used by the types that **only run on servers** to add behaviors, commands, etc such as [Paper](../types-and-platforms/server-types/paper.md) (which derives from [Bukkit/Spigot](../types-and-platforms/server-types/bukkit-spigot.md)). There are also some types that are [hybrids](../types-and-platforms/server-types/hybrids.md), such as Magma, that use both "mods" and "plugins"
+The terms "mods" and "plugins" can be quite confusing. Generally, the rule of thumb is that "mods" are used by the types that run client side to modify rendering, add new blocks, and add behaviors server, such as [Forge](../types-and-platforms/server-types/forge.md) and [Fabric](../types-and-platforms/server-types/fabric.md). "Plugins" are used by the types that **only run on servers** to add behaviors, commands, etc such as [Paper](../types-and-platforms/server-types/paper.md) (which derives from [Bukkit/Spigot](../types-and-platforms/server-types/bukkit-spigot.md)). There are also some types that are [hybrids](../types-and-platforms/server-types/hybrids.md), such as Magma, that use both "mods" and "plugins".
+
+Typically, mods needs to be installed in both the client and server; however, there are some cases when only the server needs a mod. Plugins only need to be installed in the server and are never needed in the client.
 
 ## Optional plugins, mods, and config attach points
 
@@ -41,8 +43,28 @@ For example: `-e REMOVE_OLD_MODS=TRUE -e REMOVE_OLD_MODS_INCLUDE="*.jar" -e REMO
 
 These paths work well if you want to have a common set of modules in a separate location, but still have multiple worlds with different server requirements in either persistent volumes or a downloadable archive.
 
-!!! information ""
-    For more flexibility with mods/plugins preparation, you can declare other directories, files, and URLs to use in [the `MODS` / `PLUGINS` variables](#modsplugins-list).
+!!! information "Multiple source directories"
+
+    `COPY_PLUGINS_SRC`, `COPY_MODS_SRC`, `COPY_CONFIG_SRC` can each be set to a comma or newline delimited list of container directories to reference.
+
+    For example, in a compose file:
+    
+    ```yaml
+        environment:
+          # ...EULA, etc
+          TYPE: PAPER
+          # matches up to volumes declared below
+          COPY_PLUGINS_SRC: /plugins-common,/plugins-local
+        volumes:
+          - mc-data:/data
+          # For example, reference a shared directory used by several projects
+          - ../plugins-common:/plugins-common:ro
+          # and add plugins unique to this project
+          - ./plugins:/plugins-local:ro
+    ```
+
+    Alternatively, you can declare other directories along with files and URLs to use in [the `MODS` / `PLUGINS` variables](#modsplugins-list).
+
 
 
 ## Zip file modpack

docs/mods-and-plugins/modrinth.md

@@ -13,14 +13,14 @@
   
   To select a datapack from a Modrinth project, prefix the entry with "datapack:". When running a vanilla server, this is optional since only datapacks will be available for vanilla servers to select.
         
-  | Description                     | Example projects entry     |
-  |---------------------------------|----------------------------|
-  | Select latest version           | `fabric-api`               |
-  | Select specific version         | `fabric-api:PbVeub96`      |
-  | Select latest beta version      | `fabric-api:beta`          |
-  | Latest version using project ID | `P7dR8mSH`                 |
-  | Latest version of datapack      | `datapack:terralith`       |
-  | Specific version of datapack    | `datapack:terralith:2.5.5` |
+  | Description                     | Example projects entry                                |
+  |---------------------------------|-------------------------------------------------------|
+  | Select latest version           | `fabric-api`                                          |
+  | Select specific version         | `fabric-api:bQZpGIz0`<br/>`fabric-api:0.119.2+1.21.4` |
+  | Select latest beta version      | `fabric-api:beta`                                     |
+  | Latest version using project ID | `P7dR8mSH`                                            |
+  | Latest version of datapack      | `datapack:terralith`                                  |
+  | Specific version of datapack    | `datapack:terralith:2.5.5`                            |
 
 ## Extra options
 

docs/requirements.txt

@@ -1,7 +1,7 @@
-mkdocs-material == 9.6.8
+mkdocs-material == 9.6.10
 mkdocs-autorefs == 1.4.1
-mkdocstrings[python] == 0.29.0
-mkdocs-literate-nav == 0.6.1
+mkdocstrings[python] == 0.29.1
+mkdocs-literate-nav == 0.6.2
 mdx-gh-links == 0.4
 mkdocs-click == 0.8.1
 mkdocs-static-i18n == 1.3.0

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

@@ -1,21 +1,45 @@
-Enable [Fabric server](https://fabricmc.net/) mode by adding a `-e TYPE=FABRIC` to your command-line.
+A [Fabric server](https://fabricmc.net/) can be automatically downloaded, upgraded, and run by setting the environment variable TYPE to "FABRIC"
 
-```
-docker run -d -v /path/on/host:/data \
-    -e TYPE=FABRIC \
-    -p 25565:25565 -e EULA=TRUE --name mc itzg/minecraft-server
-```
+!!! example
+
+    Using `docker run` command line
+
+    ```
+    docker run -d -e EULA=TRUE -e TYPE=FABRIC -p 25565:25565 itzg/minecraft-server
+    ```
+    
+    In a compose file service:
+    
+    ```yaml
+    environment:
+      EULA: TRUE
+      TYPE: FABRIC
+    ```
 
 By default, the container will install the latest [fabric server launcher](https://fabricmc.net/use/server/), using the latest [fabric-loader](https://fabricmc.net/wiki/documentation:fabric_loader) against the minecraft version you have defined with `VERSION` (defaulting to the latest vanilla release of the game).
 
 A specific loader or launcher version other than the latest can be requested using `FABRIC_LOADER_VERSION` and `FABRIC_LAUNCHER_VERSION` respectively, such as:
 
-```
-docker run -d -v /path/on/host:/data ... \
-    -e TYPE=FABRIC \
-    -e FABRIC_LAUNCHER_VERSION=0.10.2 \
-    -e FABRIC_LOADER_VERSION=0.13.1
-```
+!!! example "Using launcher and loader versions"
+
+    With docker run
+
+    ```
+    docker run -d ... \
+        -e TYPE=FABRIC \
+        -e FABRIC_LAUNCHER_VERSION=0.10.2 \
+        -e FABRIC_LOADER_VERSION=0.13.1
+    ```
+    
+    In a compose file service:
+    
+    ```yaml
+    environment:
+      EULA: TRUE
+      TYPE: FABRIC
+      FABRIC_LAUNCHER_VERSION: 0.10.2
+      FABRIC_LOADER_VERSION: 0.13.1
+    ```
 
 !!! note
 

examples/bmc4/compose.yml

@@ -1,20 +1,20 @@
-services:
-  mc:
-    image: itzg/minecraft-server
-    environment:
-      EULA: true
-      MODPACK_PLATFORM: MODRINTH
-      MODRINTH_MODPACK: https://modrinth.com/modpack/better-mc-forge-bmc4/version/v32.5
-      MODRINTH_EXCLUDE_FILES: |
-        XaeroPlus
-        XaerosWorldMap
-      MODRINTH_OVERRIDES_EXCLUSIONS: |
-        mods/citresewn-*.jar
-        **/datapacks/BE_default_endgen_fix*
-      MODRINTH_FORCE_SYNCHRONIZE: true
-      MEMORY: 4G
-    ports:
-      - "25565:25565"
-    # declare /data volume mapping as desired
-#    volumes:
-#      - ./data:/data
+services:
+  mc:
+    image: itzg/minecraft-server
+    environment:
+      EULA: true
+      MODPACK_PLATFORM: MODRINTH
+      # NOTE: v36 doesn't startup correctly
+      MODRINTH_MODPACK: https://modrinth.com/modpack/better-mc-forge-bmc4/version/v34.5
+      MODRINTH_OVERRIDES_EXCLUSIONS: |
+        config/paxi/datapacks/BE_default_endgen_fix*
+      MODRINTH_FORCE_SYNCHRONIZE: true
+      MEMORY: 4G
+    ports:
+      - "25565:25565"
+    volumes:
+      - mc-data:/data
+      # or use a host directory binding
+#      - ./data:/data
+volumes:
+  mc-data:

examples/paper/compose.yml

@@ -1,16 +1,16 @@
 services:
   mc:
     image: itzg/minecraft-server
-    container_name: paper
+    tty: true
+    stdin_open: true
     environment:
       EULA: "true"
       TYPE: PAPER
-      VIEW_DISTANCE: 10
       MEMORY: 2G
     ports:
       - "25565:25565"
     volumes:
-      - mc-paper:/data
+      - mc-data:/data
     restart: unless-stopped
 volumes:
-  mc-paper: {}
+  mc-data: {}

scripts/start-configuration

@@ -38,8 +38,8 @@ if [ ! -e /data/eula.txt ]; then
     log ""
     logError "Please accept the Minecraft EULA at"
     logError "  https://account.mojang.com/documents/minecraft_eula"
-    logError "by setting the container environment variable "
-    logError "EULA to \"true\""
+    logError "by adding the following immediately after 'docker run':"
+    logError "  -e EULA=TRUE"
     log ""
     exit 1
   fi
@@ -285,4 +285,4 @@ case "${TYPE^^}" in
       exit 1
   ;;
 
-esac
+esac

scripts/start-setupMounts

@@ -38,7 +38,7 @@ function mc-image-helper-mounts(){
 : "${COPY_PLUGINS_SRC:="/plugins"}"
 : "${COPY_PLUGINS_DEST:=${PLUGINS_OUT_DIR}}"
 
-if usesPlugins && [ -d "${COPY_PLUGINS_SRC}" ]; then
+if usesPlugins; then
   mkdir -p "${COPY_PLUGINS_DEST}"
   log "Copying any plugins from ${COPY_PLUGINS_SRC} to ${COPY_PLUGINS_DEST}"
   mc-image-helper-mounts "${COPY_PLUGINS_SRC}" "${COPY_PLUGINS_DEST}"
@@ -47,7 +47,7 @@ fi
 : "${COPY_MODS_SRC:="/mods"}"
 : "${COPY_MODS_DEST:=${MODS_OUT_DIR}}"
 
-if usesMods && [ -d "${COPY_MODS_SRC}" ]; then
+if usesMods; then
   log "Copying any mods from ${COPY_MODS_SRC} to ${COPY_MODS_DEST}"
   mc-image-helper-mounts "${COPY_MODS_SRC}" "${COPY_MODS_DEST}"
 fi
@@ -55,9 +55,7 @@ fi
 : "${COPY_CONFIG_SRC:="/config"}"
 : "${COPY_CONFIG_DEST:="/data/config"}"
 
-if [ -d "${COPY_CONFIG_SRC}" ]; then
-  log "Copying any configs from ${COPY_CONFIG_SRC} to ${COPY_CONFIG_DEST}"
-  mc-image-helper-mounts "${COPY_CONFIG_SRC}" "${COPY_CONFIG_DEST}"
-fi
+log "Copying any configs from ${COPY_CONFIG_SRC} to ${COPY_CONFIG_DEST}"
+mc-image-helper-mounts "${COPY_CONFIG_SRC}" "${COPY_CONFIG_DEST}"
 
 exec "${SCRIPTS:-/}start-setupServerProperties" "$@"