2019-10-24 23:30:45 +00:00
< img src = "assets/kami.png" align = "left" width = "120" / >
2019-10-24 23:31:36 +00:00
2019-10-25 12:17:44 +00:00
# KAMI Blue
2019-10-24 22:59:40 +00:00
2019-10-24 23:09:04 +00:00
### A minecraft utility mod for anarchy servers.
2019-10-24 16:56:30 +00:00
2019-10-28 00:19:48 +00:00
| | S-B99 (features-master)| 086 (upstream) |
|:------------:|:-------------:|:--------------:|
2019-10-31 20:53:31 +00:00
| Build Status | [](https://travis-ci.com/S-B99/KAMI/tree/features-master) | [](https://travis-ci.com/zeroeightysix/KAMI) |
2019-10-31 21:03:35 +00:00
| Media | [](https://discord.gg/KfpqwZB) | [](http://discord.gg/9hvwgeg) |
| Version | [](https://github.com/S-B99/KAMI/releases) | [](https://github.com/zeroeightysix/KAMI/releases) |
2019-10-31 21:37:31 +00:00
<!--| Issues | [](https://github.com/S-B99/kami/issues) | [](https://github.com/zeroeightysix/kami/issues) |
-->
2019-10-31 20:25:23 +00:00
<!--| Build Status | [](https://travis-ci.com/S-B99/KAMI/tree/features-master) | [](https://travis-ci.com/S-B99/KAMI/tree/master) | [](https://travis-ci.com/zeroeightysix/KAMI) |-->
2019-10-28 00:19:48 +00:00
<!--| Issues | [](https://github.com/S-B99/kami/issues) | [](https://github.com/S-B99/kami/issues) | [](https://github.com/zeroeightysix/kami/issues) |-->
<!--| Media | [](https://discord.gg/KfpqwZB) | [](https://discord.gg/KfpqwZB) | [](http://discord.gg/9hvwgeg) |-->
<!--| Version | [](https://github.com/S-B99/KAMI/releases) | [](https://github.com/S-B99/KAMI/releases) | [](https://github.com/zeroeightysix/KAMI/releases) |-->
2018-08-12 00:41:53 +00:00
2019-11-03 16:15:46 +00:00
Please consider donating to help continue this project and get a unique cape in game in the future. Currently I've received about $33 from the [nearly 400 ](.github/IMAGES/traffic.png ) *unique* visitors to this repo.
2019-10-31 13:23:21 +00:00
2019-10-31 21:00:11 +00:00
[](https://paypal.me/bellawhotwo)
[](https://www.blockchain.com/btc/address/19pH4aNZZMPJkqQ2826BauRokyBs1NYon7)
[](https://www.blockchain.com/bch/address/19pH4aNZZMPJkqQ2826BauRokyBs1NYon7)
2019-10-31 13:23:21 +00:00
2019-10-24 21:35:47 +00:00
< details >
< summary > Click to view disclaimers< / summary >
2019-10-24 23:59:08 +00:00
***
2019-10-25 00:02:47 +00:00
This will be frequently updated as long as I'm not on vacation or anything
2019-10-24 23:10:24 +00:00
This is by no means a finished project, nor is it a "cheat" or "hack" for anything, it is a *utility* mod.
2019-10-23 18:49:30 +00:00
2019-10-24 23:10:24 +00:00
Please note Baritone is no longer included. Download the standalone jar [from here ](https://github.com/cabaletta/baritone/releases ).
2018-07-21 18:52:29 +00:00
2019-10-25 12:17:44 +00:00
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.
2019-10-24 21:35:47 +00:00
2019-10-24 23:59:08 +00:00
***
2019-10-24 21:35:47 +00:00
< / details >
## How to download
2019-11-04 23:23:03 +00:00
Press the releases button or [click here ](https://github.com/S-B99/KAMI/releases )
2019-10-24 22:37:00 +00:00
2019-10-24 16:56:30 +00:00
## Status
< details >
< summary > Click to view current development status< / summary >
2019-10-24 23:59:08 +00:00
***
2019-11-03 16:18:17 +00:00
[Everything here is planned for sure, ](https://github.com/zeroeightysix/KAMI/pull/114 ) [along with here ](https://github.com/S-B99/KAMI/issues/12 ) and the rest of the issues with a milestone attached.
2019-10-24 16:56:30 +00:00
This is currently in slowed development. Maintainance and further development is planned in the next couple months.
2019-10-24 23:59:08 +00:00
***
2019-10-24 16:56:30 +00:00
< / details >
2018-07-21 20:00:15 +00:00
2018-12-16 18:53:27 +00:00
## Preview
< details >
2019-10-24 16:56:30 +00:00
< summary > Click to view images< / summary >
2018-12-16 18:53:27 +00:00
2019-10-24 23:59:08 +00:00
***
2019-11-03 16:05:32 +00:00
Click on images to expand
***
2019-11-03 15:37:48 +00:00
Note: GUI Color is a work in progress and unreleased
2019-10-23 18:49:30 +00:00
2019-10-25 23:35:47 +00:00
< img src = ".github/IMAGES/gui.png" width = "500" / >
2019-10-24 23:10:24 +00:00
2019-11-03 15:37:48 +00:00
GUI When Closed
Ignore the GUI on the right, that's future
< img src = ".github/IMAGES/guiclosed.png" width = "500" / >
2019-10-25 23:35:47 +00:00
Shulker preview being used in chat
< img src = ".github/IMAGES/shulkerChat.png" width = "500" / >
CrystalAura targeting
< img src = ".github/IMAGES/crystalAura.png" width = "500" / >
2018-12-16 18:53:27 +00:00
2019-10-24 23:59:08 +00:00
***
2018-12-16 18:53:27 +00:00
< / details >
2018-08-08 18:20:50 +00:00
## Installing
2019-11-04 23:22:33 +00:00
To install drag the `VERSION-release.jar` to your `mods/1.12.2` folder
2019-10-25 22:04:55 +00:00
< details >
< summary > Click to see more detailed installing instructions< / summary >
2019-10-25 18:01:56 +00:00
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 ).
2018-08-08 18:20:50 +00:00
1. Install forge
2019-10-24 16:56:30 +00:00
2. Go to your `.minecraft` directory.
2018-08-08 18:20:50 +00:00
* **Linux**: `~/.minecraft`
2019-10-23 18:49:30 +00:00
* **Windows**: `%appdata%/.minecraft`
2018-08-08 18:20:50 +00:00
3. Navigate to the `mods` directory. If it doesn't exist, create it.
2019-10-25 12:17:44 +00:00
4. Get the KAMI Blue `.jar` file.
2018-08-10 13:21:57 +00:00
* By **downloading** it: see [releases ](../../releases )
2018-08-10 13:23:05 +00:00
* By **building** it: see [building ](#building ).
2019-10-24 16:56:30 +00:00
5. Drag the `-release.jar` file into your mods directory.
2018-08-08 18:20:50 +00:00
2019-10-25 22:04:55 +00:00
< / details >
2018-08-12 18:52:03 +00:00
## How do I
2019-10-24 16:56:30 +00:00
< details >
< summary > Click to see the frequently asked questions or basic stuff< / summary >
2018-08-12 18:52:03 +00:00
2019-10-24 23:59:08 +00:00
***
2019-10-24 23:10:24 +00:00
##### Open the GUI
Press Y.
2018-08-12 18:52:03 +00:00
2019-10-24 23:10:24 +00:00
##### Use commands
The default prefix is `.` . Commands are used through chat, use `.commands` for a list of commands.
2018-08-12 18:52:03 +00:00
2019-10-24 23:10:24 +00:00
##### Bind modules
Run `.bind <module> <key>` .
2019-10-23 18:49:30 +00:00
2019-10-24 23:10:24 +00:00
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` .
2018-08-12 18:52:03 +00:00
2019-10-24 23:10:24 +00:00
##### Change command prefix
2019-10-25 12:17:44 +00:00
By using the command `prefix <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.
2018-08-10 13:07:49 +00:00
2019-10-24 23:59:08 +00:00
***
2019-10-24 16:56:30 +00:00
< / details >
2018-10-03 06:41:36 +00:00
2019-10-24 16:56:30 +00:00
## Troubleshooting
2018-07-21 20:00:15 +00:00
2019-10-24 16:56:30 +00:00
< details >
< summary > Please read this before opening an issue< / summary >
2019-10-23 18:49:30 +00:00
2019-10-24 23:59:08 +00:00
***
2019-10-24 23:10:24 +00:00
Please reference the main [troubleshooting page ](docs/TROUBLESHOOTING.md )
2019-10-23 18:49:30 +00:00
2019-10-24 23:10:24 +00:00
If you have an issue or problem and it's not listed there, please [open a new issue ](../../issues/new/choose ) and a contributor will help you further.
2018-07-21 20:00:15 +00:00
2019-10-24 23:59:08 +00:00
***
2019-10-24 16:56:30 +00:00
< / details >
2018-07-21 20:00:15 +00:00
2019-10-25 18:08:03 +00:00
## Building
< details >
< summary > Click to see building instructions< / summary >
***
2019-08-06 06:09:42 +00:00
#### Linux
2019-10-23 18:49:30 +00:00
You can build by running these commands (without the < >) in a terminal.
2019-08-06 06:09:42 +00:00
```
2019-10-24 21:17:59 +00:00
git clone https://github.com/S-B99/KAMI/
2019-08-06 06:09:42 +00:00
cd KAMI
2019-10-23 18:49:30 +00:00
chmod +x gradlew
./gradlew < args >
```
Possible arguments:
2019-08-06 06:09:42 +00:00
```
2019-10-23 18:49:30 +00:00
build
mkdir
rmOld
copy
```
If you use more than one then it must be in that order.
2019-10-25 12:17:44 +00:00
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.
2019-10-23 18:49:30 +00:00
2019-10-25 12:17:44 +00:00
\*`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.
2019-10-23 18:49:30 +00:00
2019-10-24 16:56:30 +00:00
If you prefer copying it manually, find a file in `build/libs` called `KAMI-<kamiVersion>-**release**.jar` which you can copy to the `mods/1.12.2` folder of a minecraft instance that has forge installed.
2019-10-23 18:49:30 +00:00
2019-08-06 06:09:42 +00:00
Note: This assumes your minecraft folder is in the default location under your home folder.
2018-10-10 19:32:02 +00:00
2019-10-25 12:17:44 +00:00
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 )
2019-10-24 16:56:30 +00:00
2019-10-25 22:04:55 +00:00
***
2019-10-23 18:49:30 +00:00
#### 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`
2019-10-24 16:56:30 +00:00
If you prefer copying it manually, find a file in `build/libs` called `KAMI-<kamiVersion>-**release**.jar` which you can copy to the `mods\1.12.2` folder of a minecraft instance that has forge installed.
2019-10-23 18:49:30 +00:00
Note: This assumes your minecraft folder is in the default location under your %appdata% folder.
2019-10-25 18:08:03 +00:00
***
2019-10-25 23:31:09 +00:00
If you get build errors see this: [troubleshooting page ](docs/TROUBLESHOOTING.md )
***
2019-10-25 18:08:03 +00:00
< / details >
2019-10-24 16:56:30 +00:00
## Contributing
2019-10-25 18:08:03 +00:00
< details >
< summary > Click to see how to contribute< / summary >
***
2019-10-25 12:17:44 +00:00
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:
2019-10-24 16:56:30 +00:00
On GNU/Linux, run `chmod +x gradlew` and 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
```
2019-10-24 21:17:59 +00:00
git clone https://github.com/S-B99/KAMI/
2019-10-24 16:56:30 +00:00
cd KAMI
```
2019-10-25 12:17:44 +00:00
Import KAMI Blue into your IDE of choice.
2019-10-24 16:56:30 +00:00
```
gradlew.bat setupDecompWorkspace
gradlew.bat genIntellijRuns #for intellij
gradlew.bat eclipse #for eclipse
```
If you use IntelliJ, import `build.gradle`
2019-10-24 22:05:04 +00:00
If you use Eclipse, import a new gradle project and select the KAMI folder.
2019-10-24 16:56:30 +00:00
If you have gradle related issues with either of these force your gradle version to `4.8.1`
2019-10-25 12:17:44 +00:00
If you do not wish to run from an IDE, use `gradlew.bat runClient` to run KAMI Blue.
2019-10-24 16:56:30 +00:00
2019-10-25 18:08:03 +00:00
***
2019-10-25 23:31:09 +00:00
If you get build errors see this: [troubleshooting page ](docs/TROUBLESHOOTING.md )
***
2019-10-25 18:08:03 +00:00
< / details >
2019-11-03 16:05:32 +00:00
## How this actually improves over KAMI Red
2019-10-25 18:08:03 +00:00
< details >
< summary > Click to see new features and improvements< / summary >
2019-11-03 16:05:32 +00:00
### Currently:
2019-10-25 18:08:03 +00:00
- NoFall Bucket Mode picks up the water bucket after
- Better mcmod.info with more information
2019-11-03 16:05:32 +00:00
- Constant testing
- Hey look an active developer
- GUI is better
- If someone does write code and add it to KAMI Red this generally gets it way faster
### Upcoming:
- Modules under experimental (discord RPC, etc)
- Stuff in [issues to be added ](https://github.com/S-B99/KAMI/issues )
- GUI Color Changer
- CAPES! (donate $10 to unlock)
2019-10-25 22:58:13 +00:00
- Fast place has options for speed coming soon
- Modes for fast use and deleting fast place also soon
2019-11-03 16:05:32 +00:00
- Auto32k will automatically enable and disable aura as an option
2019-10-25 18:08:03 +00:00
< / details >
2019-10-25 22:04:55 +00:00
2018-10-10 19:32:02 +00:00
## Thank you
2019-10-24 16:56:30 +00:00
[zeroeightysix ](https://github.com/zeroeightysix ) for the original [KAMI ](https://github.com/zeroeightysix/KAMI )
2018-10-10 19:32:02 +00:00
[ZeroMemes ](https://github.com/ZeroMemes ) for [Alpine ](https://github.com/ZeroMemes/Alpine )
[ronmamo ](https://github.com/ronmamo/ ) for [Reflections ](https://github.com/ronmamo/reflections )
2019-10-24 16:56:30 +00:00
The [Minecraft Forge team ](https://github.com/MinecraftForge ) for [forge ](https://files.minecraftforge.net/ )
