Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 2.16 KB

README.md

File metadata and controls

44 lines (34 loc) · 2.16 KB

This is a fork of the NeoForge MDK that's set up to use Kotlin. I've taken the freedom to do the following modifications:

  • Ported the existing Java code to Kotlin
  • Ported the build scripts to use the new Kotlin DSL for Gradle
  • Added an example Mixin

Note

The Kotlin experience in Eclipse is subpar at best. While the original MDK might also work in Eclipse, I would strongly recommend against trying to use it for developing with Kotlin. The best choice for making Minecraft mods with Kotlin is IntelliJ IDEA with the Minecraft Development Plugin.

The original README of the MDK:

Installation information

This template repository can be directly cloned to get you started with a new mod. Simply create a new repository cloned from this one, by following the instructions at github.

Once you have your clone, simply open the repository in the IDE of your choice. The usual recommendation for an IDE is either IntelliJ IDEA or Eclipse.

Note: For Eclipse, use tasks in Launch Group instead of ones founds in Java Application. A preparation task must run before launching the game. NeoGradle uses launch groups to do these subsequently.

If at any point you are missing libraries in your IDE, or you've run into problems you can run gradlew --refresh-dependencies to refresh the local cache. gradlew clean to reset everything {this does not affect your code} and then start the process again.

Mapping Names:

By default, the MDK is configured to use the official mapping names from Mojang for methods and fields in the Minecraft codebase. These names are covered by a specific license. All modders should be aware of this license, if you do not agree with it you can change your mapping names to other crowdsourced names in your build.gradle. For the latest license text, refer to the mapping file itself, or the reference copy here: https://github.com/NeoForged/NeoForm/blob/main/Mojang.md

Additional Resources:

Community Documentation: https://docs.neoforged.net/
NeoForged Discord: https://discord.neoforged.net/