diff --git a/README.md b/README.md index a77142ec0..ab89cfcb4 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,16 @@ This will be frequently updated as long as I'm not on vacation or anything
Click to view disclaimers +*** + 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). See [forgehax](https://github.com/fr1kin/forgehax) for an equivalent. Some features in KAMI may be based on those of forgehax, and KAMI / Blue KAMI have some features it doesn't. Blue KAMI won't be based off of other mods unless said otherwise. +*** +
## How to download @@ -35,10 +39,14 @@ Scroll alll the way up
Click to view current development status +*** + [Everything here is planned for sure,](https://github.com/zeroeightysix/KAMI/pull/114) [along with here](https://github.com/S-B99/KAMI/issues/12) This is currently in slowed development. Maintainance and further development is planned in the next couple months. +*** +
## Preview @@ -46,12 +54,16 @@ This is currently in slowed development. Maintainance and further development is
Click to view images +*** + ![GUI](.github/IMAGES/gui.png "The GUI") ![ShulkerPreview](.github/IMAGES/shulkerChat.png "Shulker preview being used in chat") ![CrystalAura](.github/IMAGES/crystalAura.png "CrystalAura targeting") +*** +
## Installing @@ -72,6 +84,8 @@ Blue KAMI is a forge mod. Start by downloading the latest version of [1.12.2 for
Click to see the frequently asked questions or basic stuff +*** + ##### Open the GUI Press Y. @@ -93,6 +107,8 @@ Paste text in the first box and copy the output from the second. This will be implemented with a command in the near future, see issue [#11](https://github.com/S-B99/KAMI/issues/11) +*** +
## Troubleshooting @@ -100,10 +116,14 @@ This will be implemented with a command in the near future, see issue [#11](http
Please read this before opening an issue +*** + Please reference the main [troubleshooting page](docs/TROUBLESHOOTING.md) 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. +*** +
### Building