|
| 1 | +# Cauldron |
| 2 | + |
| 3 | +Fork of 1.12.2 [Paper](https://github.com/PaperMC/Paper) aimed at improving server performance for anarchy servers. |
| 4 | + |
| 5 | +## Contact |
| 6 | + |
| 7 | +TBD |
| 8 | + |
| 9 | +## How To (Server Admins) |
| 10 | + |
| 11 | +Cauldron uses the same paperclip jar system that Paper uses. |
| 12 | + |
| 13 | +You can download the latest build of Cauldron by going here: TBD |
| 14 | + |
| 15 | +You can also [build it yourself](https://github.com/nopjmp/Cauldron#building) |
| 16 | + |
| 17 | +## How To (Plugin developers) |
| 18 | + |
| 19 | +In order to use Cauldron as a dependency you must [build it yourself](https://github.com/nopjmp/Cauldron#building). |
| 20 | +Each time you want to update your dependency you must re-build cauldron. |
| 21 | + |
| 22 | +Cauldron-API maven dependency: |
| 23 | + |
| 24 | +```xml |
| 25 | +<dependency> |
| 26 | + <groupId>dev.pomf.cauldron</groupId> |
| 27 | + <artifactId>cauldron-api</artifactId> |
| 28 | + <version>1.12.2-R0.1-SNAPSHOT</version> |
| 29 | + <scope>provided</scope> |
| 30 | + </dependency> |
| 31 | +``` |
| 32 | + |
| 33 | +Cauldron-Server maven dependency: |
| 34 | + |
| 35 | +```xml |
| 36 | +<dependency> |
| 37 | + <groupId>dev.pomf.cauldron</groupId> |
| 38 | + <artifactId>cauldron</artifactId> |
| 39 | + <version>1.12.2-R0.1-SNAPSHOT</version> |
| 40 | + <scope>provided</scope> |
| 41 | +</dependency> |
| 42 | +``` |
| 43 | + |
| 44 | +There is no repository required since the artifacts should be locally installed |
| 45 | +via building cauldron. |
| 46 | + |
| 47 | +## Building |
| 48 | + |
| 49 | +Requirements: |
| 50 | + |
| 51 | +- You need `git` installed, with a configured user name and email. |
| 52 | + On windows you need to run from git bash. |
| 53 | +- You need `maven` installed |
| 54 | +- You need `jdk` 8+ installed to compile (and `jre` 8+ to run) |
| 55 | +- Anything else that `paper` requires to build |
| 56 | + |
| 57 | +If all you want is a paperclip server jar, just run `./cauldron jar` |
| 58 | + |
| 59 | +Otherwise, to setup the `Cauldron-API` and `Cauldron-Server` repo, just run the following command |
| 60 | +in your project root `./cauldron patch` additionally, after you run `./cauldron patch` you can run `./cauldron build` to build the |
| 61 | +respective api and server jars. |
| 62 | + |
| 63 | +`./cauldron patch` should initialize the repo such that you can now start modifying and creating |
| 64 | +patches. The folder `Cauldron-API` is the api repo and the `Cauldron-Server` folder |
| 65 | +is the server repo and will contain the source files you will modify. |
| 66 | + |
| 67 | +#### Creating a patch |
| 68 | + |
| 69 | +Patches are effectively just commits in either `Cauldron-API` or `Cauldron-Server`. |
| 70 | +To create one, just add a commit to either repo and run `./cauldron rb`, and a |
| 71 | +patch will be placed in the patches folder. Modifying commits will also modify its |
| 72 | +corresponding patch file. |
| 73 | + |
| 74 | +## License |
| 75 | + |
| 76 | +The PATCHES-LICENSE file describes the license for api & server patches, |
| 77 | +found in `./patches` and its subdirectories except when noted otherwise. |
| 78 | + |
| 79 | +Everything else is licensed under the MIT license, except when note otherwise. |
| 80 | +See https://github.com/starlis/empirecraft and https://github.com/electronicboy/byof |
| 81 | +for the license of material used/modified by this project. |
| 82 | + |
| 83 | +### Note |
| 84 | + |
| 85 | +The fork is based off of aikar's EMC framework found [here](https://github.com/starlis/empirecraft) |
0 commit comments