Skip to content

Home

Purpur Image

MIT License  Download from Jenkins CI  CodeFactor  Join us on Discord 

Purpur's Stargazers  BillyGalbreath's Followers  Purpur Forks  Purpur Watchers 

Welcome to the official documentation source for the Purpur project.

This wiki was last updated to Build #1255 (89c9c9)

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

Contact Discord shield.io🔗

Join us on Discord!

Downloads🔗

Downloads can be obtained from the downloads page, the downloads API, or alternatively, from Pl3x's Jenkins CI Server.

Latest build shortcut links:

Downloads API endpoints:

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

License MIT License🔗

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

See PaperMC/Paper, Spottedleaf/Tuinity, and jpenilla/Toothpick for the license of material used by this project.

bStats🔗

API🔗

Javadoc🔗

https://purpur.pl3x.net/javadoc

Dependency Information🔗

1
2
3
4
<repository>
    <id>purpur</id>
    <url>https://repo.pl3x.net/</url>
</repository>
1
2
3
4
5
6
<dependency>
    <groupId>net.pl3x.purpur</groupId>
    <artifactId>purpur-api</artifactId>
    <version>1.16.5-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

1
2
3
repositories {
    maven("https://repo.pl3x.net/")
}
1
2
3
dependencies {
    compileOnly("net.pl3x.purpur", "purpur-api", "1.16.5-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:

1
./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