mirror of https://github.com/kami-blue/client
Merge pull request #126 from S-B99/update-gradlew-squashed
Update gradlew to be more automatic and user friendly
This commit is contained in:
commit
e5640b5fdb
Binary file not shown.
After Width: | Height: | Size: 21 KiB |
67
README.md
67
README.md
|
@ -3,7 +3,13 @@
|
|||
[![Issues](https://img.shields.io/github/issues/zeroeightysix/kami.svg)](https://github.com/zeroeightysix/kami/issues)
|
||||
[![Discord](https://img.shields.io/badge/chat-on%20discord-brightgreen.svg)](http://discord.gg/9hvwgeg)
|
||||
|
||||
A minecraft utility mod for anarchy servers.
|
||||
## A minecraft utility mod for anarchy servers.
|
||||
|
||||
Development has slowed down considerably. KAMI will likely no longer be updated. Pull requests are still welcome.
|
||||
|
||||
See [forgehax](https://github.com/fr1kin/forgehax) for a more polished equivalent. Some features in KAMI may be based on those of forgehax, as I sometimes used it as reference.
|
||||
|
||||
Please note Baritone is no longer included. Download the standalone jar [from here](https://github.com/cabaletta/baritone/releases).
|
||||
|
||||
Development has slowed down considerably. KAMI will likely no longer be updated. Pull requests are still welcome.
|
||||
|
||||
|
@ -13,6 +19,8 @@ Development has slowed down considerably. KAMI will likely no longer be updated.
|
|||
<summary>Click to view images</summary>
|
||||
|
||||
![GUI](.github/IMAGES/gui.png)
|
||||
|
||||
![ShulkerPreview](.github/IMAGES/shulkerChat.png)
|
||||
|
||||
![CrystalAura](.github/IMAGES/crystalAura.png)
|
||||
|
||||
|
@ -23,8 +31,8 @@ Development has slowed down considerably. KAMI will likely no longer be updated.
|
|||
KAMI is a forge mod. Start by downloading the latest version of [1.12.2 forge](https://files.minecraftforge.net/).
|
||||
1. Install forge
|
||||
2. Navigate to your `.minecraft` directory.
|
||||
* **Windows**: `%appdata%/.minecraft`
|
||||
* **Linux**: `~/.minecraft`
|
||||
* **Windows**: `%appdata%/.minecraft`
|
||||
3. Navigate to the `mods` directory. If it doesn't exist, create it.
|
||||
4. Obtain the KAMI `.jar` file.
|
||||
* By **downloading** it: see [releases](../../releases)
|
||||
|
@ -42,6 +50,8 @@ The default prefix is `.`. Commands are used through chat, use `.commands` for a
|
|||
##### 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.
|
||||
|
||||
|
@ -66,29 +76,52 @@ Of-course you can also use a Gradle installation if you for some reason want ano
|
|||
```
|
||||
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`
|
||||
Import KAMI into your IDE of choice.
|
||||
|
||||
If you use IntelliJ, import from the `build.gradle` file and run `gradlew.bat genIntellijRuns`
|
||||
|
||||
If you use Eclipse run `gradlew.bat eclipse`
|
||||
|
||||
If you do not wish to run from an IDE, use `gradlew.bat runClient` to run KAMI.
|
||||
|
||||
### Building
|
||||
#### Windows
|
||||
You can build by running `autobuild.bat` and then `autocopy.bat`, or if you prefer the manual way, do the following:
|
||||
#### Linux
|
||||
You can build by running these commands (without the <>) in a terminal.
|
||||
```
|
||||
git clone 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\* 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 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
|
||||
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.
|
||||
#### Linux
|
||||
```
|
||||
git clone https://github.com/zeroeightysix/KAMI.git
|
||||
cd KAMI
|
||||
chmod +x auto*
|
||||
./autobuild
|
||||
mkdir ~/.minecraft/mods
|
||||
./autocopy
|
||||
```
|
||||
Note: This assumes your minecraft folder is in the default location under your home folder.
|
||||
|
||||
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](https://github.com/ZeroMemes) for [Alpine](https://github.com/ZeroMemes/Alpine)
|
||||
|
|
|
@ -1 +0,0 @@
|
|||
start gradlew.bat build
|
4
autocopy
4
autocopy
|
@ -1,4 +0,0 @@
|
|||
mkdir ~/.minecraft/mods/
|
||||
mkdir ~/.minecraft/mods/1.12.2/
|
||||
rm ~/.minecraft/mods/1.12.2/KAMI*
|
||||
cp build/libs/*-release.jar ~/.minecraft/mods/1.12.2/
|
31
build.gradle
31
build.gradle
|
@ -1,3 +1,32 @@
|
|||
// make folders
|
||||
|
||||
task mkdir {
|
||||
group = "kami"
|
||||
doLast {
|
||||
mkdir System.getProperty("user.home") + "/.minecraft/mods/1.12.2/"
|
||||
}
|
||||
}
|
||||
|
||||
// delete old versions
|
||||
|
||||
task rmOld(type: Delete) {
|
||||
group = "kami"
|
||||
delete fileTree(System.getProperty("user.home") + "/.minecraft/mods/1.12.2/").matching {
|
||||
include "*-release.jar"
|
||||
}
|
||||
}
|
||||
|
||||
// copy file
|
||||
|
||||
task copy(type: Copy) {
|
||||
group = "kami"
|
||||
from file("build/libs/")
|
||||
include '*-release.jar'
|
||||
into file(System.getProperty("user.home") + "/.minecraft/mods/1.12.2/")
|
||||
}
|
||||
|
||||
// forge's stuff
|
||||
|
||||
buildscript {
|
||||
repositories {
|
||||
jcenter()
|
||||
|
@ -135,4 +164,4 @@ jar {
|
|||
}
|
||||
}
|
||||
|
||||
build.dependsOn(shadowJar)
|
||||
build.dependsOn(shadowJar)
|
||||
|
|
Loading…
Reference in New Issue