diff --git a/README.md b/README.md index c0ba643e..0c012f9f 100644 --- a/README.md +++ b/README.md @@ -615,8 +615,10 @@ docker run -d --name mc-ftb -e EULA=TRUE \ To manage a CurseForge modpack automatically with upgrade support, pinned or latest version tracking, set `TYPE` to "AUTO_CURSEFORGE". The appropriate mod loader (Forge / Fabric) version will be automatically installed as declared by the modpack. -> **NOTE:** +> **NOTES:** > Be sure to use the appropriate [image tag for the Java version compatible with the modpack](#running-minecraft-server-on-different-java-version). +> +> Most modpacks require a good amount of memory, so it best to set `MEMORY` to at least "4G" since the default is only 1 GB. Use one of the following to specify the modpack to install: diff --git a/examples/atm8/docker-compose.yml b/examples/atm8/docker-compose.yml new file mode 100644 index 00000000..92a0bb9d --- /dev/null +++ b/examples/atm8/docker-compose.yml @@ -0,0 +1,18 @@ +version: "3.8" + +services: + mc: + image: itzg/minecraft-server + ports: + - "25565:25565" + environment: + EULA: "true" + TYPE: AUTO_CURSEFORGE + CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-8 + CF_FILENAME_MATCHER: "1.0.6" + MEMORY: 4G + volumes: + - mc-data:/data + +volumes: + mc-data: {} \ No newline at end of file diff --git a/examples/pixelmon/docker-compose.yml b/examples/pixelmon/docker-compose.yml new file mode 100644 index 00000000..47afd3d6 --- /dev/null +++ b/examples/pixelmon/docker-compose.yml @@ -0,0 +1,18 @@ +version: "3.8" + +services: + mc: + image: itzg/minecraft-server:java8-multiarch + ports: + - "25565:25565" + environment: + EULA: "true" + TYPE: AUTO_CURSEFORGE + CF_SLUG: the-pixelmon-modpack + CF_FILENAME_MATCHER: "9.1.2" + MEMORY: 4G + volumes: + - mc-data:/data + +volumes: + mc-data: {} \ No newline at end of file diff --git a/tests/setuponlytests/auto_curseforge/docker-compose.yml b/tests/setuponlytests/auto_curseforge/docker-compose.yml new file mode 100644 index 00000000..ac9b8607 --- /dev/null +++ b/tests/setuponlytests/auto_curseforge/docker-compose.yml @@ -0,0 +1,16 @@ +version: "3" + +services: + mc: + image: ${IMAGE_TO_TEST:-itzg/minecraft-server} + environment: + EULA: "true" + SETUP_ONLY: "TRUE" + TYPE: AUTO_CURSEFORGE + CF_SLUG: the-pixelmon-modpack + CF_FILENAME_MATCHER: "9.1.2" + # Use the image bundled one to ensure latest is being tested + CF_EXCLUDE_INCLUDE_FILE: /image/cf-exclude-include.json + volumes: + - ./data:/data + diff --git a/tests/setuponlytests/auto_curseforge/verify.sh b/tests/setuponlytests/auto_curseforge/verify.sh new file mode 100644 index 00000000..950cdde9 --- /dev/null +++ b/tests/setuponlytests/auto_curseforge/verify.sh @@ -0,0 +1,2 @@ +mc-image-helper assert fileExists "/data/mods/ExplorersCompass-1.16.5-1.1.2-forge.jar" +mc-image-helper assert fileExists "/data/forge-1.16.5-36.2.34.jar"