Skip to content

lantice3720/mindugradle

Repository files navigation

mindugradle

Gradle Plugin Portal Version Mindustry version

Your best modding partner.

Setting up modding environment every time you start developing a new Mindustry mod is a pain.
mindugradle will do boring, repetitive tasks for you!

  • Automatically download mindustry jars according to your mod.hjson
  • Provide Gradle tasks for easily running instanced Mindustry client/server with your mod installed

Requirements

  • Gradle 8.0+
  • JDK 8 or later

Usage

First, add this plugin to your build.gradle.kts:

plugins {
    // other plugins
    id("kr.lanthanide.mindugradle") version("1.1")
}

And then, it's done! Enjoy developing your mod.
To run Mindustry client or server with your mod:

./gradlew runClient
./gradlew runServer

Configuration

All configuration is optional. If minGameVersion is not set, the plugin reads it from mod.hjson or mod.json.

mindugradle {
    // Directory where Mindustry stores its data during a run (default: build/mindugradle/run)
    gameDataDir.set(layout.buildDirectory.dir("my-run-dir"))

    // Directory for caching downloaded JARs (default: build/mindugradle/caches)
    cacheDir.set(layout.buildDirectory.dir("my-cache-dir"))

    // JVM arguments passed to Mindustry (as a list, no space-splitting)
    jvmArgs.set(listOf("-Xmx2G", "-Xms512M"))

    // Pin a specific game version (overrides mod.hjson)
    minGameVersion.set("155.4")
}

Planned features

  • Android build support

Contributing

Contributions are welcome! Please feel free to submit an issue or PR.

About

Gradle plugin for easier Mindustry Modding

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages