Skip to content

Latest commit

 

History

History
29 lines (19 loc) · 908 Bytes

coremods.md

File metadata and controls

29 lines (19 loc) · 908 Bytes

CoreMods plugin

The CoreMods plugin allows to build coremods written in TypeScript. It requires node and npm.

Apply the plugin

apply plugin: 'org.moddingx.modgradle.coremods'

Use the plugin

Specify the CoreModTypes dependency:

repositories {
    maven { url = 'https://maven.moddingx.org' }
}

dependencies {
    coremods 'org.moddingx:CoreModTypes:5.0.2-2'
}

Place your core mods in src/coremods. You can import the coremod types from a package named coremods.

When building, the core mods will get compiled and a META-INF/coremods.json will be created.

The plugin will also create the files src/coremods/coremods.d.ts and src/coremods/tsconfig.json. These exist for code completion in IDEs. You should gitignore them.