|
||
---|---|---|
docs | ||
gradle/wrapper | ||
src/main | ||
.gitignore | ||
.travis.yml | ||
README.md | ||
build.gradle | ||
gradle.properties | ||
gradlew | ||
gradlew.bat |
README.md
KAMI
A minecraft utility mod for anarchy servers.
See 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.
Installing
KAMI is a forge mod. Start by downloading the latest version of forge.
- Install forge
- Navigate to your
.minecraft
directory.- Windows:
%appdata%/.minecraft
- Linux:
~/.minecraft
- Windows:
- Navigate to the
mods
directory. If it doesn't exist, create it. - Obtain the KAMI
.jar
file. - Place the
.jar
file in your mods directory.
How do I
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>
.
Change command prefix
After having ran KAMI (make sure it's closed), edit kami.settings
and find command_prefix
to change the prefix.
Troubleshooting
Please reference the main troubleshooting page
If you experience an issue and it's not listed there, please open a new issue and a contributor will help you further.
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 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
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 a file KAMI-<minecraftVersion>-<kamiVersion>-full.jar
which you can copy to the mods
folder of a minecraft instance that has forge installed.