Home

     

     

Welcome to the official documentation source for the Purpur project.

This wiki was last updated to Build #1566 (133b3e1)

Purpur is a drop-in replacement for Paper servers designed for configurability, and new fun and exciting gameplay features.

Contact

Join us on Discord!

Downloads

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

Downloads API endpoints:

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

License

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

See PaperMC/Paper for the license of material used by this project.

bStats

API

Javadoc

https://purpurmc.org/javadoc

Dependency Information

Maven

<repository>
    <id>purpur</id>
    <url>https://repo.purpurmc.org/snapshots</url>
</repository>

<dependency>
    <groupId>org.purpurmc.purpur</groupId>
    <artifactId>purpur-api</artifactId>
    <version>1.18.2-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

Gradle

repositories {
    maven("https://repo.purpurmc.org/snapshots")
}

dependencies {
    compileOnly("org.purpurmc.purpur", "purpur-api", "1.18.2-R0.1-SNAPSHOT")
}

Yes, this also includes all API provided by Pufferfish, 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