Skip to content

Commit

Permalink
First Steady Release
Browse files Browse the repository at this point in the history
  • Loading branch information
Marten-Mrfc authored May 6, 2024
1 parent 621cd46 commit 726b6ce
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@



Lirand API allows you to develop Spigot plugins faster, easier
Lirand API allows you to develop PaperMC plugins faster, easier
and more Kotlin-like way.

It includes a lot of cool features like:
Expand All @@ -20,17 +20,15 @@ It includes a lot of cool features like:
- A bunch of useful extensions for working with chat, events, items, inventories, etc.
- Scoreboard builder (experimental)

And most importantly **it is backward compatible via 1.16+ Minecraft versions**.


## Declaring a dependency via Gradle

Requires java version: 21
Add the following to your build script:
```kotlin
repositories {
// ...
mavenCentral()
maven("https://jitpack.io")
maven("https://javadoc.jitpack.io")
maven("https://repo.codemc.io/repository/maven-snapshots/")
maven("https://libraries.minecraft.net")
// ...
Expand All @@ -40,14 +38,14 @@ dependencies {
// ...
implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.6.10")
implementation("org.jetbrains.kotlinx:kotlinx-coroutines-jdk9:1.6.0")
implementation("com.github.dyam0:LirandAPI:VERSION")
implementation("com.github.marten-mrfc:LirandAPI:VERSION")
compileOnly("com.mojang:brigadier:1.0.18")
// ...
}
```
Replace `VERSION` with the version of Lirand API you need.
Also you can build the latest snapshot on the [JitPack](https://jitpack.io/#dyam0/LirandAPI) and use it as a dependency.
Also you can build the latest snapshot on the [JitPack](https://jitpack.io/#marten-mrfc/LirandAPI) and use it as a dependency.

I highly recommend you to shade this dependency into your Jar file
as well as some dependencies of Lirand API
([MCCoroutine](https://github.com/Shynixn/MCCoroutine) and [AnvilGUI](https://github.com/WesJD/AnvilGUI)).
([MCCoroutine](https://github.com/Shynixn/MCCoroutine) and [AnvilGUI](https://github.com/WesJD/AnvilGUI)).

0 comments on commit 726b6ce

Please sign in to comment.