Skip to content

Commit 678dda5

Browse files
authored
docs: clarify curseforge listing file and GetBukkit limitation (#3205)
1 parent c3e96f6 commit 678dda5

File tree

3 files changed

+23
-14
lines changed

3 files changed

+23
-14
lines changed

docs/Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
FROM python:3.8
1+
FROM python:3.9
22

33
RUN pip install --upgrade pip
44

docs/mods-and-plugins/curseforge-files.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -22,22 +22,27 @@ The following formats are supported in the list of project-file references:
2222
- Project ID, such as `238222`. _The newest applicable file will be automatically selected._
2323
- Project slug or ID, `:`, and a file ID, such as `jei:4593548` or `238222:4593548`
2424
- Project slug or ID, `@`, and a partial filename, such as `[email protected]`. This option is useful to refer to a version of the mod/plugin rather than looking up the file ID.
25+
- An `@` followed by the **container path** to a listing file
2526

26-
An `@` followed by the container path to a listing file can also be provided as a project-file reference. Each line is processed as a reference where blank lines and comments that start with `#` are ignored.
27+
!!! info "More about listing files"
2728

28-
For example, `CURSEFORGE_FILES` can be set to "@/extras/cf-mods.txt" where the container file `/extras/cf-mods.txt` contains
29-
30-
```text
31-
# This comment is ignored
32-
jei:10.2.1.1005
33-
34-
# This and previous blank line are ignore
35-
geckolib
36-
aquaculture
37-
naturalist
38-
```
29+
Each line in the listing file is processed as one of the references above; however, blank lines and comments that start with `#` are ignored.
30+
31+
Make sure to place the listing file in a mounted directory/volume or declare an appropriate mount for it.
32+
33+
For example, `CURSEFORGE_FILES` can be set to "@/extras/cf-mods.txt", assuming "/extras" has been added to `volumes` section, where the container file `/extras/cf-mods.txt` contains
34+
35+
```text
36+
# This comment is ignored
37+
jei:10.2.1.1005
38+
39+
# This and previous blank line are ignore
40+
geckolib
41+
aquaculture
42+
naturalist
43+
```
3944

40-
!!! tip "Docker Compose"
45+
!!! tip "Multi-line values in Docker Compose"
4146

4247
Making use of the space delimited option, compose file declarations can be organized nicely with a [multi-line string](https://yaml-multiline.info/), such as
4348

docs/types-and-platforms/server-types/bukkit-spigot.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Bukkit/Spigot
22

3+
!!! failure "GetBukkit site no longer supports automated downloads"
4+
5+
The downloads provider <https://getbukkit.org> seems to no longer support automated downloads. As such, it is highly recommended to switch to [Paper](paper.md) instead since it is actively maintained and fully compatible with Bukkit/Spigot plugins.
6+
37
Run a Bukkit/Spigot server type by setting the environment variable `TYPE` to "BUKKIT" or "SPIGOT".
48

59
!!! example

0 commit comments

Comments
 (0)