https://github.com/thedarkcolour/kotlinforforge
Makes Kotlin forge-friendly.
https://github.com/thedarkcolour/kotlinforforge
kotlin minecraft-api minecraft-forge
Last synced: 3 months ago
JSON representation
Makes Kotlin forge-friendly.
- Host: GitHub
- URL: https://github.com/thedarkcolour/kotlinforforge
- Owner: thedarkcolour
- License: lgpl-2.1
- Created: 2019-11-03T19:56:42.000Z (over 5 years ago)
- Default Branch: 5.x
- Last Pushed: 2024-12-09T21:55:59.000Z (7 months ago)
- Last Synced: 2025-04-04T07:04:24.536Z (3 months ago)
- Topics: kotlin, minecraft-api, minecraft-forge
- Language: Kotlin
- Homepage:
- Size: 109 MB
- Stars: 196
- Watchers: 3
- Forks: 28
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# KotlinForForge
**Instructions for other versions: [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
[MIGRATION GUIDE](https://gist.github.com/thedarkcolour/5590f46b0d4d8ca692add2934d05e642)
A 1.21 Forge example mod is provided here: [1.21 KotlinModdingSkeleton Forge repository](https://github.com/thedarkcolour/KotlinModdingSkeleton/tree/1.21-forge)
A 1.21 NeoForge example mod is provided here: [1.21 KotlinModdingSkeleton NeoForge repository](https://github.com/thedarkcolour/KotlinModdingSkeleton/tree/1.21-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:
Gradle
```groovy
plugins {
// Adds the Kotlin Gradle plugin
id 'org.jetbrains.kotlin.jvm' version '2.0.21'
// OPTIONAL Kotlin Serialization plugin
//id 'org.jetbrains.kotlin.plugin.serialization' version '2.0.0'
}
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)
implementation 'thedarkcolour:kfflang:5.6.0'
implementation 'thedarkcolour:kfflib:5.6.0'
implementation 'thedarkcolour:kffmod:5.6.0'
// NEOFORGE
implementation 'thedarkcolour:kotlinforforge-neoforge:5.6.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
}
```
Gradle (Kotlin)
```kotlin
plugins {
// Adds the Kotlin Gradle plugin
kotlin("jvm") version "2.0.21"
// OPTIONAL Kotlin Serialization plugin
//kotlin("plugin.serialization") version "2.0.0"
}
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)
implementation("thedarkcolour:kfflang:5.6.0")
implementation("thedarkcolour:kfflib:5.6.0")
implementation("thedarkcolour:kffmod:5.6.0")
// NEOFORGE
implementation("thedarkcolour:kotlinforforge-neoforge:5.6.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)
}
```
Then, change the following to your neoforge.mods.toml file:
```toml
modLoader="kotlinforforge"
# Change this if you require a certain version of KotlinForForge
loaderVersion="[5.6,)"
```
Use `thedarkcolour.kotlinforforge.forge.MOD_BUS` instead of
instead of `net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext`