mirror of
https://github.com/PurpurMC/Purpur.git
synced 2026-02-17 16:37:43 +01:00
131 lines
12 KiB
Markdown
131 lines
12 KiB
Markdown
<div align="center">
|
|
<a href="https://purpur.pl3x.net"><img src="https://repository-images.githubusercontent.com/184300222/14b11480-3303-11eb-8ca4-ea5711d942fb" alt="Purpur"></a>
|
|
|
|
## Purpur
|
|
|
|
[](License)
|
|
[](https://ci.pl3x.net/job/Purpur)
|
|
[](https://www.codefactor.io/repository/github/pl3xgaming/purpur)
|
|
[](https://discord.gg/mtAAnkk)
|
|
|
|
[](https://github.com/pl3xgaming/Purpur/stargazers)
|
|
[](https://github.com/BillyGalbreath?tab=followers)
|
|
[](https://github.com/pl3xgaming/Purpur/network/members)
|
|
[](https://github.com/pl3xgaming/Purpur/watchers)
|
|
|
|
Purpur is a drop-in replacement for [Paper](https://github.com/PaperMC/Paper) servers designed for configurability, new fun and exciting gameplay features, and high performance built on top of [Tuinity](https://github.com/Spottedleaf/Tuinity).
|
|
|
|
</div>
|
|
|
|
## Contact
|
|
[](https://discord.gg/mtAAnkk)
|
|
|
|
Join us on [Discord](https://discord.gg/mtAAnkk)
|
|
|
|
## Downloads
|
|
[](https://ci.pl3x.net/job/Purpur)
|
|
|
|
Downloads can be obtained from the [downloads page](https://purpur.pl3x.net/downloads/), the downloads API, or alternatively, from Pl3x's [Jenkins CI Server](https://ci.pl3x.net/job/Purpur/).
|
|
|
|
Latest build shortcut links:
|
|
* [1.16.5](https://purpur.pl3x.net/api/v1/purpur/1.16.5/latest/download) builds 957+
|
|
* [1.16.4](https://purpur.pl3x.net/api/v1/purpur/1.16.4/latest/download) builds 809-956
|
|
* [1.16.3](https://purpur.pl3x.net/api/v1/purpur/1.16.3/latest/download) builds 751-808
|
|
* [1.16.2](https://purpur.pl3x.net/api/v1/purpur/1.16.2/latest/download) builds 711-750
|
|
* [1.16.1](https://purpur.pl3x.net/api/v1/purpur/1.16.1/latest/download) builds 608-710
|
|
* [1.15.2](https://purpur.pl3x.net/api/v1/purpur/1.15.2/latest/download) builds 398-606
|
|
* [1.15.1](https://purpur.pl3x.net/api/v1/purpur/1.15.1/latest/download) builds 348-397
|
|
* [1.15](https://purpur.pl3x.net/api/v1/purpur/1.15/latest/download) builds 339-346
|
|
* [1.14.x](https://purpur.pl3x.net/api/v1/purpur/1.14.4/latest/download) builds 337 and below
|
|
|
|
|
|
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
|
|
[](License)
|
|
|
|
All patches are licensed under the MIT license, unless otherwise noted in the patch headers.
|
|
|
|
See [PaperMC/Paper](https://github.com/PaperMC/Paper), [Tuinity/Tuinity](https://github.com/Tuinity/Tuinity), and [jpenilla/Toothpick](https://github.com/jpenilla/Toothpick) for the license of material used by this project.
|
|
|
|
## bStats
|
|
|
|
[](https://bstats.org/plugin/server-implementation/Purpur)
|
|
|
|
|
|
## API
|
|
|
|
### [Javadoc](https://purpur.pl3x.net/javadoc)
|
|
|
|
### Dependency Information
|
|
Maven
|
|
```xml
|
|
<repository>
|
|
<id>purpur</id>
|
|
<url>https://repo.pl3x.net/</url>
|
|
</repository>
|
|
```
|
|
```xml
|
|
<dependency>
|
|
<groupId>net.pl3x.purpur</groupId>
|
|
<artifactId>purpur-api</artifactId>
|
|
<version>1.16.5-R0.1-SNAPSHOT</version>
|
|
<scope>provided</scope>
|
|
</dependency>
|
|
```
|
|
|
|
Gradle
|
|
```kotlin
|
|
repositories {
|
|
maven("https://repo.pl3x.net/")
|
|
}
|
|
```
|
|
```kotlin
|
|
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:
|
|
|
|
```
|
|
./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](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](https://www.yourkit.com/), makers of the outstanding java profiler,
|
|
support open source projects of all kinds with their full featured [Java](https://www.yourkit.com/java/profiler)
|
|
and [.NET](https://www.yourkit.com/.net/profiler) application profilers. We thank them for allowing us to use their
|
|
software so we can make Purpur the best it can be.
|
|
|