`<What this will do>. <Why I want/need it>. <Ideas on how it might be implemented>. <Any helpful links>.`
`<What this will do>. <Why I want/need it>. <Ideas on how it might be implemented>. <Any helpful links>.`
*This fork is put together by the community. Yive is **not** your personal server issue fixer. He does not know Java nor does he want to learn it.*
*This fork is put together by the community. Yive is NOT your personal server issue fixer. He does not know Java nor does he want to learn it.*
## Contributing
## Contributing
Please read the [guide](https://github.com/TCPR/KCauldron/blob/master/CONTRIBUTING.md) on how to contribute - Cauldron always needs improvements :smile:
Please read the [guide](https://github.com/TCPR/KCauldron/blob/master/CONTRIBUTING.md) on how to contribute - TCPR/KCauldron always needs improvements :smile:
## Downloads
## Downloads
You can download the pre-built packages from [here](https://github.com/TCPR/KCauldron/releases).
You can download the pre-built packages from [here](https://github.com/TCPR/KCauldron/releases).
**These unofficial builds are in beta, they may cause issues with your server. You have been warned!**
**These unofficial builds are in beta, they may cause issues with your server. You have been warned!**
P.S. Please look at the release notes before downloading. :)
P.S. **PLEASE** look at the release notes before downloading! :smile:
## Build Requirements
## Build Requirements
* Java 8 JDK
* Java 8 JDK
* `JAVA_HOME` defined on your OS
* `JAVA_HOME` defined on your OS
## Building Cauldron
## Building TCPR/KCauldron
* Checkout project
* Checkout project
* You can use IDE or clone from console:
* You can use IDE or clone from console:
`git clone https://github.com/TCPR/KCauldron.git`
`git clone https://github.com/TCPR/KCauldron.git`
* Init submodules
* Setup
* Since this project uses two other projects we need to download them as well
* Auto: `setup.sh`
* Manual:
`git submodule update --init --recursive`
`git submodule update --init --recursive`
* Start build process
* Build
* This process downloads minecraft and apply patches
* This process downloads minecraft and apply patches
* If you have gradle integration in IDE - you can still use gui
* If you have gradle integration in IDE - you can still use gui