PaperMC Documentation

Warning

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.

Introduction

Welcome to PaperDocs, the official documentation source for the PaperMC project.

The PaperMC project consists of multiple projects aimed at improving the ecosystem which they serve, most notability, the Paper and Waterfall projects.

Not sure what you’re looking for? Try our About the PaperMC Project section, which contains a short Introduction, our Frequently Asked Questions and an article about The Structure of PaperMC.

Server owners should read our tips and instructions in Paper on how to install, run and maintain a Paper based server.

Running A Server

Running a Paper server is easy. This section will cover common tasks such as configuring it, maintaining plugins, and general best practices.

Running A Network

Waterfall provides a convenient way to connect multiple servers together, allowing you to expand your servers capacity and capabilities.

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:

About Paper

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.

Acknowledgements

https://www.yourkit.com/images/yklogo.png

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.