Developing MCreator plugins

Before you start

Before starting to create plugins for MCreator, you should know every aspect of MCreator. You should and have also to know basic Java and Forge coding with Forge Concepts. Finally, success to make an MCreator plugin is possible by trying something, understand why it doesn't work, and search.

What you can make

With MCreator plugins, one can add new features to MCreator, more specifically (at the time of writing):

  • Custom procedure blocks and categories
  • Custom global triggers
  • Custom JSON advancement triggers and categories
  • AI task blocks and categories
  • New generators

Demo plugins

You can start off with making a plugin by exploring demo plugins that help you get started with your own plugin:

Plugin basics

Setting up the plugin

First of all, you will need to create a plugin.json file. This file will contain information about your plugin. When you have created your file, copy and paste this code. Then, change pieces of information for what you want.

{
  "id": "plugin_id",
  "minversion": 2020200000,
  "weight": 0,
  "info": {
    "name": "Plugin Name",
    "description": "Write a short description of your plugin.",
    "author": "Your Name"
  }
}

When you have finished, you can save and close the file. Then, create a new folder with your plugin ID. This folder will contain all other files and folders used by the plugin.

Installation

To install exported plugin in MCreator, put the plugin ZIP file into <user home>/.mcreator/plugins or install them from MCreator's preferences window and relaunch MCreator.

Exporting

To export the plugin, simply archive the root folder of the plugin into a ZIP file, so the plugin has the following structure:

  • <plugin file name>.zip
    • plugin.json
    • (procedures)
    • (<generator 1 name>)
    • ...


Donate to MCreator

By donating to developers you can speed up development, as with more resources, we can dedicate more time to MCreator. It is a free project made by developers working on it in their free time.