Skip to content
/ DemoPlugin Public template
forked from MCreator/DemoPlugin

This repository demonstrates a basic MCreator (https://mcreator.net/) plugin structure.

License

Notifications You must be signed in to change notification settings

navarayuk/DemoPlugin

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

19 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Demo MCreator plugin

License

This repository demonstrates a basic MCreator plugin structure.

WARNING: The plugin structure might and will change in the future so keep your eye on this repository for changes on the format if you are a plugin dev.

Demonstrated features:

  • Custom procedural procedure block
  • Custom output procedure block
  • Custom procedure category
  • Custom global trigger
  • Custom templates
  • Generator for given features for 1.14.4

Other plugin features not demonstrated:

  • Custom JSON advancement triggers and categories
  • AI task blocks and categories
  • Full generator plugin
  • Data lists
  • APIs - eg. Minecraft Link

For features not demonstrated in this plugin, you can check the built-in plugins in <install dir>/plugins folder of your MCreator installation for the reference.

https://mcreator.net/wiki/section/mcreator-plugins

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>)
    • ...

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.

Generator naming conventions

Generators are added in the root folder of the plugin:

  • <plugin file name>.zip
    • <generator 1 name>
    • <generator 2 name>
    • <generator 3 name>
    • ...

Generator names are formatted like this:

FLAVOR-generatorName

Where FLAVOR can be:

  • forge - eg. "forge-1.15.2" - such generators indicate forge generator flavor
  • datapack - eg. "datapack-1.14.4" - such generators indicate datapack generator flavor
  • addon - eg. "addon-1.14.x" - such generators indicate addon generator flavor
  • fabric - eg. "fabric-1.16.1" - such generators indicate fabric generator flavor
  • spigot - eg. "spigot-1.16.1" - such generators indicate spigot generator flavor

Non-plugin files

The following files are not part of the plugin structure but are there for the purpose of Intellij IDEA IDE support for better plugin development, documentation purposes and similar:

  • README.md
  • LICENSE
  • demo-plugin.iml
  • .idea/*
  • .github/*

About

This repository demonstrates a basic MCreator (https://mcreator.net/) plugin structure.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • FreeMarker 100.0%