KotlinForForge

KO | EN

gitlite — search

#python #react #ai #typescript #llm #go #machine-learning #rust #nodejs #java #vue #security #mcp #openai

(★ 248)

Makes Kotlin forge-friendly.

File Explorer

Download Latest Version (.zip)

- - publish-maven.yml
  - publish-mod.yml
- - build.gradle.kts
- - build.gradle.kts
- - build.gradle.kts
- build.gradle.kts
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- libs.versions.toml
.gitignore
build.gradle.kts
changelog.md
gradle.properties
gradlew
gradlew.bat
LICENSE
README.md
settings.gradle.kts

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# KotlinForForge
**Instructions for other versions: [1.20.6-1.21.8](https://github.com/thedarkcolour/KotlinForForge/blob/5.x/README.md) | [1.19.3-1.20.4](https://github.com/thedarkcolour/KotlinForForge/blob/4.x/README.md) | [1.19.2](https://github.com/thedarkcolour/KotlinForForge/blob/3.x/README.md) | [1.14-1.16.5](https://github.com/thedarkcolour/KotlinForForge/blob/1.x/README.md) | [1.17-1.17.1](https://github.com/thedarkcolour/KotlinForForge/blob/2.x/README.md)**

Makes Kotlin Forge-friendly by doing the following:
- Provides Kotlin stdlib, reflection, JSON serialization, and coroutines libraries.
- Provides `KotlinLanguageLoader` to allow usage of object declarations as @Mod targets.
- Provides `AutoKotlinEventBusSubscriber` to allow usage of object declarations as @EventBusSubscriber targets.
- Provides useful utility functions and constants

To see which versions of the Kotlin libraries is bundled with a particular version of KFF, check the [DEPENDENCY CHART](https://docs.google.com/spreadsheets/d/1v8K90PBa5qPFrlHBA8PSqlBTYCcp078o5E2XQbt5BUs/edit?usp=sharing).

Have questions or suggestions? Join the [DISCORD SERVER](https://discord.gg/tmVmZtx).

[MIGRATION GUIDE](https://gist.github.com/thedarkcolour/5590f46b0d4d8ca692add2934d05e642)

Forge support Not yet implemented ~~A 1.21.10 Forge example mod is provided here: [1.21 KotlinModdingSkeleton Forge repository](https://github.com/thedarkcolour/KotlinModdingSkeleton/tree/1.21-forge)~~  
A 1.21.10 NeoForge example mod is provided here: [1.21.10 KotlinModdingSkeleton NeoForge repository](https://github.com/thedarkcolour/KotlinModdingSkeleton/tree/1.21.10-neoforge)

If you aren't sure where to start, make a fork of the KotlinModdingSkeleton repository (replace BRANCH with your version)
```git
git clone --branch BRANCH https://github.com/thedarkcolour/KotlinModdingSkeleton.git
```

To implement in an existing project, merge the following into your build script:
<details>
        <summary><b>Gradle</b></summary>

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

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

dependencies {
    // Adds KFF as dependency and Kotlin libs (use the variant matching your mod loader)
    // FORGE (1.21+ ONLY) NOT IMPLEMENTED YET
	//implementation 'thedarkcolour:kotlinforforge:6.0.0'
    // NEOFORGE
    implementation 'thedarkcolour:kotlinforforge-neoforge:6.0.0'
}
// ONLY ON REGULAR FORGE
sourceSets.each {
	def dir = layout.buildDirectory.dir("sourcesSets/$it.name")
	it.output.resourcesDir = dir
	it.java.destinationDirectory = dir
	it.kotlin.destinationDirectory = dir
}
```
</details>

<details>
        <summary><b>Gradle (Kotlin)</b></summary>

```kotlin
plugins {
    // Adds the Kotlin Gradle plugin
    kotlin("jvm") version "2.2.20"
    // OPTIONAL Kotlin Serialization plugin
    //kotlin("plugin.serialization") version "2.2.20"
}

repositories {
    // Add KFF Maven repository
    maven {
        name = "Kotlin for Forge"
        setUrl("https://thedarkcolour.github.io/KotlinForForge/")
    }
}

dependencies {
    // Adds KFF as dependency and Kotlin libs (use the variant matching your mod loader)
    // FORGE (1.21+ ONLY) NOT IMPLEMENTED YET
    // implementation("thedarkcolour:kotlinforforge-neoforge:6.0.0")
    // NEOFORGE
    implementation("thedarkcolour:kotlinforforge-neoforge:6.0.0")
}
// ONLY ON REGULAR FORGE
sourceSets.configureEach {
    val dir = layout.buildDirectory.dir("sourcesSets/$name")
    output.setResourcesDir(dir)
    java.destinationDirectory.set(dir)
    kotlin.destinationDirectory.set(dir)
}
```
</details>

Then, change the following to your neoforge.mods.toml file:
```toml
modLoader="kotlinforforge"
# Change this if you require a certain version of KotlinForForge
loaderVersion="[6.0,)"
```

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

KotlinForForge

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

KotlinForForge

File Explorer

Today's picks

Was this content helpful?

Recent Feedback

Download README