Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ChloePrime committed Dec 3, 2020
1 parent 2fc1f63 commit 8123f3e
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,19 @@
# Forgelin
Fork of [Emberwalker's Forgelin](https://github.com/Emberwalker/Forgelin).
Fork of [Shadowfact's Forgelin](https://github.com/shadowfacts/Forgelin).

## Additions
- Shades the Kotlin standard library, runtime, coroutines-core, and reflect libraries so you don't have to.
- Shades kotlin compiler and includes a jsr-223 script engine so you can write CNPC scripts with kotlin.
- Provides a Forge `ILanguageAdapter` for using Kotlin `object` classes as your main mod class.

## Build
After build, open the jar with WinRAR/7Zip and delete `META-INF/versions` folder,
or your artifact will not be loaded by FML.

**Why:** Those folder contains class files that is valid only after Java9+. and when FML passes these classes to coremods,
the `ClassReader`s inside those coremods will throw exceptions, causing the jar to be thought corrupted.


## Usage
```groovy
repositories {
Expand All @@ -21,4 +30,4 @@ dependencies {

All versions can be seen [here](http://maven.shadowfacts.net/net/shadowfacts/Forgelin/).

**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.

0 comments on commit 8123f3e

Please sign in to comment.