Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
BillyGalbreath committed Aug 15, 2020
1 parent 814cbea commit 333fc3e
Showing 1 changed file with 26 additions and 14 deletions.
40 changes: 26 additions & 14 deletions README.md
@@ -1,14 +1,34 @@
Purpur
==
[![Purpur's Stargazers](https://img.shields.io/github/stars/pl3xgaming/Purpur?label=Stars&style=for-the-badge&logo=github)](https://github.com/pl3xgaming/Purpur/stargazers)
[![BillyGalbreath's Followers](https://img.shields.io/github/followers/BillyGalbreath?label=Followers&style=for-the-badge&logo=github)](https://github.com/BillyGalbreath?tab=followers)
[![Purpur Forks](https://img.shields.io/github/forks/pl3xgaming/Purpur?label=Forks&style=for-the-badge&logo=github)](https://github.com/pl3xgaming/Purpur/network/members)
[![Purpur Watchers](https://img.shields.io/github/watchers/pl3xgaming/Purpur?label=Watchers&style=for-the-badge&logo=github)](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://discord.gg/mtAAnkk)
Join us on [Discord](https://discord.gg/mtAAnkk)

[![Join us on Discord](https://img.shields.io/discord/685683385313919172.svg?label=&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2&style=for-the-badge)](https://discord.gg/mtAAnkk)

## Downloads
[![Download from Jenkins CI](https://img.shields.io/jenkins/build?jobUrl=https%3A%2F%2Fci.pl3x.net%2Fjob%2FPurpur&style=for-the-badge&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAB0AAAAgCAYAAADud3N8AAABhGlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw1AUhU9TpUUrHewg4pChOlkQFXHUKhShQqgVWnUweekfNDEkKS6OgmvBwZ/FqoOLs64OroIg+APi5Oik6CIl3pcUWsT44PI+znvncN99gNCoMs3qGgM03TYzqaSYy6+IoVeEEaXqhSAzy5iVpDR819c9Any/S/As/3t/rj61YDEgIBLPMMO0ideJpzZtg/M+cYyVZZX4nHjUpAaJH7muePzGueSywDNjZjYzRxwjFksdrHQwK5sa8SRxXNV0yhdyHquctzhr1Rpr9clfGCnoy0tcpxpCCgtYhAQRCmqooAobCdp1Uixk6Dzp4x90/RK5FHJVwMgxjw1okF0/+B/8nq1VnBj3kiJJoPvFcT6GgdAu0Kw7zvex4zRPgOAzcKW3/RsNYPqT9Hpbix8B0W3g4rqtKXvA5Q4w8GTIpuxKQSqhWATez+ib8kD/LdCz6s2tdY7TByBLs0rfAAeHwEiJstd83h3unNu/d1rz+wHYXHJptwl4jgAAAAZiS0dEAP8A/wD/oL2nkwAAAAlwSFlzAAALEwAACxMBAJqcGAAAAAd0SU1FB+QIDwgMGJjYLkEAAAejSURBVEjHtZZrcJTVGcd/Z2/v3nO/b0hCkiVIQEhIs9BgBRRhsGDRglinH7CdikVlcNqqzFjtzakMrbbVirSECm2HkTJcpQJTCFRZEknCTWBDEkgCmwu5brL33bcfdpNsgAh86Jl5Z973PZffeZ7zPM/5C+6xWUtsCmB+9CkHsoDcaHcbcB2oBo4Ahxy19tB4a4l7gGmB1cBPgIzYPq1GyZJZhahVCjp7BjlU1zK8oBP4JYhNjtqT4XuGFpbYELASeAsojO1b+1Q5j1VMJdeSgkIxusSQx8eFhjb+caCagzXNAF8AKxy19ra7Qq0lNguwA5gtqVWkxJtp7+ljSnYCb699gvwJaV/rHVmWOfHlZV7auAePP3QNqIgFizsA44A6IUReQVYacSYjZxqaKbemsvGnK4g36+81DLjc7GT5qx/jDYS+CIfliiv1p2QA5a0DkzIsvwUWZiYnoFGpaOvoQq2U2fzGM6QkmgFo7+rjSksHSqUSg04aFxoIhJCDfuoa2rOFEF3dzraa2yy1ltgeAvYCcbH/31w1l5WPzwLgX5/V8PqmwwDoNSpObXsFjfq2vXPt+k3mrN6EViWGIe1AtqPWHlTFABOB/XpJY8pMTkCv06JRq6m73IQ/EASg4Wo7r286zNvPP8r0yTnoddIdgQDpKfG07F3PzV4Xf91ZxZaDZ9OBRcA+Rcy4xwFTQXYGacmJmAx6lAoFoXCY5AQjAKfONPLu2sUsW1DGxOxU0pPjxnWtpInYk5xg4sVnFyAi5i4CiIUWA2il0TPqHxwCYEqhJTLAamH+rCm3RapryDPm36DbN/LuGvKi12lYOquAaFEZAx2MLBKOyTsPGpWCnMxkAKZPzkGjVo0BeP1B9h+tH/kOyzJHPj838n285hJuj4/igkyAqdYS2xhoM8CNzm5anZ30uwbxB4LMmWpBiPELl05Ss/3T0wwMRqwdcvvY8VktoXA46l4jOz49hV6nAVADUuy24wC0yiB6Sc25plYUCsF/6gfw+PzoJM0Y2DlHKxsqDzExKxF/IMR5RyuzS6wY9RLnW3qoPtOIs6uPTw7XU9vYRUG6eXhqgjIauXrgwLIKq/b3P1tB+bRcRNDP2aYuABZ/s4ikeOMYqEatwqhVkZpk5hFbEbNnFKJQKBBCoAj5+dOO/zJnRj5FeWksfWgyk3JSOVrbDPDusHtLgbjvPlbK8ZqLLHmlEldMMASiKRPbEswGlswv5TuPzmSe7QFUqtHUWbnYhiXFxMZtRyl/MJ8FFdNiU2tgGJoIYNBrSUuOY+W8B/jWzEI2rFlI1aYXRqL3XlucSc97rz2NQauhctcJAPz+yMZlgWv4TJsAnJ19PFRWhFKpZGZx3n2B7PVXEEKQmxWJ9Pab/SSatVzvHACgsa0L4GLDaTvD0HNAY+Xuk/mlxXn3DQQoyEnjyXWbae/3jl6PGWbefOHbyLLMvs8dAF+Nqb3WEtsiYN83ClOVKxaWcsR+iR8+Nee+XHuz10WrsxsAk0HHhMwkNGoVzW1dLHxpM8AaR639/ZGUcdTaD1pLbIuqGzo/qG44WJBolFhn1N0V5PEFOHCsHmQZAIVCYJteSMNVJye+vEyfy01mavzw8N23ViQctfbDIqIStvS7/aQmjuQWLc5ufP6xUXzlWgc6Sc3SeTPITEugraOXi41OPF4/Nzr7yEyN5/tPVPDRLjtR3XT9jvdpt7ONpAyLUpZZMb90ImnRou4a8lJ9tpGCnFHV0NbRw+ZPqpBlGZNeIiczicKcNIx6iYqZkyjISWP/0Tr2RM7zuW5n2zUA1The+zfQt/doffy0ogkAWNITee/jw6QmmiiZEgm0aZMmUPfVNVa/s3tkYopZy9a3vgfAxcbrrP/oCAohdikEVXfTSBlR8LS/vbEc2/QCAHr6h3jx1//kyUceZPHD05E06sht5HKPuN6glzDoJE5faObld3bR5fIBnASecdTar97m3kkls0jKsKwC9gE5ALurLiD7PCSY9STGGSgrzuG5X+3kYNVZlISQkZGiN08gGOJS0w3+svM4v6g8htsfkb5CKLJBXpWUYbnY7Wy7HJsyucAWYK7BHE9GXgHNF84QCgYw6nUMuj0jV5dC3FUu87AS8hRQGYCM3Hz6ujrxDLkAfqwsLC0nOSP7R8AeIRTWrHwrmflWNJIWZJnB/l5+8OxK1q15nskF+ZywV/OhXubnRpm5KgiFBZdukdOvSTIvG2XKNDJ/9gpM5ngshUW4+noJ+n1lCiGLPwIfGuLiDZNKy0nKyEIOhxnq70XS6YlLSuGDym387g/vo9NGVIUcPZcitcx6U4T4tAp2GGV0QDDarwTKFOAZGiQcDiMiwrxZBSyVdHomFs9ACIHf68E7NIgcTfb4lDQkvYEzjiZqfrMBgM4Yy+RoCmgFSCLy7gwLOkMyQaBVBjkcxtVzE/dAP8BJFfB3n8f9qt/rQdLpCQWDI8ARdWAwojMYCfh9dLRc5UrID1GLzvsFWQK2BmBrIHLW2wOwPTBad9LNcfi8IzrqmLCW2PKAJnNiMjqTmXAwiN/rGTdA3K4BAn4faQI65YilX9d0RhMaSYvXPYTP4w4CCSIauTuBZfz/205HrX35/wBw2NNcMtE/igAAAABJRU5ErkJggg==)](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
[![MIT License](https://img.shields.io/github/license/pl3xgaming/Purpur?style=for-the-badge&logo=github)](LICENSE)

Everything is licensed under the MIT license, and is free to be used in your own fork.

See [starlis/empirecraft](https://github.com/starlis/empirecraft) and [electronicboy/byof](https://github.com/electronicboy/byof)
Expand All @@ -19,17 +39,7 @@ for the license of material used/modified by this project.
[![bStats Graph Data](https://bstats.org/signatures/server-implementation/Purpur.svg)](https://bstats.org/plugin/server-implementation/Purpur)


## Server owners

Downloads can be obtained from Pl3x's [Jenkins server](https://ci.pl3x.net/job/Purpur/).

* 1.16.1 builds 608+
* 1.15.2 builds 398-606
* 1.15.1 builds 348-397
* 1.15 builds 339-346
* 1.14.x builds 337 and below

## Plugin developers
## API

Purpur API maven dependency:
```
Expand All @@ -49,6 +59,8 @@ Purpur API maven dependency:
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:

```
Expand All @@ -63,10 +75,10 @@ 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`.
Expand Down

0 comments on commit 333fc3e

Please sign in to comment.