Gem Add Item

The Gem Add Item feature allows the Main Item to have gems inserted into it, provided that the item has empty sockets available for placing the gems.

How Gem Add Item Works

When you place the item you want to socket gems into, you must also place the gems you want to add. After pressing Confirm, if successful, the gems will be added to the item.

Permission

Each station has its own permission requirement in order to be used. Of course, you can customize or change the permission to suit your needs.

settings:
  permission: nwmmoupgrade.gemadditem.sword

Features

1. Material Item

If enabled, this means the operation of the station will require the specified materials in order to function as intended. You can define one or more material items, and the station will only execute if the player provides the required materials.

materials:
  enabled: false
  items:
    - type: MATERIAL
      id: STEEL_INGOT
      amount: 5
      slot: 30
      #match-item-type: SWORD #filter option
      #match-gem-type: SWORD #filter option
      #match-tier-type: RARE #filter option

Note:

type is the type of the MMOItem.
id is the ID of the MMOItem.
amount is the quantity of the material required.
slot is the GUI slot where the material must be placed.

Options

These are additional conditions that enhance material requirements:

match-item-type: The material will only be accepted if the item placed in the item slot has the matching type specified here.
match-gem-type: The material will only be accepted if the item placed in the gem item slot has the matching type specified here.
match-item-tier: The material will only be accepted if the item placed in the item slot has the matching tier specified here.

2. Chance Item

If enabled and used in conjunction with chance-based mechanics, the Chance Item provides an additional success rate boost on top of the existing base chance. This item acts as a support to increase the overall likelihood of success during actions such as upgrading

chance-item:
  enabled: false
  items:
    - type: MATERIAL
      id: RARE_DIAMOND
      amount: 5
      slot: 32
      chance: 50
      #match-item-type: SWORD #filter option
      #match-gem-type: SWORD #filter option
      #match-tier-type: RARE #filter option
    - type: MATERIAL
      id: SILVER_INGOT
      amount: 1
      slot: 32
      chance: 50
      #match-item-type: ARMOR #filter option
      #match-gem-type: SWORD #filter option
      #match-tier-type: RARE #filter option

Note:

type is the type of the MMOItem.
id is the ID of the MMOItem.
amount is the quantity of the material required.
slot is the GUI slot where the material must be placed.
chance This sets the success chance for the Chance Item

Options

These are additional conditions that enhance material requirements:

match-item-type: The material will only be accepted if the item placed in the item slot has the matching type specified here.
match-gem-type: The material will only be accepted if the item placed in the gem item slot has the matching type specified here.
match-item-tier: The material will only be accepted if the item placed in the item slot has the matching tier specified here.

3. Material Formula

The Material Formula feature provides a highly flexible way to dynamically calculate the cost and material requirements for item.

Material Increase

When this feature is enabled (enabled: true), the quantity of material items required for an gem add socket will increase as the item's level rises. This ensures that higher-level upgrades demand a greater investment from players, providing a more balanced progression.

The increase is determined by a custom formula you define, giving you precise control over the scaling.

In Short:

Level Up = Material Requirements.

Formula Configuration

The core of this feature lies in the formula field, where you can define a mathematical expression.

Basic: you can use the basic default chance calculation or create your own custom formula to control how the chance is calculated.
Custom Placeholders: The formula supports specific placeholders that will be replaced with dynamic values during calculation.

material-formula:
  enabled: true
  formula: "1"

4. Cost Upgrade

This feature allows you to use Vault (Money) for each Upgrade addition. And it also supports using custom placeholders from the system itself.

cost:
    enabled: false #Cost
    amount: 5000

cost:
    enabled: true # Enable/disable cost system
    amount: "{gem_add_item_custom_advance_cost_item}" # cost amount

5. Default Chance

This feature allows you to set the success chance of this station yourself, in cases where Tier is not enabled.

options:
    ....
    default-chance: 0

6. Tiers

This feature allows you to set the success chance based on the tiers of the item placed in the item slot. If the item's tier matches the specified tiers, the chance will be applied accordingly. If none of the tier conditions are met, the chance will be taken from the no-tier-chance setting.

options:
    ....
    tiers:
      enabled: false
      no-tier-chance: 10
      tier-list:
        - tier: COMMON
          chance: 2
        - tier: RARE
          chance: 15

7. Applies To

You can specify more than one MMOItem type that this configuration applies to.

applies-to:
  - SWORD
  - PICKAXE

Example Full Config

##########################################################################
#
#                         nwMMOUpgrade - Gem Add Item
#      Created By Discord NN#7999 (Newworld Server)
#
#      Supports RGB and standard color codes.
#      1.RGB = &#ffffff
#      2.Standard = &f
#      3. MiniMessage = <red>
#      4. Legacy Hex = &x
#      https://www.birdflop.com/resources/rgb/
#
##########################################################################

#Contact&Support: https://discord.gg/gwXcr7c6Gq

#MMOItems Type
applies-to:
  - SWORD

gem-applies-to:
  - GEM_STONE

# Sound settings
#https://hub.spigotmc.org/javadocs/bukkit/org/bukkit/Sound.html
sounds:
  confirm-success: ENTITY_EXPERIENCE_ORB_PICKUP
  confirm-fail: BLOCK_ANVIL_DESTROY
  confirm-no-item: BLOCK_NOTE_BLOCK_PLING

#GUI customization
gui:
  #GUI title, should support images normally.
  title: "&#00CBFFM&#01C8FFe&#02C6FFn&#02C3FFu&#03C0FF: &#05BBFFG&#06B8FFe&#07B5FFm &#08B0FFA&#09ADFFd&#0AABFFd &#0CA5FFI&#0CA2FFt&#0DA0FFe&#0E9DFFm"
  rows: 6 #GUI slots
  display-slots:
    item:
      material: LIME_STAINED_GLASS_PANE
      name: "<color:#00FF4F>Place the item to upgrade<color:#57E342>"
      lore:
        - "&7Drag and drop your item here"
      cmd: 1
    gem:
      material: PURPLE_STAINED_GLASS_PANE
      name: "<color:#00FF4F>Place the item to gem<color:#57E342>"
      lore:
        - "&7Drag and drop your gem here"
      cmd: 1
    material:
      material: YELLOW_STAINED_GLASS_PANE
      name: "<color:#E7FF00>Place the materials<color:#F2FF08>"
      lore:
        - "&7Drag and drop the required materials here"
      cmd: 1
    chance:
      material: PINK_STAINED_GLASS_PANE
      name: "<color:#FF00F8>Place a chance-enhancing stone (if any)<color:#E68DFF>"
      lore:
        - "&7Drag and drop the chance-enhancing stone here"
      cmd: 1

  slots:
    #Slot for the item you want to add Gem slots to.
    item: 13
    gem: 22
    confirm:
      material: BRICK
      name: "&a&lConfirm" #Button name
      lore: #Add your messages here.
        - "&7Click to add a Gem in Item"
        # - ""
        # - "&fCost: &a{cost}"
        # - "&fSuccess Chance: &6{chance}%"
        # - "&fMaterials:"
        # - "{material}" # edit custom line -> missing-material-line: "- &4<gray>{material} <red>{amount}"
      slot:
        - 48-50
      #Supports custom model data.
      cmd: 2600
    filter:
      name: "&f" #Name
      material: BLACK_STAINED_GLASS_PANE
      cmd: 1

materials:
  enabled: false
  items:
    - type: MATERIAL
      id: STEEL_INGOT
      amount: 1
      slot: 30
      #match-item-type: SWORD #จะใส่หรือไม่ใส่ก็ได้
      #match-gem-type: GEM_STONE #จะใส่หรือไม่ใส่ก็ได้
      match-tier-type: RARE
    - type: MATERIAL
      id: RARE_DIAMOND
      amount: 1
      slot: 30
      #match-item-type: SWORD #จะใส่หรือไม่ใส่ก็ได้
      #match-gem-type: GEM_STONE #จะใส่หรือไม่ใส่ก็ได้
      match-tier-type: RARE

#พังอยุ่ ปิดไว้
chance-item:
  enabled: false
  items:
    - type: MATERIAL
      id: RARE_DIAMOND
      amount: 5
      slot: 15
      chance: 1
      #match-item-type: SWORD #จะใส่หรือไม่ใส่ก็ได้
      #match-gem-type: GEM_STONE #จะใส่หรือไม่ใส่ก็ได้
      match-tier-type: RARE #จะใส่หรือไม่ใส่ก็ได้
    - type: MATERIAL
      id: STEEL_INGOT
      amount: 5
      slot: 15
      chance: 1
      #match-item-type: SWORD #จะใส่หรือไม่ใส่ก็ได้
      #match-gem-type: GEM_STONE #จะใส่หรือไม่ใส่ก็ได้
      match-tier-type: RARE

settings:
  permission: nwmmoupgrade.gemadditem.default
  cost:
    enabled: false #Cost
    amount: 5000
  options:
    material-formula:
      enabled: false
      formula: 1
    default-chance: 100
    tiers:
      enabled: false
      no-tier-chance: 10
      tier-list:
        - tier: COMMON
          chance: 5
        - tier: RARE
          chance: 50

PreviousGem Add Socket NextGem Un Socket

Last updated 19 days ago