Skip to content

Commit 6da747a

Browse files
feat(folia): document Folia support requirement in plugin.yml (#742)
* Document Folia support requirement in plugin.yml Added instructions for enabling Folia support in plugins. * Update isFoliaSupported to folia-supported in docs * Update src/content/docs/paper/dev/api/folia-support.md Co-authored-by: Matouš Kučera <mk@kcra.me> * Update src/content/docs/paper/dev/api/folia-support.md Co-authored-by: Matouš Kučera <mk@kcra.me> * chore: stress the importance of developing with Folia in mind --------- Co-authored-by: Matouš Kučera <mk@kcra.me>
1 parent c18fbc0 commit 6da747a

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/content/docs/paper/dev/api/folia-support.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,20 @@ slug: paper/dev/folia-support
99
[Folia](https://github.com/PaperMC/Folia) is a fork of Paper, which is currently maintained by the PaperMC team.
1010
It adds the ability to split the world into regions as outlined [here](/folia/reference/overview) in more depth.
1111

12+
# Mark plugin as supported on Folia
13+
14+
Plugins can't run on Folia if you don't have this field in your paper-plugin.yml (or plugin.yml, respectively):
15+
```yaml
16+
folia-supported: true
17+
```
18+
19+
:::danger
20+
21+
Marking a plugin as supported on Folia is *not nearly enough* to support Folia.
22+
You must specially develop your plugin with the intent of supporting Folia, keeping things mentioned on this page in mind.
23+
24+
:::
25+
1226
# Checking for Folia
1327
1428
Depending on what platform your plugin is running on, you may need to implement features differently. For this, you can

0 commit comments

Comments
 (0)