RepoMirrors/kami-blue

Fork 1

mirror of https://github.com/kami-blue/client synced 2024-12-22 07:01:01 +00:00

Bella f2cdd0c9c9 rearrange reamde

2020-01-18 20:29:01 -05:00

11 KiB

Raw Blame History

KAMI Blue

A minecraft utility mod for anarchy servers.

	S-B99 (feature/master)	086 (upstream)
Build Status
Media
Version

Please consider donating to help continue this project and get a unique cape in game.

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 The latest 1.12.2 jar is this.

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 or click here

Status

Click to view current development status

Please see the issues page for planned features and bugs to fix.

This is currently in active development. When issues are being closed is by milestone, and bugs are higher priority, though there aren't any that break anything completely.

Installing

To install drag the VERSION-release.jar to your mods/1.12.2 folder

Click to see more detailed installing instructions

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
- OS X: ~/Library/Application Support/minecraft
Navigate to the mods directory. If it doesn't exist, create it.
Get the KAMI Blue .jar file.
- By downloading it: see releases
- By building it: see building.
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.

Preview

Click on images to expand

Capes in game

Rich presence on discord

Shulker preview being used in chat

CrystalAura targeting

Building and Contributing

Click to see instructions

If you can't figure these instructions out, please see this before asking for help.

Please make sure to restart your IDE in after running all setup commands

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 beforehand

On Windows, 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 setupDecompWorkspace
./gradlew genIntellijRuns #for intellij
./gradlew 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 runClient to run KAMI Blue.

Note: I don't recommend using runClient as sometimes it's wonky. If you have issues then do ./gradlew clean

If you get build errors see this: troubleshooting page

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