https://github.com/PurpurMC/Purpur
Purpur is a drop-in replacement for Paper servers designed for configurability, and new fun and exciting gameplay features.
https://github.com/PurpurMC/Purpur
bukkit hacktoberfest java minecraft minecraft-server paper purpur spigot
Last synced: 5 months ago
JSON representation
Purpur is a drop-in replacement for Paper servers designed for configurability, and new fun and exciting gameplay features.
- Host: GitHub
- URL: https://github.com/PurpurMC/Purpur
- Owner: PurpurMC
- License: mit
- Created: 2019-04-30T16:59:51.000Z (almost 6 years ago)
- Default Branch: ver/1.21.1
- Last Pushed: 2024-10-28T07:21:22.000Z (6 months ago)
- Last Synced: 2024-10-29T15:18:41.793Z (6 months ago)
- Topics: bukkit, hacktoberfest, java, minecraft, minecraft-server, paper, purpur, spigot
- Language: Shell
- Homepage: https://purpurmc.org
- Size: 23.4 MB
- Stars: 2,033
- Watchers: 39
- Forks: 360
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-docker - PurpurMC/Purpur
- awesome-docker - PurpurMC/Purpur
README
## 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/).
## Contact
Join us on Discord:
[](https://purpurmc.org/discord)
## Downloads
Downloads can be obtained from the [downloads page](https://purpurmc.org/downloads/) or the [downloads API](https://api.purpurmc.org).
[](https://purpurmc.org/downloads/)
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/`
* Download a specific build of a specific version:
`https://api.purpurmc.org/v2/purpur///download`
* Download the latest build for a version of Minecraft:
`https://api.purpurmc.org/v2/purpur//latest/download`
## License
All patches are licensed under the MIT license, unless otherwise noted in the patch headers.
[](LICENSE)
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
purpur
https://repo.purpurmc.org/snapshots
```
```xml
org.purpurmc.purpur
purpur-api
1.21.1-R0.1-SNAPSHOT
provided
```
Gradle
```kotlin
repositories {
maven("https://repo.purpurmc.org/snapshots")
}
```
```kotlin
dependencies {
compileOnly("org.purpurmc.purpur:purpur-api:1.21.1-R0.1-SNAPSHOT")
}
```
Yes, this also includes all API provided by Paper, Spigot, and Bukkit.
## Building and setting up
#### Initial setup
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.
#### 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`.
**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`.
Special Thanks To:
-------------
### YourKit
[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.
### JetBrains
[
](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://github.com/sponsors/PurpurMC)
### Our Backers
[](https://opencollective.com/purpurmc)