2020-10-05 06:05:11 +08:00
< div align = "center" >
2022-08-20 06:19:56 +08:00
< a href = "https://purpurmc.org" >
< img src = "https://user-images.githubusercontent.com/74448585/150906023-101cd383-da82-4a3c-9603-a3b5741c3994.png" alt = "Purpur" >
< / a >
2019-05-13 06:02:15 +08:00
2020-10-05 06:05:11 +08:00
## Purpur
2019-05-13 06:02:15 +08:00
2021-12-04 01:38:43 +08:00
[](LICENSE)
2022-08-20 06:19:56 +08:00
[](https://purpurmc.org/downloads/)
[](https://www.codefactor.io/repository/github/PurpurMC/Purpur)
[](https://purpurmc.org/discord)
2020-10-05 06:05:11 +08:00
2022-08-20 06:19:56 +08:00
[](https://github.com/PurpurMC/Purpur/stargazers)
[](https://github.com/PurpurMC/Purpur/network/members)
[](https://github.com/PurpurMC/Purpur/watchers)
2020-10-05 06:05:11 +08:00
2021-12-04 01:41:31 +08:00
Purpur is a drop-in replacement for [Paper ](https://github.com/PaperMC/Paper ) servers designed for configurability, new fun and exciting gameplay features, and performance built on top of [Paper ](https://github.com/PaperMC/Paper/ ).
2020-10-05 06:05:11 +08:00
< / div >
2019-05-13 06:02:15 +08:00
## Contact
2022-08-20 06:19:56 +08:00
Join us on Discord:
2020-08-15 16:20:15 +08:00
2022-08-20 06:19:56 +08:00
[](https://purpurmc.org/discord)
2020-08-15 16:20:15 +08:00
## Downloads
2021-12-04 01:38:43 +08:00
Downloads can be obtained from the [downloads page ](https://purpurmc.org/downloads/ ) or the [downloads API ](https://api.purpurmc.org ).
2020-12-02 08:20:20 +08:00
2022-08-20 06:19:56 +08:00
[](https://purpurmc.org/downloads/)
2020-12-02 08:20:20 +08:00
Downloads API endpoints:
2021-07-17 07:17:54 +08:00
* List versions of Minecraft with builds available:
2021-12-05 12:35:00 +08:00
`https://api.purpurmc.org/v2/purpur`
2021-07-17 07:17:54 +08:00
* List builds for a version of Minecraft:
2021-12-05 12:35:00 +08:00
`https://api.purpurmc.org/v2/purpur/<version>`
2021-07-17 07:17:54 +08:00
* Download a specific build of a specific version:
2021-12-05 12:35:00 +08:00
`https://api.purpurmc.org/v2/purpur/<version>/<build>/download`
2021-07-17 07:17:54 +08:00
* Download the latest build for a version of Minecraft:
2021-12-05 12:35:00 +08:00
`https://api.purpurmc.org/v2/purpur/<version>/latest/download`
2019-05-13 06:02:15 +08:00
## License
2021-01-10 00:50:13 +08:00
All patches are licensed under the MIT license, unless otherwise noted in the patch headers.
2019-05-13 06:02:15 +08:00
2022-08-20 06:19:56 +08:00
[](LICENSE)
2021-12-04 01:38:43 +08:00
See [PaperMC/Paper ](https://github.com/PaperMC/Paper ), and [PaperMC/Paperweight ](https://github.com/PaperMC/paperweight ) for the license of material used by this project.
2019-05-13 06:02:15 +08:00
2020-03-08 05:24:09 +08:00
## bStats
[](https://bstats.org/plugin/server-implementation/Purpur)
2020-08-15 16:20:15 +08:00
## API
2020-03-07 12:20:30 +08:00
2021-12-04 01:38:43 +08:00
### [Javadoc](https://purpurmc.org/javadoc)
2021-01-08 16:38:51 +08:00
### Dependency Information
Maven
```xml
< repository >
< id > purpur< / id >
2021-12-05 20:20:49 +08:00
< url > https://repo.purpurmc.org/snapshots< / url >
2021-01-08 16:38:51 +08:00
< / repository >
```
2020-12-01 19:59:45 +08:00
```xml
2020-03-07 12:20:30 +08:00
< dependency >
2021-12-04 01:38:43 +08:00
< groupId > org.purpurmc.purpur< / groupId >
2020-03-07 12:20:30 +08:00
< artifactId > purpur-api< / artifactId >
2022-08-06 07:07:02 +08:00
< version > 1.19.2-R0.1-SNAPSHOT< / version >
2020-03-07 12:20:30 +08:00
< scope > provided< / scope >
< / dependency >
```
2020-11-12 08:15:26 +08:00
2021-01-08 16:38:51 +08:00
Gradle
2020-12-18 21:04:33 +08:00
```kotlin
repositories {
2021-12-05 20:20:49 +08:00
maven("https://repo.purpurmc.org/snapshots")
2020-11-12 08:15:26 +08:00
}
```
2020-12-18 21:04:33 +08:00
```kotlin
dependencies {
2022-08-06 07:07:02 +08:00
compileOnly("org.purpurmc.purpur:purpur-api:1.19.2-R0.1-SNAPSHOT")
2020-12-18 21:04:33 +08:00
}
2020-11-12 08:15:26 +08:00
```
2020-03-07 12:20:30 +08:00
Yes, this also includes all API provided by Paper, Spigot, and Bukkit.
2019-05-13 06:02:15 +08:00
## Building and setting up
2020-08-15 16:20:15 +08:00
#### Initial setup
2022-09-06 20:34:28 +08:00
First, < u > clone< / u > this repository. Do not download it.
Then run the following command in the root directory:
2019-05-13 06:02:15 +08:00
```
2020-12-18 21:04:33 +08:00
./gradlew applyPatches
2019-05-13 06:02:15 +08:00
```
2020-03-07 12:20:30 +08:00
2022-09-06 20:34:28 +08:00
The project is now ready for use in your IDE.
2019-05-13 06:02:15 +08:00
#### Creating a patch
Patches are effectively just commits in either `Purpur-API` or `Purpur-Server` .
2020-12-18 21:04:33 +08:00
To create one, just add a commit to either repo and run `./gradlew rebuildPatches` , and a
2019-05-13 06:02:15 +08:00
patch will be placed in the patches folder. Modifying commits will also modify its
corresponding patch file.
2020-08-15 16:20:15 +08:00
See [CONTRIBUTING.md ](CONTRIBUTING.md ) for more detailed information.
2019-05-13 06:02:15 +08:00
2020-08-15 16:20:15 +08:00
#### Compiling
2019-05-13 06:02:15 +08:00
2021-08-12 08:31:31 +08:00
Use the command `./gradlew build` to build the API and server. Compiled JARs
2020-12-18 21:04:33 +08:00
will be placed under `Purpur-API/build/libs` and `Purpur-Server/build/libs` .
2020-03-07 12:20:30 +08:00
2021-12-04 01:38:43 +08:00
To get a purpurclip jar, run `./gradlew createReobfPaperclipJar` .
2021-08-12 08:31:31 +08:00
To install the `purpur-api` and `purpur` dependencies to your local Maven repo, run `./gradlew publishToMavenLocal`
2021-06-18 07:44:32 +08:00
Special Thanks To:
-------------
2022-07-12 21:42:51 +08:00
2022-08-22 06:40:13 +08:00
< table >
< tr >
< td >
### YourKit
2021-06-18 07:44:32 +08:00
2022-08-22 06:40:13 +08:00
[YourKit ](https://www.yourkit.com/ ), makers of the outstanding Java profiler,
2021-06-18 07:44:32 +08:00
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.
2022-08-22 06:40:13 +08:00
< / td >
< td >
2022-07-12 21:42:51 +08:00
### JetBrains
[<img src="https://resources.jetbrains.com/storage/products/company/brand/logos/jb_beam.png" alt="JetBrains Logo" height="75"> ](https://www.jetbrains.com )
[JetBrains ](https://www.jetbrains.com/ ), creators of the IntelliJ IDEA, supports Purpur with one of their [Open Source Licenses ](https://www.jetbrains.com/opensource/ ). IntelliJ IDEA is the recommended IDE for working with Purpur, and most of the Purpur team uses it.
2022-08-22 06:40:13 +08:00
< / td >
< / tr >
< / table >
2022-07-12 21:42:51 +08:00
### Our Contributors
2022-08-22 05:54:46 +08:00
[](https://github.com/PurpurMC/Purpur/graphs/contributors)
2022-07-12 21:42:51 +08:00
### Our Sponsors
2022-08-22 05:54:46 +08:00
[](https://github.com/sponsors/PurpurMC)
2022-08-23 04:52:29 +08:00
### Our Backers
[](https://opencollective.com/purpurmc)
