Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/groovymc/groovymodloader
Neo/Forge Groovy mod loader
https://github.com/groovymc/groovymodloader
Last synced: about 19 hours ago
JSON representation
Neo/Forge Groovy mod loader
- Host: GitHub
- URL: https://github.com/groovymc/groovymodloader
- Owner: GroovyMC
- License: mit
- Created: 2022-08-13T13:06:28.000Z (over 2 years ago)
- Default Branch: 1.21.x
- Last Pushed: 2024-06-21T04:38:03.000Z (5 months ago)
- Last Synced: 2024-06-21T22:36:50.736Z (5 months ago)
- Language: Groovy
- Homepage:
- Size: 676 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.MD
- License: LICENSE
Awesome Lists containing this project
README
# GroovyModLoader
[](https://central.sonatype.com/artifact/org.groovymc.gml/gml)
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.
```groovy
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:
```groovy
plugins {
id 'groovy'
}
```
In your `mods.toml` / [mods.groovy](https://github.com/GroovyMC/ModsDotGroovy), 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](https://plugins.jetbrains.com/plugin/19844-enhancedgroovy).
```groovy
@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](https://forge.gemwire.uk/wiki/Jar-in-Jar).
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](https://www.curseforge.com/minecraft/mc-mods/gml) 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](https://forge.gemwire.uk/wiki/Jar-in-Jar) but replace GSON with the `all` version of GML (the `runtimeOnly` one).