From 17d7f012672c929f5e6e2b777a6727071a20e957 Mon Sep 17 00:00:00 2001 From: Geoff Bourne Date: Thu, 16 Jul 2026 17:57:48 -0500 Subject: [PATCH] Corrected the "must" wording for API key with CURSEFORGE_FILES (#4174) --- docs/mods-and-plugins/curseforge-files.md | 2 +- .../mod-platforms/auto-curseforge.md | 11 ++--------- 2 files changed, 3 insertions(+), 10 deletions(-) diff --git a/docs/mods-and-plugins/curseforge-files.md b/docs/mods-and-plugins/curseforge-files.md index 3d68f264..f606fc1d 100644 --- a/docs/mods-and-plugins/curseforge-files.md +++ b/docs/mods-and-plugins/curseforge-files.md @@ -6,7 +6,7 @@ A specific file can be omitted from each reference to allow for auto-selecting t !!! info "CurseForge API key usage" - A CurseForge API key must be allocated and set with `CF_API_KEY` (or `CF_API_KEY_FILE`) [as described here](../types-and-platforms/mod-platforms/auto-curseforge.md#api-key). + A CurseForge API key is _now_ included by this image; however, you can always supply your own instead. A CurseForge API key can be allocated and set with `CF_API_KEY` (or `CF_API_KEY_FILE`) [as described here](../types-and-platforms/mod-platforms/auto-curseforge.md#api-key). ## Project-file references diff --git a/docs/types-and-platforms/mod-platforms/auto-curseforge.md b/docs/types-and-platforms/mod-platforms/auto-curseforge.md index 462a0f13..c6add616 100644 --- a/docs/types-and-platforms/mod-platforms/auto-curseforge.md +++ b/docs/types-and-platforms/mod-platforms/auto-curseforge.md @@ -79,13 +79,11 @@ Pass a page URL to the modpack or a specific file with `CF_PAGE_URL` such as the environment: # ... MODPACK_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-8 ``` ```title="Using docker run" - docker run -e CF_API_KEY=${CF_API_KEY} -e TYPE=AUTO_CURSEFORGE -e CF_PAGE_URL=https://www.curseforge.com/minecraft/modpacks/all-the-mods-8 + docker run -e TYPE=AUTO_CURSEFORGE -e CF_PAGE_URL=https://www.curseforge.com/minecraft/modpacks/all-the-mods-8 ``` Instead of a URL, the modpack slug can be provided as `CF_SLUG`. The slug is the short identifier visible in the URL after "/modpacks/", such as @@ -98,13 +96,11 @@ Instead of a URL, the modpack slug can be provided as `CF_SLUG`. The slug is the environment: # ... MODPACK_PLATFORM: AUTO_CURSEFORGE - # allocate from https://console.curseforge.com/ and set in .env file - CF_API_KEY: ${CF_API_KEY} CF_SLUG: all-the-mods-8 ``` ```title="Using docker run" - docker run -e CF_API_KEY=${CF_API_KEY} -e TYPE=AUTO_CURSEFORGE -e CF_SLUG=all-the-mods-8 + docker run -e TYPE=AUTO_CURSEFORGE -e CF_SLUG=all-the-mods-8 ``` ### Pinning modpack and mod loader versions @@ -148,7 +144,6 @@ By default, AUTO_CURSEFORGE will use the exact modloader version declared by the ```yaml environment: MODPACK_PLATFORM: AUTO_CURSEFORGE - CF_API_KEY: ${CF_API_KEY} CF_SLUG: all-the-mods-8 CF_MOD_LOADER_VERSION: "43.4.22" ``` @@ -197,8 +192,6 @@ If you wish to use an unpublished modpack zip, set the container path to the fil environment: EULA: true MODPACK_PLATFORM: AUTO_CURSEFORGE - # allocate from https://console.curseforge.com/ and set in .env file - CF_API_KEY: ${CF_API_KEY} CF_MODPACK_MANIFEST: /manifests/manifest.json CF_SLUG: "custom" volumes: