Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mairwunnx/minecraft-forge-kotlin-mod-template

Minecraft mod template using forge and Kotlin or just Forge MDK but with Kotlin.
https://github.com/mairwunnx/minecraft-forge-kotlin-mod-template

forge forge-kotlin forge-kotlin-build-script forge-kotlin-compatibility forge-kotlin-example forge-kotlin-mdk forge-mdk forge-mod kotlin-for-forge kotlin-forge kotlin-forge-example kotlin-forge-template minecraft minecraft-mod

Last synced: 6 days ago
JSON representation

Minecraft mod template using forge and Kotlin or just Forge MDK but with Kotlin.

Awesome Lists containing this project

README

        

🐛 Lightweight template repository for forge mod with using kotlin language and gradle build tools.


#### Compatibility ✔

| Minecraft version | Forge version | Gradle version |
|:--- |:--- |:--- |
|1.14.4 (this branch) | `28.X.X` | `5.6.4` |
|[1.15.2](https://github.com/MairwunNx/Minecraft-Forge-Kotlin-Mod-Template/tree/FORGE-1.15.2) | `31.X.X` | `5.6.4` |

#### Contains 🧐

- Gradle **kotlin dsl** buildscript [build.gradle.kts](/build.gradle.kts).
- Boilerplate code of **forge mdk**.
- Included **kotlin runtime** (JDK 8) in build.
- **Documentation** for build script.
- Included some *hacks* for using **forge events** in kotlin classes. *(Not cool, but work)*.

### Get started ☕

1. Download sources \ clone repository or click on `Use this template` and clone.
2. Open as project cloned repository on local disk. (In IDEA or Eclipse).
3. IDEA automatically starts configuring build script. (Nothing need to do).
4. After finishing all gradle tasks you can run `build` task and see library in path `./build/libs/xxx.jar`.
5. Copy mod jar in minecraft mod directory and 🎉, mod loaded.
6. If all steps finished without problems, put star on this repository =).