Skip to content

Document Folia support requirement in plugin.yml #742

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
zlataovce merged 5 commits into from
Mar 10, 2026
Merged

Document Folia support requirement in plugin.yml #742

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2455ce3
Document Folia support requirement in plugin.yml
Chamogelastos Mar 8, 2026
6588c21
Update isFoliaSupported to folia-supported in docs
Chamogelastos Mar 8, 2026
bfbb30b
Update src/content/docs/paper/dev/api/folia-support.md
Chamogelastos Mar 8, 2026
f102236
Update src/content/docs/paper/dev/api/folia-support.md
Chamogelastos Mar 8, 2026
c93d800
chore: stress the importance of developing with Folia in mind
zlataovce Mar 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions src/content/docs/paper/dev/api/folia-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ slug: paper/dev/folia-support
[Folia](https://github.com/PaperMC/Folia) is a fork of Paper, which is currently maintained by the PaperMC team.
It adds the ability to split the world into regions as outlined [here](/folia/reference/overview) in more depth.

# Add Folia support
Comment thread
Chamogelastos marked this conversation as resolved.
Outdated

Plugins can't run on Folia if you don't have this field in your paper-plugin.yml (or plugin.yml, respectively)
Comment thread
Chamogelastos marked this conversation as resolved.
Outdated
```yaml
isFoliaSupported: true
Comment thread
zlataovce marked this conversation as resolved.
Outdated
```

# Checking for Folia

Depending on what platform your plugin is running on, you may need to implement features differently. For this, you can
Expand Down