Skip to content

Latest commit

 

History

History
48 lines (41 loc) · 1.92 KB

README.md

File metadata and controls

48 lines (41 loc) · 1.92 KB

KotlinForForge

Instructions for other versions: 1.19.3 | 1.14-1.16.5 | 1.17-1.17.1

Makes Kotlin Forge-friendly by doing the following:

  • Provides Kotlin stdlib, reflection, JSON serialization, and coroutines 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 useful utility functions and constants

An example mod is provided at the KotlinModdingSkeleton repository.

If you aren't sure where to start, make a fork of the KotlinModdingSkeleton repository (replace BRANCH with your version)

git clone --branch BRANCH https://github.com/thedarkcolour/KotlinModdingSkeleton.git

To implement in an existing project, merge the following into your build.gradle:

plugins {
    // Adds the Kotlin Gradle plugin
    id 'org.jetbrains.kotlin.jvm' version '1.8.21'
    // OPTIONAL Kotlin Serialization plugin
    id 'org.jetbrains.kotlin.plugin.serialization' version '1.8.21'
}

repositories {
    // Add KFF Maven repository
    maven {
        name = 'Kotlin for Forge'
        url = 'https://thedarkcolour.github.io/KotlinForForge/'
    }
}

dependencies {
    // Adds KFF as dependency and Kotlin libs
    implementation 'thedarkcolour:kotlinforforge:3.12.0'
}

Then, change the following to your mods.toml file:

modLoader="kotlinforforge"
# Change this if you require a certain version of KotlinForForge
loaderVersion="[3,)"

Use thedarkcolour.kotlinforforge.forge.MOD_CONTEXT
instead of net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext