Welcome to the official documentation source for the Purpur project.
Purpur is a drop-in replacement for Paper servers that's designed for configurability, and new fun and exciting gameplay features.
Join us on Discord!
Downloads API endpoints:
- List versions of Minecraft with builds available:
- List builds for a version of Minecraft:
- Download a specific build of a specific version:
- Download the latest build for a version of Minecraft:
This project licenses all patches under the MIT license, unless the patch headers note otherwise.
See PaperMC/Paper for the license of material this project uses.
1 2 3 4
1 2 3 4 5 6
1 2 3
1 2 3
Yes, this also includes all APIs provided by Pufferfish, Paper, Spigot, and Bukkit.
Building and setting up🔗
Run the following commands in the root directory:
Creating a patch🔗
Patches are effectively just commits in either
To create one, just add a commit to either repo and run
./gradlew rebuildPatches, and Gradle will
place a patch in the patches folder. Modifying commits will also modify their
corresponding patch file(s).
See CONTRIBUTING.md for more detailed information.
Use the command
./gradlew build to build the api and server. Gradle will place compiled jars
To get a purpurclip jar, run
To install the
purpur dependencies to your local maven repo, run