Skip to main content

๐Ÿ“œ Scroll System

In MMOItemsUpgrade, scrolls are not just consumablesโ€”they are the core of balancing upgrade risks.

๐Ÿงช Utility Scrolls (In-GUI)โ€‹

These items must be placed in the dedicated slot of the upgrade GUI. Config: contents/scrolls.yml.

1. Success Rate Scrollsโ€‹

Improves the success rate of the upgrade.

  • Fixed Bonus: Increases by a fixed percentage (e.g., bonus: 0.05 for +5%).
  • Random Bonus: Randomly fluctuates within a range.
    • Config example: bonus-min: 0.1 / bonus-max: 0.2 (random 10%~20%).

2. Protection Scrollsโ€‹

  • Type Identifier: PROTECTION
  • Function: If an upgrade failure triggers the "item destruction" check, this scroll negates destruction, keeping the item safe.
  • Note: Protection scrolls usually do not prevent "level drops" caused by failure.

3. Upgrade Amplifiersโ€‹

  • Type Identifier: AMPLIFIER
  • Function: Level does not drop after a failed upgrade.
  • Penalty: Usually costs a success rate reduction (e.g., success-penalty: 0.15).

๐Ÿ’Ž Enhancement Scrolls (Drag-and-Drop)โ€‹

Config: contents/enhancement-scrolls.yml. These are special items that can be dragged onto equipment directly from your inventory to force it to a specific level.

Configuration Caseโ€‹

# In contents/enhancement-scrolls.yml
scrolls:
  # +7 Enhancement Scroll: Newbie Bonus
  starter_plus_7:
    type: MMOITEM
    mmo-type: "CONSUMABLE"
    mmo-id: "STARTER_UPGRADE_7"
    target-level: 7
    allow-downgrade: false # No downgrade if weapon is already +8
    sound: "ENTITY_PLAYER_LEVELUP"
    particle: "VILLAGER_HAPPY"

[!CAUTION] Enhancement scrolls reset the equipment level to target-level. Always set allow-downgrade: false to prevent accidental downgrades.