plazmamc / purpur Goto Github PK

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 Paper.

Join us on Discord:

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

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

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

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.20.6-R0.1-SNAPSHOT</version>
    <scope>provided</scope>
</dependency>

Gradle

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

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

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

First, clone this repository. Do not download it.

Then run the following command in the root directory:

./gradlew applyPatches

The project is now ready for use in your IDE.

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.

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. These JARs are not used to start a server.

To compile a server-ready purpurclip jar, run ./gradlew createMojmapBundlerJar. To install the purpur-api and purpur dependencies to your local Maven repo, run ./gradlew publishToMavenLocal. The compiled purpurclip jar will be in build/libs/ not Purpur-Server/build/libs.