Demo MCreator Java plugin

This repository demonstrates a basic MCreator Java plugin structure. Java plugins only work with MCreator 2022.2 or newer.

Setup

In order for the plugin to work, make a new file called gradle.properties with the following contents:

mcreator_path=<path to MCreator core Gradle project directory>

Running MCreator with the plugin

This demo plugin comes with some Gradle tasks to help you with the development of your plugin.

• runMCreatorWithPlugin: Run MCreator with the plugin loaded

There is also IntelliJ IDEA run configuration for this task provided in the repository.

Make sure to enable Java plugins in MCreator preferences, or the plugin will not be loaded.

Testing

We highly recommend to test your plugin by running MCreator's tests with your plugin loaded.

This Gradle project does this for you, you just need to run the test task.

There is also IntelliJ IDEA run configuration for this task provided in the repository.

Exporting

To export the plugin, run jar task and find the plugin zip file in build/libs.