Forgelin/README.md

46 lines
1.1 KiB
Markdown
Raw Normal View History

2016-08-06 14:40:14 +00:00
# Forgelin
2021-08-02 15:10:24 +00:00
Fork of [Shadowfacts Forgelin](https://github.com/shadowfacts/Forgelin).
2016-08-06 14:40:14 +00:00
## Additions
2021-08-02 15:10:24 +00:00
- Shades the Kotlin standard library, runtime, coroutines-core, and reflect libraries so you don't have to.
2016-11-14 15:53:45 +00:00
- Provides a Forge `ILanguageAdapter` for using Kotlin `object` classes as your main mod class.
2016-08-06 14:40:14 +00:00
## Usage
2021-08-02 15:10:24 +00:00
2016-08-06 14:40:14 +00:00
```groovy
repositories {
jcenter()
2021-08-02 15:10:24 +00:00
maven { url 'https://jitpack.io' }
2016-08-06 14:40:14 +00:00
}
dependencies {
2021-08-02 15:10:24 +00:00
implementation 'com.github.Licious17:Forgelin:1.9.0'
}
```
```kotlin
@Mod(
modid = MyMod.MOD_ID,
name = MyMod.MOD_NAME,
version = MyMod.VERSION,
modLanguageAdapter = "net.shadowfacts.forgelin.KotlinAdapter",
acceptableRemoteVersions = "*",
acceptedMinecraftVersions = "[1.12.2]"
)
object MyMod {
const val MOD_ID = "mymod"
const val MOD_NAME = "MyMod"
const val VERSION = "1.0.0"
2016-08-06 14:40:14 +00:00
}
```
2021-08-02 15:10:24 +00:00
Full credits to the og authors this simply updates Kotlin and the libraries version.
[EmberWalker](https://github.com/Emberwalker)
[ShadowFacts](https://github.com/shadowfacts)
**Note:** You must have the `jcenter()` call in your `repositories` block. JCenter is used to host the Kotlin coroutines libraries.