diff options
author | thedarkcolour <30441001+thedarkcolour@users.noreply.github.com> | 2019-12-14 16:38:28 -0800 |
---|---|---|
committer | thedarkcolour <30441001+thedarkcolour@users.noreply.github.com> | 2019-12-14 16:38:28 -0800 |
commit | 04416841613b1f795a3dda6d861f1cded9600bac (patch) | |
tree | 913d56856f3bbb96c499a5b048378cc17b2c61d6 /README.md | |
parent | 4390d994bbee18ef5ed77f2f5429e3079af84b40 (diff) | |
download | KotlinForForge-04416841613b1f795a3dda6d861f1cded9600bac.tar.gz KotlinForForge-04416841613b1f795a3dda6d861f1cded9600bac.tar.bz2 KotlinForForge-04416841613b1f795a3dda6d861f1cded9600bac.zip |
Adding files
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 19 |
1 files changed, 3 insertions, 16 deletions
@@ -3,7 +3,7 @@ Makes Kotlin forge-friendly by doing the following: - Provides the Kotlin libraries. - Provides `KotlinLanguageProvider` to allow usage of object declarations as @Mod targets. - Provides `AutoKotlinEventBusSubscriber` to allow usage of object declarations as @Mod.EventBusSubscriber targets. -- Provides `KtDeferredRegister` as an alternative to `DeferredRegister` that returns non-null values +- Provides useful top-level utility functions and constants To implement in your project, add the following to your build.gradle: ```groovy @@ -15,6 +15,7 @@ repositories { } dependencies { + // Uses the latest version of KotlinForForge implementation 'thedarkcolour:kotlinforforge:1+' } ``` @@ -22,23 +23,9 @@ 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``` - -You must use +Use ```thedarkcolour.kotlinforforge.KotlinModLoadingContext``` instead of ```net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext``` |