Skip to content

User Docs: Install Plugins

soir20 edited this page Jun 24, 2023 · 2 revisions

MoreMcmeta aims to be as broadly compatible as possible by minimizing invasive changes to Minecraft's code. However, some features do require changes that might cause incompatibility. Limited development time also means new features can take a long time to be released.

To remedy these issues, MoreMcmeta (4.0.0+) enables other developers to create their own plugins that add new features. They can create plugins that allow you to use new metadata file formats or add special effects to textures.

Install a Plugin

One or more plugins can be bundled with a mod. To install the plugins, simply install the mod normally. (Add it to your mods folder.)

You can uninstall the plugin(s) by uninstalling the mod. (Remove it from your mods folder.) MoreMcmeta does not allow you to disable plugins without uninstalling the mod. That feature would have to be implemented by the plugin developer.

Apply a Plugin to a Texture

Metadata files apply to a texture if they are in the same pack or in a pack above the texture's .png file. For example, if you have creeper.png in one pack and creeper.png.moremcmeta in the pack above, creeper.png.moremcmeta will be applied.

However, metadata files in higher packs override those with the same name in lower packs. If you have creeper.png and creeper.png.moremcmeta in one pack and another creeper.png.moremcmeta in the pack above, only the topmost creeper.png.moremcmeta will be applied.

Every plugin that creates texture effects has a "section name." For example, the section name for MoreMcmeta's animation plugin is "animation". As long as the section name is present in the metadata, that plugin will be applied. This sample .moremcmeta file is sufficient to apply the animation plugin:

{
  "animation": {}
}

You can apply at most 100 plugins to a texture.

Change the Order Plugins Are Applied

You can control the order in which plugins are applied to a texture. For example, say there was a grayscale plugin that makes textures gray and a vines plugin that adds vines to a texture. If you apply the grayscale plugin and then the vines plugin, the vines will be their normal color. If you apply the vines plugin and then the grayscale plugins, the vines will be made gray.

Every metadata file format has its own method to control the ordering of plugins. The rest of this section covers how to change the order for .moremcmeta files.

You can use the layer option to control . By default, all plugins have layer 0. A lower layer value means the plugin will be applied earlier. If two or more plugins have the same layer, they will be applied in alphabetical order. For example:

  • grayscale (layer -1), vines (layer 2) -> grayscale applied first, vines applied second
  • grayscale (layer 2), vines (layer -1) -> vines applied first, grayscale applied second
  • grayscale (layer 0), vines (layer 0) -> grayscale applied first, vines applied second

The actual order of metadata in the .moremcmeta files does not matter. In this .moremcmeta file, grayscale will be applied before vines.

{
    "vines": {
        "layer": 2
    },
    "grayscale": {
        "layer": -1
    }
}

Conflicts

You cannot apply metadata in multiple formats to the same texture. For example, you cannot apply metadata in .properties files and in .moremcmeta files to the same texture.

Special parameters, like the texture's frame size, blur setting, and clamp setting, must be consistent between all plugins. Each plugin can set these settings to a value or leave it unset. There is a conflict if two plugins set one of these special parameters to different values. It is acceptable for some or even all plugins to leave these parameters unset. Check the documentation for the plugins you are using for how to control these special parameters.

Information about conflicts is written to the game's log file.

Clone this wiki locally