diff --git a/README.md b/README.md index 1b037ba8..a38a2808 100644 --- a/README.md +++ b/README.md @@ -5,3 +5,29 @@ A minecraft 'hacked' client in the form of a forge mod. See [forgehax](https://github.com/fr1kin/forgehax) for a more polished equivalent. Some features in KAMI may be based on those of forgehax, as I sometimes used it as reference. This is by no means a finished project and isn't fully ready for release. + +## Contributing + +You are free to clone, modify KAMI and make pull requests as you wish. To set up your development environment, make use of the following commands: + +``` +git clone https://github.com/zeroeightysix/KAMI/ +cd KAMI +``` + +On linux, run `chmod +x gradlew` and for the following commands use `./gradlew` instead of `./gradlew.bat` + +``` +./gradlew.bat setupDecompWorkspace +``` +Import KAMI into your IDE of choice. If you use intelliJ, import from the `build.gradle` file and run `./gradlew.bat genIntellijRuns` + +If you do not wish to run from an IDE, use './gradlew.bat runClient` to run KAMI. + +### Building + +``` +./gradlew.bat build +cd build/libs +``` +In `build/libs` you will find the `.jar` file which you can copy to the `mods` folder of a minecraft instance that has forge installed.