paperd

Build	Status
Latest Commit
Latest Release

paperd is a wrapper application which enables the PaperMC Minecraft server to be run more properly in the background as a daemon, rather than simply backgrounded using screen or tmux. This is accomplished both by the paperd application and custom changes in the Paper server.

Support and Project Discussion:

• IRC or Discord

Building

paperd is strictly Unix / POSIX compatible. Windows is not supported.

A 64 bit JDK is required to build paperd and a 64 bit JVM is required to use paperd.

This project requires the Rust toolchain. paperd is built on the latest release of Rust, currently version 1.44.1.

To build for your own system with console support:

cargo build --release --features console

If you don't want the console feature, or don't have ncurses installed, simply omit the feature to build without it:

cargo build --release

To build a release binary like the pre-built binaries Jenkins provides, you'll need Docker installed:

./build_release.sh

This will produce a paperd.tar.xz file in the current working directory, which is the file available for download from Jenkins.

Documentation

For general usage instructions, please click here.

For technical info on how paperd works and communicates with the Paper server, please click here.

Contributing

PRs are greatly appreciated, but when a change requires modifications to both this project and to the Paper server itself, please link both PRs together in the PR description.

For this project in particular, please run rustfmt with all default settings across the whole project before committing.

License

This project is licensed under LGPLv3 only, no future versions.