mirror of
https://github.com/PurpurMC/Purpur.git
synced 2026-02-17 08:27:43 +01:00
Update readme
This commit is contained in:
William Blake Galbreath
60
README.md
60
README.md
@@ -1,38 +1,86 @@
|
||||
Purpur
|
||||
==
|
||||
[](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 fork of Paper used by the Pl3xCraft server.
|
||||
|
||||
It contains many gameplay changes to suit our server that are deemed too wild to be included directly upstream into Paper.
|
||||
|
||||
## Contact
|
||||
[Discord](https://pl3x.net/discord)
|
||||
Join us on [Discord](https://discord.gg/mtAAnkk)
|
||||
|
||||
[](https://discord.gg/mtAAnkk)
|
||||
|
||||
## Downloads
|
||||
[](https://ci.pl3x.net/job/Purpur)
|
||||
|
||||
Downloads can be obtained from Pl3x's [Jenkins CI Server](https://ci.pl3x.net/job/Purpur/).
|
||||
|
||||
* [1.16.2](https://ci.pl3x.net/job/Purpur/lastStableBuild/artifact/final/purpurclip.jar) builds 711+
|
||||
* [1.16.1](https://ci.pl3x.net/job/Purpur/710/artifact/final/purpurclip-710.jar) builds 608-710
|
||||
* [1.15.2](https://ci.pl3x.net/job/Purpur/606/artifact/final/purpurclip-606.jar) builds 398-606
|
||||
* [1.15.1](https://ci.pl3x.net/job/Purpur/397/artifact/final/purpurclip-397.jar) builds 348-397
|
||||
* [1.15](https://ci.pl3x.net/job/Purpur/346/artifact/final/purpurclip-346.jar) builds 339-346
|
||||
* [1.14.x](https://ci.pl3x.net/job/Purpur/337/artifact/final/purpurclip-337.jar) builds 337 and below
|
||||
|
||||
## License
|
||||
[](LICENSE)
|
||||
|
||||
Everything is licensed under the MIT license, and is free to be used in your own fork.
|
||||
|
||||
See [EMC](https://github.com/starlis/empirecraft) and [byof](https://github.com/electronicboy/byof)
|
||||
See [starlis/empirecraft](https://github.com/starlis/empirecraft) and [electronicboy/byof](https://github.com/electronicboy/byof)
|
||||
for the license of material used/modified by this project.
|
||||
|
||||
## bStats
|
||||
|
||||
[](https://bstats.org/plugin/server-implementation/Purpur)
|
||||
|
||||
|
||||
## API
|
||||
|
||||
Purpur API maven dependency:
|
||||
```
|
||||
<dependency>
|
||||
<groupId>net.pl3x.purpur</groupId>
|
||||
<artifactId>purpur-api</artifactId>
|
||||
<version>1.16.2-R0.1-SNAPSHOT</version>
|
||||
<scope>provided</scope>
|
||||
</dependency>
|
||||
```
|
||||
```
|
||||
<repository>
|
||||
<id>purpur</id>
|
||||
<url>https://repo.pl3x.net/</url>
|
||||
</repository>
|
||||
```
|
||||
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:
|
||||
|
||||
```
|
||||
git submodule init
|
||||
git submodule update
|
||||
git submodule update --init
|
||||
./purpur up
|
||||
./purpur patch
|
||||
```
|
||||
|
||||
#### 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 `./purpur rb`, and a
|
||||
patch will be placed in the patches folder. Modifying commits will also modify its
|
||||
corresponding patch file.
|
||||
|
||||
See [Paper's contributing guideline](https://github.com/PaperMC/Paper/blob/master/CONTRIBUTING.md) for more detailed information.
|
||||
See [CONTRIBUTING.md](CONTRIBUTING.md) for more detailed information.
|
||||
|
||||
|
||||
#### Building
|
||||
#### Compiling
|
||||
|
||||
Use the command `./purpur build` to build the api and server. Compiled jars
|
||||
will be placed under `Purpur-API/target` and `Purpur-Server/target`.
|
||||
|
||||
To get a purpurclip jar, run `./purpur jar`.
|
||||
|
||||
Reference in New Issue
Block a user