# KAMI Blue
### A minecraft utility mod for anarchy servers.
| | S-B99 (features-master)| 086 (upstream) |
|:------------:|:-------------:|:--------------:|
| Build Status | [](https://travis-ci.com/S-B99/KAMI/) | [](https://travis-ci.com/zeroeightysix/KAMI) |
| Media | [](https://discord.gg/KfpqwZB) | [](http://discord.gg/9hvwgeg) |
| Version | [](https://github.com/S-B99/KAMI/releases) | [](https://github.com/zeroeightysix/KAMI/releases) |
Please consider donating to help continue this project and get a unique cape in game.
[](https://paypal.me/bellawhotwo)
[](https://www.blockchain.com/btc/address/19pH4aNZZMPJkqQ2826BauRokyBs1NYon7)
[](https://www.blockchain.com/bch/address/19pH4aNZZMPJkqQ2826BauRokyBs1NYon7)
Click to view disclaimers
***
This will be frequently updated as long as I'm not on vacation or anything
This is by no means a finished project, nor is it a "cheat" or "hack" for anything, it is a *utility* mod.
Please note Baritone is no longer included. Download the standalone jar [from here](https://github.com/cabaletta/baritone/releases) The latest 1.12.2 jar is [this](https://github.com/cabaletta/baritone/releases/tag/v1.2.10).
See [forgehax](https://github.com/fr1kin/forgehax) for an equivalent. Some features in KAMI may be based on those of forgehax, and KAMI / KAMI Blue have some features it doesn't. KAMI Blue won't be based off of other mods unless said otherwise.
***
## How to download
Press the releases button or [click here](https://github.com/S-B99/KAMI/releases)
## Status
Click to view current development status
***
Please see the [issues](https://github.com/S-B99/KAMI/issues/12) page for planned features and bugs to fix.
This is currently in active development. When issues are being closed is by milestone, and bugs are higher priority, though there aren't any that break anything completely.
***
## Preview
Click to view images
***
Click on images to expand
***
Capes in game
Rich presence on discord
Shulker preview being used in chat
CrystalAura targeting
***
## Installing
To install drag the `VERSION-release.jar` to your `mods/1.12.2` folder
Click to see more detailed installing instructions
KAMI Blue is a forge mod. Start by downloading the latest version of [1.12.2 forge](https://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.12.2.html).
1. Install forge
2. Go to your `.minecraft` directory.
* **Linux**: `~/.minecraft`
* **Windows**: `%appdata%/.minecraft`
* **OS X**: `~/Library/Application Support/minecraft`
3. Navigate to the `mods` directory. If it doesn't exist, create it.
4. Get the KAMI Blue `.jar` file.
* By **downloading** it: see [releases](../../releases)
* By **building** it: see [building](#building).
5. Drag the `-release.jar` file into your mods directory.
## How do I
Click to see the frequently asked questions or basic stuff
***
##### Open the GUI
Press Y.
##### Use commands
The default prefix is `.`. Commands are used through chat, use `.commands` for a list of commands.
##### Bind modules
Run `.bind `.
You can also use `.bind modifiers on` to allow modules to be bound to keybinds with modifiers, e.g `ctrl + shift + w` or `ctrl + c`.
##### Change command prefix
By using the command `prefix ` or after having ran KAMI Blue (make sure it's closed), editing your configuration file (find it using `config path` in-game) and changing the value of `commandPrefix` to change the prefix.
***
## Building and Contributing
Click to see building instructions
***
If you can't figure these instructions out, please see [this](https://youtu.be/PfmlNiHonV0) before asking for help.
***
### Building
#### Linux
You can build by running these commands (without the <>) in a terminal.
```
git clone https://github.com/S-B99/KAMI/
cd KAMI
chmod +x gradlew
./gradlew
```
Possible arguments:
```
build
mkdir
rmOld
copy
```
If you use more than one then it must be in that order.
Build is required, `mkdir` makes the `mods/1.12.2` directory, `rmOld` removes old versions of KAMI and KAMI Blue\* in that directory, and `copy` copies the build release to the `mods/1.12.2` directory.
\*`rmOld` removes any jars ending in `-release.jar`, which is the format KAMI used and that KAMI Blue uses. If you use any other mod that uses that naming scheme please remove old versions manually.
If you prefer copying it manually, find a file in `build/libs` called `KAMI--**release**.jar` which you can copy to the `mods/1.12.2` folder of a minecraft instance that has forge installed.
Note: This assumes your minecraft folder is in the default location under your home folder.
Note: Any argument other then `build` assumes you downloaded KAMI Blue to a nested folder inside your home folder. For example `~/Downloads/KAMI` or `~/Documents/KAMI`. This will be fixed as per [issue #15](https://github.com/S-B99/KAMI/issues/15)
***
#### Windows
You can build by running these commands in a terminal with the current directory being KAMI. (EG. `cd C:\Users\Username\Downloads\KAMI`)
```
gradlew.bat build
```
To copy on windows run `autocopy.bat`
If you prefer copying it manually, find a file in `build/libs` called `KAMI--**release**.jar` which you can copy to the `mods\1.12.2` folder of a minecraft instance that has forge installed.
Note: This assumes your minecraft folder is in the default location under your %appdata% folder.
***
If you get build errors see this: [troubleshooting page](docs/TROUBLESHOOTING.md)
***
### Contributing
You are free to clone, modify KAMI and KAMI Blue and make pull requests as you wish. To set up your development environment, make use of the following commands:
On GNU/Linux, run `chmod +x gradlew` beforehand
On Windows, for the following commands use `./gradlew` instead of `gradlew.bat`
Of-course you can also use a Gradle installation if you for some reason want another version of gradle
```
git clone https://github.com/S-B99/KAMI/
cd KAMI
```
Import KAMI Blue into your IDE of choice.
```
./gradlew setupDecompWorkspace
./gradlew genIntellijRuns #for intellij
./gradlew eclipse #for eclipse
```
If you use IntelliJ, import `build.gradle`
If you use Eclipse, import a new gradle project and select the KAMI folder.
If you have gradle related issues with either of these force your gradle version to `4.8.1`
If you do not wish to run from an IDE, use `./gradlew runClient` to run KAMI Blue.
Note: I don't recommend using runClient as sometimes it's wonky. If you have issues then do `./gradlew clean`
***
If you get build errors see this: [troubleshooting page](docs/TROUBLESHOOTING.md)
***
## Thank you
[zeroeightysix](https://github.com/zeroeightysix) for the original [KAMI](https://github.com/zeroeightysix/KAMI)
[ZeroMemes](https://github.com/ZeroMemes) for [Alpine](https://github.com/ZeroMemes/Alpine)
[ronmamo](https://github.com/ronmamo/) for [Reflections](https://github.com/ronmamo/reflections)
The [Minecraft Forge team](https://github.com/MinecraftForge) for [forge](https://files.minecraftforge.net/)
All the [contributors](https://github.com/S-B99/KAMI/graphs/contributors), including the ones who will be remembered in comments and in our hearts. This has been a huge community effort and I couldn't have done it without them.