GroovyModLoader

GroovyModLoader (GML) is a NeoForge language loader for Groovy mods.

How to use

To use this language provider, simply add it as a dependency in your build script. The language provider is available on maven central, so you can simply add the following to your build script. Make sure to define gmlVersion in the gradle.properties file, as the version of GML you want to use.

dependencies {
    implementation "org.groovymc.gml:gml:${gmlVersion}"
}

Also make sure to add the groovy plugin to your build script to ensure that the required tasks for Groovy compilation are added:

plugins {
    id 'groovy'
}

In your mods.toml / mods.groovy, specify gml as the loader and the version of the software as loaderVersion.

The main mod class should have a no-arg constructor and be annotated with @GMod with the mod ID specified. Access to the mod and Forge buses is provided respectively through the modBus or forgeBus properties. If you want IDE support alongside @CompileStatic for those properties, consider implementing BaseGMod in your mod main class or install the EnhancedGroovy plugin for IntelliJ.

@GMod('examplemod')
@Slf4j(category = 'ExampleMod')
class ExampleMod implements BaseGMod {
    ExampleMod() {
        log.info('Hello from Groovy-land!')
        
        modBus.register(ModBusEventHandler)
        forgeBus.register(ForgeBusEventHandler)
        
        assert forgeBus === MinecraftForge.EVENT_BUS
        assert modBus === GMLModLoadingContext.get().getModEventBus()
    }
}

Groovy Version

The Groovy version provided by the latest version of GML is currently: 4.0.19.

Only releases will be supported by GML, not release candidates. Once a NeoForge version has a Recommended Build published, the Groovy major and minor versions will be locked for that Minecraft version. However, patch versions will still be updated.

Groovy modules

The Groovy modules provided by GML are: stdlib, contracts, datetime, nio, macro, macro-library, templates, typecheckers, dateutil, ginq, toml, json.
You may however include a Groovy module that is not provided by GML using JiJ.
Please do not JiJ different versions of Groovy modules already bundled by GML as that may cause issues.

MC Versions

The major GML version is bumped every MC version. Below you can find a list of MC version -> GML version:

• 1.19.2 -> 1.x.x
• 1.19.3 -> 2.x.x
• 1.19.4 -> 3.x.x
• 1.20.0 -> 4.x.x
• 1.20.4 -> 5.x.x

NOTE: 1.19.2 - 1.19.4 versions use the com.matyrobbrt.gml artifact group.

Shading GML

While we would appreciate if you instead had a dependency on GML on CurseForge in order provide us revenue, we understand that in some cases, you may not want to depend on another mod. Fortunately, we are JiJ-able.
If you want to JiJ GML, just follow the guide here but replace GSON with the all version of GML (the runtimeOnly one).