README.md

Purpur

Purpur is a drop-in replacement for Paper servers designed for configurability, new fun and exciting gameplay features, and performance built on top of Airplane.

Contact

Join us on Discord

Downloads

Downloads can be obtained from the downloads page or the downloads API.

Latest build shortcut links:

• 1.17.1 builds 1256+
• 1.17 builds 1172-1255
• 1.16.5 builds 957-1171
• 1.16.4 builds 809-956
• 1.16.3 builds 751-808
• 1.16.2 builds 711-750
• 1.16.1 builds 608-710
• 1.15.2 builds 398-606
• 1.15.1 builds 348-397
• 1.15 builds 339-346
• 1.14.x builds 337 and below

Downloads API endpoints:

• List versions of Minecraft with builds available: https://api.pl3x.net/v2/purpur
• List builds for a version of Minecraft: https://api.pl3x.net/v2/purpur/<version>
• Download a specific build of a specific version: https://api.pl3x.net/v2/purpur/<version>/<build>/download
• Download the latest build for a version of Minecraft: https://api.pl3x.net/v2/purpur/<version>/latest/download

License

All patches are licensed under the MIT license, unless otherwise noted in the patch headers.

See PaperMC/Paper, TECHNOVE/Airplane, and PaperMC/Paperweight for the license of material used by this project.

bStats

API

Javadoc

Dependency Information

Maven

<repository>
    <id>purpur</id>
    <url>https://repo.pl3x.net/</url>
</repository>

<dependency>
    <groupId>net.pl3x.purpur</groupId>
    <artifactId>purpur-api</artifactId>
    <version>1.17.1-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

Gradle

repositories {
    maven("https://repo.pl3x.net/")
}

dependencies {
    compileOnly("net.pl3x.purpur", "purpur-api", "1.17.1-R0.1-SNAPSHOT")
}

Yes, this also includes all API provided by Paper, Spigot, and Bukkit.

Building and setting up

Initial setup

Run the following commands in the root directory:

./gradlew applyPatches

Creating a patch

Patches are effectively just commits in either Purpur-API or Purpur-Server. To create one, just add a commit to either repo and run ./gradlew rebuildPatches, and a patch will be placed in the patches folder. Modifying commits will also modify its corresponding patch file.

See CONTRIBUTING.md for more detailed information.

Compiling

Use the command ./gradlew build to build the API and server. Compiled JARs will be placed under Purpur-API/build/libs and Purpur-Server/build/libs.

To get a purpurclip jar, run ./gradlew paperclip. To install the purpur-api and purpur dependencies to your local Maven repo, run ./gradlew publishToMavenLocal

Special Thanks To:

YourKit, makers of the outstanding Java profiler, support open source projects of all kinds with their full featured Java and .NET application profilers. We thank them for allowing us to use their software so we can make Purpur the best it can be.