Updated README.md
This commit is contained in:
parent
5cb47eed7c
commit
39ba21402e
33
README.md
33
README.md
|
@ -1,24 +1,45 @@
|
||||||
# Forgelin
|
# Forgelin
|
||||||
Fork of [Emberwalker's Forgelin](https://github.com/Emberwalker/Forgelin).
|
|
||||||
|
Fork of [Shadowfacts Forgelin](https://github.com/shadowfacts/Forgelin).
|
||||||
|
|
||||||
## Additions
|
## Additions
|
||||||
|
|
||||||
- Shades the Kotlin standard library, runtime, coroutines-core, and reflect libraries so you don't have to.
|
- Shades the Kotlin standard library, runtime, coroutines-core, and reflect libraries so you don't have to.
|
||||||
- Provides a Forge `ILanguageAdapter` for using Kotlin `object` classes as your main mod class.
|
- Provides a Forge `ILanguageAdapter` for using Kotlin `object` classes as your main mod class.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
```groovy
|
```groovy
|
||||||
repositories {
|
repositories {
|
||||||
jcenter()
|
jcenter()
|
||||||
maven {
|
maven { url 'https://jitpack.io' }
|
||||||
url "http://maven.shadowfacts.net/"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
dependencies {
|
dependencies {
|
||||||
compile group: "net.shadowfacts", name: "Forgelin", version: "LATEST_VERSION"
|
implementation 'com.github.Licious17:Forgelin:1.9.0'
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
All versions can be seen [here](http://maven.shadowfacts.net/net/shadowfacts/Forgelin/).
|
```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"
|
||||||
|
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
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.
|
**Note:** You must have the `jcenter()` call in your `repositories` block. JCenter is used to host the Kotlin coroutines libraries.
|
||||||
|
|
Loading…
Reference in New Issue