10604de4ba | ||
---|---|---|
.github | ||
assets | ||
docs | ||
gradle/wrapper | ||
src/main | ||
.gitignore | ||
.travis.yml | ||
LICENSE.md | ||
README.md | ||
autocopy.bat | ||
build.gradle | ||
gradle.properties | ||
gradlew | ||
gradlew.bat |
README.md
KAMI Blue
A minecraft utility mod for anarchy servers.
S-B99 (features-master) | S-B99 (master) | 086 (upstream) | |
---|---|---|---|
Build Status | |||
Issues | |||
Media | |||
Version |
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.
See 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 along the yellow bar above ^
Scroll alll the way up
Status
Click to view current development status
Everything here is planned for sure, along with here
This is currently in slowed development. Maintainance and further development is planned in the next couple months.
Preview
Installing
KAMI Blue is a forge mod. Start by downloading the latest version of 1.12.2 forge.
- Install forge
- Go to your
.minecraft
directory.- Linux:
~/.minecraft
- Windows:
%appdata%/.minecraft
- Linux:
- Navigate to the
mods
directory. If it doesn't exist, create it. - Get the KAMI Blue
.jar
file. - 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 <module> <key>
.
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 <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.
Change Custom Chat ending
Edit line 19 in kami/src/main/java/me/zeroeightysix/kami/module/modules/misc/CustomChat.java
Change the \u23D0
characters to something else you want, use this website to do it.
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
Troubleshooting
Please read this before opening an issue
Please reference the main troubleshooting page
If you have an issue or problem and it's not listed there, please open a new issue and a contributor will help you further.
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 <args>
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-<kamiVersion>-**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
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-<kamiVersion>-**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.
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
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
git clone https://github.com/S-B99/KAMI/
cd KAMI
Import KAMI Blue into your IDE of choice.
gradlew.bat setupDecompWorkspace
gradlew.bat genIntellijRuns #for intellij
gradlew.bat 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.bat runClient
to run KAMI Blue.
Thank you
zeroeightysix for the original KAMI
ronmamo for Reflections
The Minecraft Forge team for forge