mirror of
https://github.com/PurpurMC/Purpur.git
synced 2026-02-17 16:37:43 +01:00
137 lines
5.6 KiB
Markdown
137 lines
5.6 KiB
Markdown
<div align="center">
|
|
<a href="https://purpurmc.org"><img src="https://user-images.githubusercontent.com/74448585/150906023-101cd383-da82-4a3c-9603-a3b5741c3994.png" alt="Purpur"></a>
|
|
|
|
## Purpur
|
|
|
|
[](LICENSE)
|
|
[](https://purpurmc.org/downloads/)
|
|
[](https://www.codefactor.io/repository/github/PurpurMC/purpur)
|
|
[](https://purpurmc.org/discord)
|
|
|
|
[](https://github.com/PurpurMC/Purpur/stargazers)
|
|
[](https://github.com/PurpurMC/Purpur/network/members)
|
|
[](https://github.com/PurpurMC/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 performance built on top of [Paper](https://github.com/PaperMC/Paper/).
|
|
|
|
</div>
|
|
|
|
## Contact
|
|
[](https://discord.gg/mtAAnkk)
|
|
|
|
Join us on [Discord](https://discord.gg/mtAAnkk)
|
|
|
|
## Downloads
|
|
[](https://purpurmc.org/downloads)
|
|
|
|
Downloads can be obtained from the [downloads page](https://purpurmc.org/downloads/) or the [downloads API](https://api.purpurmc.org).
|
|
|
|
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
|
|
[](LICENSE)
|
|
|
|
All patches are licensed under the MIT license, unless otherwise noted in the patch headers.
|
|
|
|
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.
|
|
|
|
## bStats
|
|
|
|
[](https://bstats.org/plugin/server-implementation/Purpur)
|
|
|
|
|
|
## API
|
|
|
|
### [Javadoc](https://purpurmc.org/javadoc)
|
|
|
|
### Dependency Information
|
|
Maven
|
|
```xml
|
|
<repository>
|
|
<id>purpur</id>
|
|
<url>https://repo.purpurmc.org/snapshots</url>
|
|
</repository>
|
|
```
|
|
```xml
|
|
<dependency>
|
|
<groupId>org.purpurmc.purpur</groupId>
|
|
<artifactId>purpur-api</artifactId>
|
|
<version>1.19.2-R0.1-SNAPSHOT</version>
|
|
<scope>provided</scope>
|
|
</dependency>
|
|
```
|
|
|
|
Gradle
|
|
```kotlin
|
|
repositories {
|
|
maven("https://repo.purpurmc.org/snapshots")
|
|
}
|
|
```
|
|
```kotlin
|
|
dependencies {
|
|
compileOnly("org.purpurmc.purpur:purpur-api:1.19.2-R0.1-SNAPSHOT")
|
|
}
|
|
```
|
|
|
|
Yes, this also includes all API provided by Paper, Spigot, and Bukkit.
|
|
|
|
## Building and setting up
|
|
|
|
#### Initial setup
|
|
Run the following command 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 createReobfPaperclipJar`.
|
|
To install the `purpur-api` and `purpur` dependencies to your local Maven repo, run `./gradlew publishToMavenLocal`
|
|
|
|
Special Thanks To:
|
|
-------------
|
|
### YourKit
|
|
|
|
|
|
|
|
|
|
[YourKit Logo](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.
|
|
|
|
### 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.
|
|
|
|
### Our Contributors
|
|
|
|
[](https://github.com/PurpurMC/Purpur/graphs/contributors)
|
|
|
|
### Our Sponsors
|
|
|
|
[](https://opencollective.com/purpurmc)
|