Skip to content

Getting Started

neoramm edited this page Nov 5, 2026 · 1 revision

Getting Started

Installing

  1. Put the MetaEnchants jar in your server's plugins folder.
  2. Start the server once. MetaEnchants creates its folder: plugins/MetaEnchants.

MetaEnchants needs MetaCore (the shared Trigger Engine jar) in the same plugins folder. PlaceholderAPI is optional.

What is inside the folder

File or folder What it is
config.yml The general settings: tooltips, books, applying enchantments, the enchanting table, the anvil, the language and the switches of the optional systems.
lang/ The messages, one file per language. See Languages.
menus/ The list of enchantments, the detail menu, the Enchanter and the kit menu. See Menu and Messages.
items.yml Scrolls, dusts, orbs, trackers, soul gems, boxes and rename tags. See Special Items.
sets/ Armor sets and custom weapons, one file each. See Armor Sets and Custom Weapons.
kits/ Kits, one file each. See Kits.
rarities.yml The rarities (categories) that give enchantments a color and default numbers. See Rarities.
types.yml The types, for limits per item and the grindstone. See Types.
vanilla.yml Changes to vanilla enchantments. See Changing Vanilla Enchantments.
enchants/ One file per enchantment. Each file is a complete enchantment.

The first time the plugin runs it creates twenty-four example enchantments in enchants/, two sets in sets/ and a kit in kits/. After that it never overwrites your files. Missing config.yml, rarities.yml, types.yml, vanilla.yml, items.yml, menu and language files are recreated at startup, but the example enchants/, sets/ and kits/ folders are only created when the whole folder is missing: deleting one example file inside them keeps it deleted.

Restart or reload?

This is the most important thing to understand about MetaEnchants.

The game builds its list of enchantments when the server starts, so a few things can only change with a restart. Everything else can be changed live with /metaenchants reload.

What you changed What you need
Adding a new enchantment file Restart
name, rarity, max-level, weight, anvil-cost, min-cost, max-cost Restart
supported-items, primary-items, slots, incompatible Restart
obtain (turning places on or off), treasure, curse, stack Restart
Rarities (rarities.yml), except book, minimum-table-level and chances Restart
name, max-level, weight, anvil-cost in vanilla.yml Restart
description, display-item, activation /metaenchants reload
type, requires, replaces, drag-and-drop, price, removable, disabled-worlds, soulbound, minimum-table-level, book, applies-to, chances in obtain /metaenchants reload
types.yml, and description, type, removable, applies-to in vanilla.yml /metaenchants reload
triggers (what the enchantment does) /metaenchants reload
config.yml (everything), lang/, menus/, items.yml, sets/ and kits/ /metaenchants reload
placeholders of an enchantment /metaenchants reload

If you reload after changing something that needs a restart, the plugin tells you in the console and keeps the old value until the next restart. /metaenchants lastchanged shows those messages again in the chat.

Tip: the best way to work is to finish the number-related options first (restart once), then tune what the enchantment does with quick reloads.

Your first enchantment in two minutes

  1. Open plugins/MetaEnchants/enchants and copy vampirism.yml. Rename the copy to lifesteal.yml.

    The file name is the id of the enchantment (metaenchants:lifesteal). Use lowercase letters, numbers, - and _.

  2. Open it and change name, description and, if you want, the max-level.

  3. Restart the server.

  4. Hold a sword and run /enchant @s metaenchants:lifesteal 2. The sword now has your enchantment.

Or use /metaenchants give <player> metaenchants:lifesteal 2 to get an enchanted book.

To understand every option, read Creating an Enchantment.

Trying it out

  • /metaenchants opens a menu with every enchantment of the plugin. Operators can take books from it.
  • /metaenchants list lists them in the chat.
  • /metaenchants info <enchantment> shows all the details of one.
  • /metaenchants inspect shows the enchantments of the item in your hand.

All the commands are in Commands and Permissions.

Clone this wiki locally