Skip to content

About these docs

The FeatherMC docs are built on the PaperMC documentation, which is published by the PaperMC project. FeatherMC is a fork of Paper and includes everything from Paper, so the administration and development guides apply to it.

  • The guides were rebranded for FeatherMC, including the download, update and migration instructions.
  • Links to PaperMC’s support channels were replaced with the FeatherMC repository. Guides for Velocity, Waterfall, Folia and Adventure, and the contributing guide, were left out. Links to them point to the PaperMC docs.
  • The theme, logo and navigation were replaced, and the FeatherMC pages were added: the feather.yml reference, the changed defaults, the compatibility contract and the migration guide from Paper.
  • Version numbers in code examples are fixed values instead of being looked up when the site is built.

Configuration names, file names, API names and package names keep their Paper spelling, because FeatherMC uses them unchanged.

The documentation content adapted from PaperMC is licensed under CC BY-SA 4.0, and so are the changes made here. Components and build code copied from the PaperMC docs repository are under the BSD 2-Clause license. Copyright of the original material belongs to PaperMC. See the NOTICE file that comes with the docs source for details.

Adapted from the PaperMC docs (CC BY-SA 4.0). About these docs.