diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 33 |
1 files changed, 27 insertions, 6 deletions
@@ -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``` |