Skip to content

Getting Started

Setting up the Development Environment

Download the MDK from https://github.com/OpenModLoader/OpenMDK

Run gradlew setup, or ./gradlew setup on Mac or Linux,

If using IntelliJ IDEA then run gradlew idea, ./gradlew idea on Mac or Linux.

The Mod Json Format

[
  {
    "modid": "id",
    "name": "Name",
    "version": "x.x.x",
    "mainClass": "com.examplemod.MainClass",
    "mcversion": "x.x.x",
    "side": "UNIVERSAL",
    "library": false,
    "languageAdapter": "com.openmodloader.loader.language.JavaLanguageAdapter",
    "icon": "icon.png",
    "dependencies": [
      "requirement@x.x.x"
    ]
  }
]

Modid REQUIRED

Name REQUIRED

Version REQUIRED

MainClass REQUIRED

MCVersion OPTIONAL | DEFAULT: 1.13.x

Side OPTIONAL | DEFAULT: UNIVERSAL

Library OPTIONAL | DEFAULT: FALSE

Language Adapter OPTIONAL | DEFAULT: JAVA

Icon OPTIONAL | DEFAULT: NULL

Dependencies OPTIONAL | DEFAULT: EMPTY