Post Editor Module

Registering Editor Modules

Editor Modules allow Expansions to add custom fields and functionality to item editors in Nexo Maker. Use postEditorModule() to define your module with metadata, icons, and behavior.


Syntax

nm.postEditorModule({
  name: "unique_module_id",        // Internal ID
  display: "Display Name",         // Shown in the editor
  plugins: ["plugin1","plugin2"], // Supported plugins
  compatibility: ["item","tool"], // Compatible item types
  description: "Module description", 
  icon: yourloadedicon,                // Base64 icon
  type: "number",   // 
  default: 0,                      // Default value
  component: "ComponentName",      // Modularjs component ID
});
circle-info

Plugins: Plugins is an array of any provided plugin export translations. Currently Nexo Maker 0.7 offers only support for Nexo and Items Adder, adding your custom module also requires adding your custom translations.

circle-info

Compatibility: Default Nexo Maker 0.7 compatibility are "item", "weapon", "tool", "block", "furniture" and "food"

circle-info

Type: Types are the type of input to render, this defines which data structure will be used as well. Nexo Maker defaults are "barrierHitbox", "checkbox", "craftingtable", "dropdown", "hitbox", "hitboxShulker", "interactionsHitbox", "loot", "material", "minecraftid", "minecraftidlist", "number" and "text"


Example


Notes & Best Practices

  • name must be unique across all modules.

  • component links to a Modularjs component that renders the module UI.

  • Use plugins and compatibility to ensure your module only shows for compatible items.

  • Always provide a Base64 icon for clear identification in the editor.

  • Group modules by category for better organization.

Last updated