Skip to content

Commit e69ee85

Browse files
IronMineIronMine
authored
#3115 rename MOD_PLATFORM to MODPACK_PLATFORM (#3120)
1 parent bef7b47 commit e69ee85

File tree

27 files changed

+41
-36
lines changed

27 files changed

+41
-36
lines changed

‎docs/mods-and-plugins/index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Working with mods and plugins
22

3-
## Mod platforms
3+
## Modpack platforms
44

5-
By far the easiest way to work with mod and plugins, especially large numbers of them, is to utilize modpacks with [one of the supported mod platforms](../types-and-platforms/index.md).
5+
By far the easiest way to work with mod and plugins, especially large numbers of them, is to utilize modpacks with [one of the supported modpack platforms](../types-and-platforms/index.md).
66

7-
The following are some supported mod platforms:
7+
The following are some supported modpack platforms:
88

99
- [Modrinth](../types-and-platforms/mod-platforms/modrinth-modpacks.md)
1010
- [CurseForge](../types-and-platforms/mod-platforms/auto-curseforge.md)

‎docs/types-and-platforms/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Server Types and Mod Platforms
1+
# Server Types and Modpack Platforms
22

33
Server types can be selected by setting the `TYPE` environment variable to one of the types described in these sections.
44

55
The default server type is [the official software provided by Mojang](https://www.minecraft.net/en-us/download/server), which can be explicitly selected by setting `TYPE` to "VANILLA".
66

77
**From the sections to the left...**
88

9-
The **mod platforms** take a modpack identifier, file, etc and use that to select and download the appropriate version of a mod loader, such as Forge or Fabric, downloading declared mods/plugins, and apply any additional files. The mod platforms are selected by setting `MOD_PLATFORM`; however, for ease of use and compatibility, the selection can be set in `TYPE`.
9+
The **modpack platforms** take a modpack identifier, file, etc and use that to select and download the appropriate version of a mod loader, such as Forge or Fabric, downloading declared mods/plugins, and apply any additional files. The modpack platforms are selected by setting `MODPACK_PLATFORM`; however, for ease of use and backward compatibility, the selection can be set in `TYPE` or `MOD_PLATFORM`.
1010

1111
The individual **server types** allow for selecting the mod loader / server type and specific versions of those.
1212

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Auto CurseForge
22

3-
To manage a CurseForge modpack automatically with upgrade support, pinned or latest version tracking, set `MOD_PLATFORM` or `TYPE` to "AUTO_CURSEFORGE". The appropriate mod loader (Forge / Fabric) version will be automatically installed as declared by the modpack. This mode will also take care of cleaning up unused files installed by previous versions of the modpack, but world data is never auto-removed.
3+
To manage a CurseForge modpack automatically with upgrade support, pinned or latest version tracking, set `MODPACK_PLATFORM`, `MOD_PLATFORM` or `TYPE` to "AUTO_CURSEFORGE". The appropriate mod loader (Forge / Fabric) version will be automatically installed as declared by the modpack. This mode will also take care of cleaning up unused files installed by previous versions of the modpack, but world data is never auto-removed.
44

55
## API Key
66

@@ -116,7 +116,7 @@ If you wish to use an unpublished modpack zip, set the container path to the fil
116116
image: itzg/minecraft-server
117117
environment:
118118
EULA: true
119-
MOD_PLATFORM: AUTO_CURSEFORGE
119+
MODPACK_PLATFORM: AUTO_CURSEFORGE
120120
# allocate from https://console.curseforge.com/ and set in .env file
121121
CF_API_KEY: ${CF_API_KEY}
122122
CF_MODPACK_MANIFEST: /manifests/manifest.json

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
This mod platform type is deprecated. Please use [AUTO_CURSEFORGE](auto-curseforge.md) for new deployments.
66

7-
Enable this server mode by setting `MOD_PLATFORM` or `TYPE` to "CURSEFORGE" along with the following specific variables.
7+
Enable this server mode by setting `MODPACK_PLATFORM`, `MOD_PLATFORM` or `TYPE` to "CURSEFORGE" along with the following specific variables.
88

99
You need to specify a modpack to run, using the `CF_SERVER_MOD` environment
1010
variable. A CurseForge server modpack is available together with its respective

‎docs/types-and-platforms/mod-platforms/ftb.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
!!! note
44
Requires one of the Ubuntu with Hotspot images listed in [the Java versions section](../../versions/java.md).
55

6-
[Feed the Beast application](https://www.feed-the-beast.com/) modpacks are supported by setting `MOD_PLATFORM` or `TYPE` to "FTBA"
6+
[Feed the Beast application](https://www.feed-the-beast.com/) modpacks are supported by setting `MODPACK_PLATFORM`, `MOD_PLATFORM` or `TYPE` to "FTBA"
77

88
!!! note
99
The "A" at the end of "FTBA" is important. The value "FTB" used to be an alias for "CURSEFORGE".

‎docs/types-and-platforms/mod-platforms/modrinth-modpacks.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Modrinth Modpacks
22

3-
[Modrinth Modpacks](https://modrinth.com/modpacks) can automatically be installed along with the required mod loader (Forge or Fabric) by setting `MOD_PLATFORM` or `TYPE` to "MODRINTH". Upgrading (and downgrading) takes care of cleaning up old files and upgrading (and downgrading) the mod loader.
3+
[Modrinth Modpacks](https://modrinth.com/modpacks) can automatically be installed along with the required mod loader (Forge or Fabric) by setting `MODPACK_PLATFORM`, `MOD_PLATFORM` or `TYPE` to "MODRINTH". Upgrading (and downgrading) takes care of cleaning up old files and upgrading (and downgrading) the mod loader.
44

55
## Modpack project
66

‎examples/aof7/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ services:
33
image: itzg/minecraft-server
44
environment:
55
EULA: true
6-
MOD_PLATFORM: AUTO_CURSEFORGE
6+
MODPACK_PLATFORM: AUTO_CURSEFORGE
77
# from .env
88
CF_API_KEY: ${CF_API_KEY}
99
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-of-fabric-7

‎examples/atm8/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services:
55
- "25565:25565"
66
environment:
77
EULA: "true"
8-
MOD_PLATFORM: AUTO_CURSEFORGE
8+
MODPACK_PLATFORM: AUTO_CURSEFORGE
99
# allocate from https://console.curseforge.com/ and set in .env file
1010
CF_API_KEY: ${CF_API_KEY}
1111
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-8

‎examples/atm9/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services:
55
- "25565:25565"
66
environment:
77
EULA: "true"
8-
MOD_PLATFORM: AUTO_CURSEFORGE
8+
MODPACK_PLATFORM: AUTO_CURSEFORGE
99
# allocate from https://console.curseforge.com/ and set in .env file
1010
CF_API_KEY: ${CF_API_KEY}
1111
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/all-the-mods-9

‎examples/auto-cf/modpack-manifest/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ services:
33
image: itzg/minecraft-server
44
environment:
55
EULA: true
6-
MOD_PLATFORM: AUTO_CURSEFORGE
6+
MODPACK_PLATFORM: AUTO_CURSEFORGE
77
# allocate from https://console.curseforge.com/ and set in .env file
88
CF_API_KEY: ${CF_API_KEY}
99
CF_MODPACK_MANIFEST: /manifests/manifest.json

‎examples/auto-cf/using-excludes/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services:
55
- "25565:25565"
66
environment:
77
EULA: "true"
8-
MOD_PLATFORM: AUTO_CURSEFORGE
8+
MODPACK_PLATFORM: AUTO_CURSEFORGE
99
# allocate from https://console.curseforge.com/ and set in .env file
1010
CF_API_KEY: ${CF_API_KEY}
1111
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/minecraft-eternal/files/4102634

‎examples/bettermc/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ services:
33
image: itzg/minecraft-server
44
environment:
55
EULA: true
6-
MOD_PLATFORM: AUTO_CURSEFORGE
6+
MODPACK_PLATFORM: AUTO_CURSEFORGE
77
# Set CF_API_KEY=... in a .env file next to this compose file and don't source control that file
88
CF_API_KEY: ${CF_API_KEY}
99
CF_SLUG: better-mc-fabric-bmc1

‎examples/bmc4/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ services:
33
image: itzg/minecraft-server
44
environment:
55
EULA: true
6-
MOD_PLATFORM: MODRINTH
6+
MODPACK_PLATFORM: MODRINTH
77
MODRINTH_MODPACK: https://modrinth.com/modpack/better-mc-forge-bmc4/version/v32.5
88
MODRINTH_EXCLUDE_FILES: |
99
XaeroPlus

‎examples/modrinth-modpack/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ services:
77
- "25565:25565"
88
environment:
99
EULA: "TRUE"
10-
MOD_PLATFORM: MODRINTH
10+
MODPACK_PLATFORM: MODRINTH
1111
MODRINTH_MODPACK: https://modrinth.com/modpack/cobblemon-fabric/version/1.3.2
1212
# or for auto-upgrading to latest
1313
# MODRINTH_MODPACK: https://modrinth.com/modpack/cobblemon-fabric

‎examples/modrinth/local-modpack/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ services:
33
image: itzg/minecraft-server
44
environment:
55
EULA: true
6-
MOD_PLATFORM: MODRINTH
6+
MODPACK_PLATFORM: MODRINTH
77
# Download the mrpack file from https://modrinth.com/modpack/cobblemon-fabric/version/1.4.1 and place in
88
# modpacks directory next to this compose file.
99
MODRINTH_MODPACK: /modpacks/Cobblemon Modpack [Fabric] 1.4.1.mrpack

‎examples/one-block-modded/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services:
55
- "25565:25565"
66
environment:
77
EULA: "true"
8-
MOD_PLATFORM: AUTO_CURSEFORGE
8+
MODPACK_PLATFORM: AUTO_CURSEFORGE
99
# CF_API_KEY=... must be set in .env file or as environment variable
1010
CF_API_KEY: ${CF_API_KEY}
1111
CF_SLUG: one-block-modded

‎examples/pixelmon/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services:
55
- "25565:25565"
66
environment:
77
EULA: "true"
8-
MOD_PLATFORM: AUTO_CURSEFORGE
8+
MODPACK_PLATFORM: AUTO_CURSEFORGE
99
CF_API_KEY: # allocate from https://console.curseforge.com/
1010
CF_SLUG: the-pixelmon-modpack
1111
CF_FILENAME_MATCHER: "9.1.2"

‎examples/prominence2/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services:
55
- "25565:25565"
66
environment:
77
EULA: "true"
8-
MOD_PLATFORM: AUTO_CURSEFORGE
8+
MODPACK_PLATFORM: AUTO_CURSEFORGE
99
# allocate from https://console.curseforge.com/ and set in .env file
1010
CF_API_KEY: ${CF_API_KEY}
1111
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/prominence-2-rpg

‎examples/rad2/compose.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ services:
66
- "25565:25565"
77
environment:
88
EULA: "true"
9-
MOD_PLATFORM: AUTO_CURSEFORGE
9+
MODPACK_PLATFORM: AUTO_CURSEFORGE
1010
# allocate from https://console.curseforge.com/ and set in .env file
1111
CF_API_KEY: ${CF_API_KEY}
1212
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/roguelike-adventures-and-dungeons-2

‎examples/rlcraft/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ services:
33
image: itzg/minecraft-server:java8-multiarch
44
environment:
55
EULA: true
6-
MOD_PLATFORM: AUTO_CURSEFORGE
6+
MODPACK_PLATFORM: AUTO_CURSEFORGE
77
# Set CF_API_KEY=... in a .env file next to this compose file and don't source control that file
88
CF_API_KEY: ${CF_API_KEY}
99
CF_SLUG: rlcraft

‎examples/valhesia5/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services:
55
- "25565:25565"
66
environment:
77
EULA: "true"
8-
MOD_PLATFORM: AUTO_CURSEFORGE
8+
MODPACK_PLATFORM: AUTO_CURSEFORGE
99
CF_API_KEY: # allocate from https://console.curseforge.com/
1010
CF_FORCE_SYNCHRONIZE: "true"
1111
CF_PAGE_URL: https://www.curseforge.com/minecraft/modpacks/valhelsia-5/files/4429560

‎examples/vault-hunters-1-18-2/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ services:
55
- "25565:25565"
66
environment:
77
EULA: "true"
8-
MOD_PLATFORM: AUTO_CURSEFORGE
8+
MODPACK_PLATFORM: AUTO_CURSEFORGE
99
CF_API_KEY: # allocate from https://console.curseforge.com/
1010
CF_SLUG: vault-hunters-1-18-2
1111
CF_FILENAME_MATCHER: "Update-10.0.0"

‎scripts/start-configuration

+10-5
Original file line numberDiff line numberDiff line change
@@ -158,15 +158,20 @@ then
158158
"${SCRIPTS:-/}start-rconcmds"
159159
fi
160160

161-
: "${MOD_PLATFORM:=}"
161+
: "${MODPACK_PLATFORM:=${MOD_PLATFORM:-}}"
162+
163+
if [[ $MODPACK_PLATFORM && $TYPE ]]; then
164+
logWarning "Avoid setting TYPE and MODPACK_PLATFORM"
165+
fi
166+
162167
case "${TYPE^^}" in
163168
AUTO_CURSEFORGE|MODRINTH|CURSEFORGE|FTB|FTBA)
164-
MOD_PLATFORM="$TYPE"
169+
MODPACK_PLATFORM="$TYPE"
165170
;;
166171
esac
167172

168-
if [[ $MOD_PLATFORM ]]; then
169-
case "${MOD_PLATFORM^^}" in
173+
if [[ $MODPACK_PLATFORM ]]; then
174+
case "${MODPACK_PLATFORM^^}" in
170175
FTB|CURSEFORGE)
171176
exec "${SCRIPTS:-/}start-deployCF" "$@"
172177
;;
@@ -184,7 +189,7 @@ if [[ $MOD_PLATFORM ]]; then
184189
;;
185190

186191
*)
187-
logError "Invalid MOD_PLATFORM: '$MOD_PLATFORM'"
192+
logError "Invalid MODPACK_PLATFORM: '$MODPACK_PLATFORM'"
188193
exit 1
189194
;;
190195
esac

‎scripts/start-deployAutoCF

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ resultsFile=/data/.install-curseforge.env
2626

2727
isDebugging && set -x
2828

29-
ensureRemoveAllModsOff "MOD_PLATFORM=AUTO_CURSEFORGE"
29+
ensureRemoveAllModsOff "MODPACK_PLATFORM=AUTO_CURSEFORGE"
3030

3131
args=(
3232
--results-file="$resultsFile"

‎scripts/start-deployModrinth

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ resultsFile=/data/.install-modrinth.env
1616
: "${MODRINTH_DEFAULT_EXCLUDE_INCLUDES=/image/modrinth-exclude-include.json}"
1717

1818
if [[ ! $MODRINTH_MODPACK ]]; then
19-
logError "MODRINTH_MODPACK must be set when using TYPE/MOD_PLATFORM of MODRINTH"
19+
logError "MODRINTH_MODPACK must be set when using TYPE/MODPACK_PLATFORM/MOD_PLATFORM of MODRINTH"
2020
exit 1
2121
fi
2222

2323
isDebugging && set -x
2424

25-
ensureRemoveAllModsOff "MOD_PLATFORM=MODRINTH"
25+
ensureRemoveAllModsOff "MODPACK_PLATFORM=MODRINTH"
2626

2727
args=(
2828
--results-file="$resultsFile"

‎scripts/start-setupModpack

+1-1
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ handleListings
299299

300300
if [[ $MANIFEST ]]; then
301301
logError "MANIFEST is no longer supported."
302-
logError " Use MOD_PLATFORM=AUTO_CURSEFORGE and CF_MODPACK_MANIFEST instead"
302+
logError " Use MODPACK_PLATFORM=AUTO_CURSEFORGE and CF_MODPACK_MANIFEST instead"
303303
exit 1
304304
fi
305305

‎tests/setuponlytests/auto_curseforge/docker-compose.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ services:
44
environment:
55
EULA: "true"
66
SETUP_ONLY: "TRUE"
7-
MOD_PLATFORM: AUTO_CURSEFORGE
7+
MODPACK_PLATFORM: AUTO_CURSEFORGE
88
CF_API_KEY: ${CF_API_KEY}
99
CF_SLUG: the-pixelmon-modpack
1010
CF_FILENAME_MATCHER: "9.1.2"

0 commit comments

Comments
 (0)