MMMOUpgradeUser Wikiv2.0 docs
Configuration

MMOUpgrade Config A-Z

This page is the full config map. Each generated file owns a specific area; use the detailed pages for full examples and explanations.

Config File Map

FilePurposeDetailed Page
config.ymlLicense key and Premium modifier debug logging.Free vs Premium
commands.ymlRoot command, aliases, permissions, subcommand names, argument names, and tab suggestions.Commands
gui.ymlInventory title, size, buttons, placeholder slots, cost, money placeholder, charge command, model, and tooltip options.GUI & Economy
items.ymlMMOItems used as upgrade stones, lucky charms, and protect charms.Stones & Charms
upgrade.ymlMax level, Free limits, allowed types, level display, consumed items, failure behavior, and success chance.Upgrade Rules
stat-registration.ymlCustom stats that MMOUpgrade registers into MMOItems.Custom Stats
stat-modifiers.ymlMMOItems stat scaling plus Premium element and enchantment modifiers when items gain or lose levels.Stat Modifiers
message.ymlMessages sent to players/admins and broadcast text.Messages
announcements.ymlEnables or disables broadcasts when an item reaches configured level milestones.Messages

Recommended Setup Order

  1. Set license-key if you use Premium. If it is empty, review the Free limits in upgrade.yml.
  2. Edit items.yml so upgrade stones, lucky charms, and protect charms match real MMOItems IDs.
  3. Edit upgrade.yml to set max level, allowed types, success formula, and failure behavior.
  4. Edit gui.yml to set slots, cost, charge command, and GUI visuals.
  5. Edit stat-modifiers.yml to decide how items become stronger at each level.
  6. Edit message.yml and announcements.yml for server-facing text.
  7. Run /mmoupgrade reload, then test with a real MMOItems item.

Common Formatting Rules

MiniMessage

Text supports MiniMessage tags such as <red>, <aqua>, hex colors, and legacy ampersand colors where conversion is supported.

Internal Variables

MMOUpgrade variables use curly braces, such as {level}, {name}, {cost}, and {money}, to avoid MiniMessage conflicts.

PlaceholderAPI

PlaceholderAPI placeholders use %placeholder%, such as %vault_eco_balance_fixed%. Money checks must return a plain number.

MMOItems IDs

In items.yml, IDs must use TYPE:ITEM_ID, for example CONSUMABLE:UPGRADE_STONE_1.