aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorthedarkcolour <30441001+thedarkcolour@users.noreply.github.com>2019-11-09 11:12:21 -0800
committerthedarkcolour <30441001+thedarkcolour@users.noreply.github.com>2019-11-09 11:12:21 -0800
commit00d859187a8ca433028634e56bd30243ddaa69a4 (patch)
tree0582bdb9aa28e1117c72332535f3805ed8864712 /README.md
parent7716f30272565f750182d58da753cd4cffb88761 (diff)
downloadKotlinForForge-00d859187a8ca433028634e56bd30243ddaa69a4.tar.gz
KotlinForForge-00d859187a8ca433028634e56bd30243ddaa69a4.tar.bz2
KotlinForForge-00d859187a8ca433028634e56bd30243ddaa69a4.zip
Adding files
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 27 insertions, 6 deletions
diff --git a/README.md b/README.md
index a31245d..860531b 100644
--- a/README.md
+++ b/README.md
@@ -2,18 +2,39 @@
Makes Kotlin forge-friendly.
To implement in your project, add the following to your build.gradle:
-```
+```groovy
repositories {
maven {
- name = "kotlinforforge"
- url = "https://cdn.jsdelivr.net/gh/thedarkcolour/KotlinForForge@master/"
+ name = 'kotlinforforge'
+ url = 'https://thedarkcolour.github.io/KotlinForForge/'
}
}
dependencies {
- implementation 'thedarkcolour:kotlinforforge:0.1.14'
+ implementation 'thedarkcolour:kotlinforforge:1+'
}
```
-Then, in your mods.toml file, change modLoader to "kotlinforforge".
+Then, add the following to your mods.toml file:
+```toml
+modLoader="kotlinforforge"
+loaderVersion="[1,)"
+
+[[dependencies.YOUR_MODID]]
+ modId="kotlinforforge"
+ mandatory=true
+ versionRange="[1,)"
+ ordering="NONE"
+ side="BOTH"
+```
+
+Currently, this mod supports object declarations with @Mod and @EventBusSubscriber annotations.
+
+It is recommended that you use
+```net.minecraftforge.registries.DeferredRegister```
+instead of
+```net.minecraftforge.registries.ObjectHolder```
-Currently, this mod allows you to have @Mod object declarations and @Mod.EventBusSubscriber declarations.
+You must use
+```thedarkcolour.kotlinforforge.KotlinModLoadingContext```
+instead of
+```net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext```