caskd
/
kami-blue
forked from RepoMirrors/kami-blue
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
kami-blue/README.md

3.1 KiB
Raw Blame History

KAMI

Issues Discord

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.

  1. Install forge
  2. Navigate to your .minecraft directory.
    • Windows: %appdata%/.minecraft
    • Linux: ~/.minecraft
  3. Navigate to the mods directory. If it doesn't exist, create it.
  4. Obtain the KAMI .jar file.
  5. 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

By using the command prefix <prefix> or after having ran KAMI (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.

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

You can build by running autobuild.bat, or if you prefer the manual way, do the following:

gradlew.bat build
cd build/libs

To copy the release jar in build/libs you can run autocopy.bat or, if you prefer doing it manually, find a file KAMI-<minecraftVersion>-<kamiVersion>-release.jar which you can copy to the mods folder of a minecraft instance that has forge installed.

Thank you

ZeroMemes for Alpine

ronmamo for Reflections

The minecraft forge team for forge