aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorthedarkcolour <30441001+thedarkcolour@users.noreply.github.com>2020-06-20 17:47:55 -0700
committerthedarkcolour <30441001+thedarkcolour@users.noreply.github.com>2020-06-20 17:47:55 -0700
commit98458685ef50708edb3aebc4d72366d4bc41d71a (patch)
tree71623afce49865f09312af034df6d39bd4f3c058 /README.md
parent7afdd597f4eb82de491fe37bd9b802f44d13d650 (diff)
downloadKotlinForForge-98458685ef50708edb3aebc4d72366d4bc41d71a.tar.gz
KotlinForForge-98458685ef50708edb3aebc4d72366d4bc41d71a.tar.bz2
KotlinForForge-98458685ef50708edb3aebc4d72366d4bc41d71a.zip
Update Kotlin for Forge 1.3.0
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/README.md b/README.md
index ef3807f..8a00d7d 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,14 @@ Makes Kotlin forge-friendly by doing the following:
- Provides `KotlinLanguageProvider` to allow usage of object declarations as @Mod targets.
- Provides `AutoKotlinEventBusSubscriber` to allow usage of object declarations as @Mod.EventBusSubscriber targets.
- Provides useful utility functions and constants
+- Provides its own implementation of the Forge eventbus to work with KCallables and reified type parameters
+- Provides sided property delegates and object holder property delegates
+
+An example mod is provided at the [KotlinModdingSkeleton repository](https://github.com/thedarkcolour/KotlinModdingSkeleton).
+If you aren't sure where to start, make a fork of the KotlinModdingSkeleton repository.
+```git
+git clone https://github.com/thedarkcolour/KotlinModdingSkeleton.git
+```
To implement in your project, paste the following into your build.gradle:
```groovy
@@ -14,7 +22,7 @@ buildscript {
}
dependencies {
// Make sure to use the correct version
- classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.4-M1"
+ classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:1.4-M2"
}
}
@@ -33,7 +41,7 @@ repositories {
dependencies {
// Use the latest version of KotlinForForge
- implementation 'thedarkcolour:kotlinforforge:1.2.2'
+ implementation 'thedarkcolour:kotlinforforge:1.2.3'
}
compileKotlin {
@@ -44,11 +52,6 @@ compileKotlin {
languageVersion = '1.4'
apiVersion = '1.4'
}
-
- // Required to run in dev environment
- copy {
- from "$buildDir/classes/kotlin/main" into "$buildDir/classes/java/main"
- }
}
```
Then, change the following to your mods.toml file: