This documentation is a work in progress. Some things are still missing. If you'd like to see it completed faster, you can contribute to the documentation here.
Welcome to PaperDocs, the official documentation source for the PaperMC project.
Paper is a high performance fork of the Spigot Minecraft Server that aims to fix gameplay and mechanics inconsistencies as well as to improve performance.
Paper contains numerous features, bug fixes, exploit preventions and major performance improvements not found in Spigot.
Server owners should read our tips and instructions in :doc:`server/index` on how to install, run and maintain a Paper based server.
The PaperMC project has several main components. Learn more about the project structure :doc:`here <about/structure>`.
Running A Paper Server
Running a Paper server is easy. This section will cover common tasks such as configuring it, maintaining plugins, and general best practices.
.. toctree:: :maxdepth: 3 :titlesonly: server/index
Running A Waterfall or Travertine Proxy
Running a Waterfall or Travertine proxy is also easy. This section will cover common tasks such as configuring it, maintaining plugins, and general best practices.
.. toctree:: :maxdepth: 3 :titlesonly: waterfall/index
Contributing to Paper
It's great to see new contributors to the project! Here are some documents which provide further information to get you started:
.. toctree:: :maxdepth: 3 :titlesonly: contributing/index
Paper is a fork of Spigot with certain goals in mind. The following links explain more about the purpose, rationale and structure of the PaperMC project.
.. toctree:: :maxdepth: 3 :titlesonly: about/index site/index
.. toctree:: :maxdepth: 2 :titlesonly:
YourKit, makers of the outstanding java profiler, support open source projects of all kinds with their fully featured Java and .NET application profilers. We thank them for granting Paper an OSS license so that we can make our software the best it can be.