Skip to content

Commit afaa4c8

Browse files
authored
Adding inline example of USES_PLUGINS with Cardboard (#3779)
1 parent 43a7e9a commit afaa4c8

File tree

2 files changed

+15
-0
lines changed

2 files changed

+15
-0
lines changed

docs/mods-and-plugins/index.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,18 @@ There are optional volume paths that can be attached to supply content to be cop
2727
`/plugins`
2828
: content in this directory is synchronized into `/data/plugins` for server types that use plugins, [as described above](#mods-vs-plugins). For special cases, the source can be changed by setting `COPY_PLUGINS_SRC` and destination by setting `COPY_PLUGINS_DEST`. If using a mod-based loader, such as Forge or Fabric, but a hybrid mod like [Cardboard](https://modrinth.com/mod/cardboard), then set `USES_PLUGINS` to have the automation utilize `/plugins` mount.
2929

30+
!!! example "Using Cardboard plugins with Fabric"
31+
32+
```yaml
33+
environment:
34+
EULA: "TRUE"
35+
TYPE: "FABRIC"
36+
MODRINTH_PROJECTS: |
37+
fabric-api
38+
cardboard
39+
USES_PLUGINS: true
40+
```
41+
3042
`/mods`
3143
: content in this directory is synchronized into `/data/mods` for server types that use mods, [as described above](#mods-vs-plugins). For special cases, the source can be changed by setting `COPY_MODS_SRC` and destination by setting `COPY_MODS_DEST`.
3244

docs/requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,8 @@ mkdocs-autorefs == 1.4.3
33
mkdocstrings[python] == 0.30.1
44
mkdocs-literate-nav == 0.6.2
55
mdx-gh-links == 0.4
6+
# need to pin for auto reload to work
7+
# see https://github.com/mkdocs/mkdocs/issues/4032
8+
click==8.2.1
69
mkdocs-click == 0.9.0
710
mkdocs-static-i18n == 1.3.0

0 commit comments

Comments
 (0)