RepoMirrors/kami-blue
1
0
Fork 1
mirror of https://github.com/kami-blue/client synced 2025-03-18 08:39:16 +00:00
Code Issues Releases Wiki Activity

move everything over to blue.bella.wtf

Browse Source
This commit is contained in:
Bella 2020-01-31 18:07:56 -05:00
parent 1e4c1a07f4
commit d002ec80b7
3 changed files with 2 additions and 242 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.github/CONTRIBUTING/CONTRIBUTING_GUIDELINES.md vendored
View File

@ -1,8 +0,0 @@
# Contributing Guidelines
## Creating a pull request
If you are proposing a pull request, please make sure the change won't interfere with anything current, and that it is useful.
## Creating an issue
If you want to request a feature use the Feature Issue template, and the Bug Report template for reporting a bug or crash.
#### Please be respectful of others, and use a polite tone

206
README.md
View File

@ -22,211 +22,9 @@
Please consider donating to help continue this project and get a unique cape in game.
Also note Baritone is no longer included. Download the standalone jar [from here](https://github.com/cabaletta/baritone/releases/tag/v1.2.10).
## Help and documentation
<details>
<summary>Click to view disclaimers</summary>
***
This is by no means a finished project, nor is it a "cheat" or "hack" for anything, it is a *utility* mod.
See [forgehax](https://github.com/fr1kin/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.
***
</details>
## Installing
To install drag the `VERSION-release.jar` to your `mods/1.12.2` folder
<details>
<summary>Click to see more detailed installing instructions</summary>
KAMI Blue is a forge mod. Start by downloading the latest version of [1.12.2 forge](https://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.12.2.html).
1. Install forge
2. Go to your `.minecraft` directory.
* **Linux**: `~/.minecraft`
* **Windows**: `%appdata%/.minecraft`
* **OS X**: `~/Library/Application Support/minecraft`
3. Navigate to the `mods` directory. If it doesn't exist, create it.
4. Get the KAMI Blue `.jar` file.
* By **downloading** it: see [releases](../../releases)
* By **building** it: see [building](#building).
5. Drag the `-release.jar` file into your mods directory.
</details>
## FAQ
<details>
<summary>Click to see the frequently asked questions or basic stuff</summary>
***
##### 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`.
You can unbind modules with backspace in the GUI or by running `.bind <module> none`
##### 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.
***
</details>
## Preview
***
### Click on images to expand
Capes in game
<img src="https://raw.githubusercontent.com/S-B99/kamiblue/assets/assets/readme/capes.png" width="500"/>
Rich presence on discord
<img src="https://raw.githubusercontent.com/S-B99/kamiblue/assets/assets/readme/rpc.png" width="500"/>
Shulker preview being used in chat
<img src="https://raw.githubusercontent.com/S-B99/kamiblue/assets/assets/readme/shulkerChat.png" width="500"/>
CrystalAura targeting
<img src="https://raw.githubusercontent.com/S-B99/kamiblue/assets/assets/readme/crystalAura.png" width="500"/>
***
## Status
<details>
<summary>Click to view current development status</summary>
***
Please see the [issues](https://github.com/S-B99/kamiblue/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.
***
</details>
## Building and Contributing
<details>
<summary>Click to see instructions</summary>
***
If you can't figure these instructions out, please see [this](https://youtu.be/PfmlNiHonV0) 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/kamiblue/
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](docs/TROUBLESHOOTING.md)
***
***
### Building
***
#### Linux
You can build by running these commands (without the <>) in a terminal.
```
git clone https://github.com/S-B99/kamiblue/
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](https://github.com/S-B99/kamiblue/issues/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.
***
If you get build errors see this: [troubleshooting page](docs/TROUBLESHOOTING.md)
***
</details>
Please go to [https://blue.bella.wtf](https://blue.bella.wtf) for documentation and help.
## Thank you

30
docs/TROUBLESHOOTING.md
View File

@ -1,30 +0,0 @@
# Troubleshooting
This page is meant to explain how to solve common issues when installing or using KAMI. If you experience an issue and it's not listed here, please [open a new issue](https://github.com/zeroeightysix/KAMI/issues/new) and a contributor will help you further.
## Setup
###### Could not find tools.jar
If you encounter this error when building, you most likely don't have the Java Development Kit (JDK) installed.
Head over to [here](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html) to download the oracle JDK. Install it and try again.
###### Minecraft not loading at all
What `.jar` are you using in your `mods` folder? Make sure to use the one that ends with `-release` (`VERSION-release.jar`)
###### Just doesn't work when using runClient
Don't use that, try building and running forge normally
###### Crashes before game starts with spongepowered error
Make sure your workspace is clean and run
./gradlew setupDecompWorkspace
./gradlew build mkdir rmOld copy
## Crashes in-game
**Please make sure you're on the latest version of forge before proceeding!**
## When using Intellij / Eclipse
Crashes in game but it worked fine / errors link to files you haven't changed
Delete your .gradle or gradle cache or whatever it's called on windows