Skip to content

Latest commit

 

History

History
139 lines (90 loc) · 5.05 KB

README.md

File metadata and controls

139 lines (90 loc) · 5.05 KB

KAMI

Build Status Issues Discord

A Minecraft utility mod for anarchy servers.

The Forge 1.12.2 version is in slowed development. You can go to the fabric-1.14 branch to see an actively developed Fabric version.

Please note Baritone is not included in 1.12.2 Forge. Get it from here.

Preview

Click to view images

GUI

ShulkerPreview

CrystalAura

Installing

The 1.12.2 version of KAMI is a Forge mod. Start by downloading the latest version of 1.12.2 Forge.

  1. Install Forge
  2. Navigate to your .minecraft directory.
    • Linux: ~/.minecraft
    • Windows: %appdata%/.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>.

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 (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

To ask for help, join the Discord

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 -b master https://github.com/zeroeightysix/KAMI/
cd KAMI

On GNU/Linux, run chmod +x gradlew beforehand.

On Windows, for the following commands use gradlew.bat instead of ./gradlew

Of-course you can also use a Gradle installation if you for some reason want another version of gradle

./gradlew setupDecompWorkspace

Import KAMI into your IDE of choice.

If you use IntelliJ, import from the build.gradle file and run ./gradlew genIntellijRuns

If you use Eclipse run ./gradlew eclipse

If you do not wish to run from an IDE, use ./gradlew runClient to run KAMI.

Building

Linux

You can build by running these commands (without the <>) in a terminal.

git clone -b master https://github.com/zeroeightysix/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[1] in that directory, and copy copies the build release to the mods/1.12.2 directory.

[1]rmOld removes any jars ending in KAMI*-release.jar, which is the format KAMI 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-<minecraftVersion>-<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.

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-<minecraftVersion>-<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.

Thank you

ZeroMemes for Alpine

ronmamo for Reflections

The Fabric Team for Fabric and Yarn

The Minecraft Forge team for Forge