The Gradle development plugin for leaf

A Gradle plugin to set up a development environment for Project Zomboid mods. Primarily used in the Leaf toolchain.

Features

• Has built in support for tiny mappings (used with Yarn)
• Utilises the Vineflower and CFR decompilers to generate source code with comments.
• Designed to support modern versions of Project Zomboid (Tested with 41.78.16 and upwards, mostly including unstable versions)
• Built in support for IntelliJ IDEA, Eclipse and Visual Studio Code to generate run configurations for Zomboid.
• Loom targets the latest version of Gradle 7 or newer (though it is recommended to use the latest)

Requirements

• Java 17 or newer

Usage

To get started using Loom to develop your own mods, please follow the guide on Setting up. Despite this guide originally being created for FabricMC/fabric, if you understand the concepts it presents, it also works here.

Development

This guide assumes you are using IntelliJ IDEA, other IDE's have not been tested; your experience may vary.

Debugging

1. Import as a Gradle project by opening the build.gradle
2. Create a Gradle run configuration to run the following tasks build publishToMavenLocal -x test. This will build Loom and publish to a local maven repo without running the test suite.
3. Prepare a project for using the local version of Loom:
   • A good starting point is to clone leaf-example-mod into your working directory
   • Add mavenLocal() to the repositories block inside of pluginManagement in settings.gradle
   • Change the loom version to <version>.local. For example id("leaf-loom") version "0.6.3.local"
4. Create a Gradle run configuration:
   • Set the Gradle project path to the project you have just configured above
   • Set some tasks to run, such as clean build you can change these to suit your needs.
   • Add the run configuration you created earlier to the "Before Launch" section to rebuild loom each time you debug
5. You should now be able to run the configuration in debug mode, with working breakpoints.

Special Thanks

• The entire FabricMC team