caskd/kami-blue
1
0
Fork 0
forked from RepoMirrors/kami-blue
Code Issues Pull Requests Releases Wiki Activity

Update README: Setup instructions

Browse Source
This commit is contained in:
Ridan Vandenbergh 2018-07-21 22:00:15 +02:00 committed by GitHub
parent 7202da01d0
commit 8883aa4c13
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -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. 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. 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.