-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
56e7c2b
commit c042435
Showing
1 changed file
with
16 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,20 @@ | ||
# Mindustry Kotlin Ui Lib | ||
An utility library for mindustry mods. | ||
|
||
Provides a set of inline extension functions that allow you to build mindustry ui in an idiomatic & optimized way. | ||
Also provides some utility extension functions that arc lacks. | ||
|
||
May not be compatible with other (non-mindustry) arc projects. | ||
May not be compatible with other (non-mindustry) arc projects. | ||
|
||
***Note: this library will only work with mods written in kotlin!*** | ||
|
||
# Adding this dependency | ||
In your `build.gradle` file: | ||
* add `maven { url("https://jitpack.io") }` to the `repositories {}` block | ||
(it should already be here if you're using the official mod template) | ||
* add `implementation "com.github.mnemotechnician:MKUI:TAG"` (replace `TAG` with the the latest tag in this repo) to the `dependencies {}` block | ||
|
||
## in case you're using kotlin dls: | ||
Ignore this paragraph if you're using the official kotlin mod template | ||
* use `maven("https://jitpack.io")` in the first step | ||
* use `implementation("com.github.mnemotechnician:MKUI:TAG")` in the second step |