Skip to content

Redstonneur1256/Mindustry-ModLib

Repository files navigation

Mindustry-ModLib

Library to help developers creating Mindustry mods and optimize some game features
If you think some utility or optimization should be added open an issue describing the feature.

Release version JitPack version Mod download count License

Fully compatible with vanilla servers/clients !

Current development tools:

  • Class mixins
  • No packet limit
  • Packet chaining (sending replies to received packets)
  • Call like classes supporting custom parameters and return values
  • Synchronized registrable types in TypeIO
  • Custom keybind registration
  • Improved logger

Mod Installation:

Desktop/Steam you can download the mod from the mod browser or from the releases page (ModLib).
Android: Coming soon Download the mod launcher from the releases pages, install the application and follow the steps from the application.

Using the library:

  • Add the dependency using JitPack on Gradle:
      repositories {
          mavenCentral()
          maven { url "https://raw.githubusercontent.com/Anuken/MindustryMaven/master/repository" }
          maven { url "https://jitpack.io/" }
          maven { url "https://repo.mc-skyplex.net/releases" }
      }
      
      dependencies {
          compileOnly("com.github.Redstonneur1256.Mindustry-ModLib:Mod:VERSION")
      }
  • Update your mod.json/plugin.json to add the library as a dependency.
    "dependencies": [
      "!mod-library"
    ]
  • If using access-wideners you will require the gradle-access-widener, please refer to the plugin's documentation for configuration instructions.

Mixin/Access widener files must be present at the root of the mod's file structure, the files name excluding the extension must be the exact same than the name property defined in your mod.(h)json/plugin.(h)json.

See the Example module for usage examples.

Contributing:

See CONTRIBUTING

Contributors:

Special thanks to Eliott SRL for making the icon.