From 5e519899fa7ad40a1a1768195decac4ad8e00bdf Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Thu, 26 Jan 2023 17:28:06 -0600 Subject: [PATCH] Improve docs for file reference options for AUTO_CURSEFORGE --- README.md | 14 ++++++++++--- .../vault-hunters-1-18-2/docker-compose.yml | 18 ++++++++++++++++ files/cf-exclude-include.json | 21 ++++++++++--------- 3 files changed, 40 insertions(+), 13 deletions(-) create mode 100644 examples/vault-hunters-1-18-2/docker-compose.yml diff --git a/README.md b/README.md index 6b67473459e..9360048bd20 100644 --- a/README.md +++ b/README.md @@ -637,13 +637,21 @@ For example: -e TYPE=AUTO_CURSEFORGE -e CF_SLUG=all-the-mods-8 ``` -With either the modpack page or slug approach, the latest file will be located and used. If a specific version is desired, set either `CF_FILE_ID` to the numerical file ID or use a matching substring with `CF_FILENAME_MATCHER`. +The latest file will be located and used by default, but if a specific version is desired you can use one of the following options. With any of these options **do not select a server file** -- they lack the required manifest and defeat the ability to consistently automate startup. -The file ID can be located in the URL like +- Use `CF_PAGE_URL`, but include the full URL to a specific file +- Set `CF_FILE_ID` to the numerical file ID +- Specify a substring to match the desired filename with `CF_FILENAME_MATCHER` + +The following shows where to get the URL to the specific file and also shows where the file ID is located: ![cf-file-id](docs/cf-file-id.png) -The following two examples both refer to version 1.0.7 of ATM8: +The following examples all refer to version 1.0.7 of ATM8: + +``` +-e TYPE=AUTO_CURSEFORGE -e CF_PAGE_URL=https://www.curseforge.com/minecraft/modpacks/all-the-mods-8/files/4248390 +``` ``` -e TYPE=AUTO_CURSEFORGE -e CF_SLUG=all-the-mods-8 -e CF_FILE_ID=4248390 diff --git a/examples/vault-hunters-1-18-2/docker-compose.yml b/examples/vault-hunters-1-18-2/docker-compose.yml new file mode 100644 index 00000000000..a9e7b15e9db --- /dev/null +++ b/examples/vault-hunters-1-18-2/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_SLUG: vault-hunters-1-18-2 + CF_FILENAME_MATCHER: "Update-6H" + MEMORY: 4G + volumes: + - mc-data:/data + +volumes: + mc-data: {} \ No newline at end of file diff --git a/files/cf-exclude-include.json b/files/cf-exclude-include.json index 09bb906ddca..58531d3e967 100644 --- a/files/cf-exclude-include.json +++ b/files/cf-exclude-include.json @@ -1,19 +1,20 @@ { "globalExcludes": [ - "oculus", - "extreme-sound-muffler", + "carry-on", + "defensive-measures", + "entity-texture-features-fabric", "entityculling", + "extreme-sound-muffler", + "ignitioncoil", + "legendary-tooltips", + "nekos-enchanted-books", + "not-enough-animations", + "oculus", "rubidium", - "textrues-rubidium-options", "rubidium-extra", - "nekos-enchanted-books", "skin-layers-3d", - "not-enough-animations", - "entity-texture-features-fabric", - "carry-on", - "ignitioncoil", - "defensive-measures", - "legendary-tooltips" + "textrues-rubidium-options", + "torohealth-damage-indicators" ], "modpacks": { "all-of-fabric-6": {