👋 Getting Started

This chapter will guide you through installing MMOItemsUpgrade and configuring a basic upgrade scheme.

📥 Installation

1. Core Dependencies:
   • MMOItems (Required)
   • MythicLib (Required)
   • Vault (Required - For economic support)
2. Recommended Enhancements:
   • ItemsAdder / Nexo (For custom materials)
   • AuraSkills (For skill integration)

Place the plugin in your plugins folder and restart your server. When you see [MMOItemsUpgrade] Enabled! in the console, the core functions are ready.

💬 Language Settings

Modify the language option in config.yml:

• zh_CN: Simplified Chinese
• zh_TW: Traditional Chinese
• en_US: English

[!WARNING] You must reload the plugin or restart the server after changing the language, or some GUI messages might retain old language cache.

🛠️ 3 Steps to Your First Scheme

Step 1: Define Success Rates

Set the challenge difficulty for different level ranges in contents/success-rates.yml.

success-rates:
  "1-5": 1.0      # 100% success for first 5 levels
  "6-10": 0.5     # 50% success thereafter

Step 2: Configure Material Costs

Create a configuration file (e.g., sword.yml) in contents/materials/.

sword_config:
  type: SWORD
  base:
    money: 500
    materials:
      - type: VANILLA
        id: DIAMOND
        amount: 3

Step 3: Configure Stat Gains

Set the growth for each level in contents/upgrade-gains/.

levels:
  1:
    ATTACK_DAMAGE: "10%"

---

[!IMPORTANT] A set of example content is provided by default. You can type /mmoupgrade gui to start testing.