📌 Gem Add Socket

The Gem Add Socket feature lets you add sockets to desired items, with customization options based on the available features.

🛠️ How Add Socket Works

When you place an item in the Item slot and press the Confirm button, a socket will be added to your 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.gem.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-tier-type: RARE #filter option
      #match-item:
      # - SWORD:KATANA

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-item-tier: The material will only be accepted if the item placed in the item slot has the matching tier specified here.
match-item: The material will only be accepted if the item placed in the item slot has the matching According to the item defined in match-item 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-tier-type: RARE #filter option
      #match-item:
      # - SWORD:KATANA
    - type: MATERIAL
      id: SILVER_INGOT
      amount: 1
      slot: 32
      chance: 50
      #match-item-type: ARMOR #filter option
      #match-tier-type: RARE #filter option
      #match-item:
      # - SWORD:KATANA

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
match-item-tier
match-item

3. Add Socket Case

3.1 Default Add Socket

This method adds sockets to items up to a maximum defined by max-sockets for all items.

default-add-socket:
    socket-color: "Uncolored" #Default value is ANY, but if using a colored GEM STONE, that color will be the primary one.
    max-sockets: 50

#default

socket-color: "Uncolored"

#random

socket-color:
      - "Uncolored"
      - "Red"
      - "Blue"
      - "Green"

3.2 Tiers Add Socket

This method checks the Tier of the item you're adding sockets to. If it matches any condition in the tier-list, items with that Tier will reference their max-sockets setting. You can add more than one Tier to the list.

tiers:
  enabled: false
  no-tier-chance: 10
  no-tier-max-sockets: 1
  socket-color:
    - "Uncolored"
    - "Red"
    - "Blue"
    - "Green"
  tier-list:
    - tier: COMMON
      chance: 2
      max-sockets: 1
    - tier: RARE
      chance: 15
      max-sockets: 1

4. 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 higher-level upgrades demand a greater investment from players.

In Short: Level Up = Material Requirements.

Formula Configuration

The core lies in the formula field, where you can define mathematical expressions.

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

5. Cost

This feature allows you to use currencies such as PlayerPoints, CoinsEngine, or Vault.

cost:
    enabled: true
    currency: pp
    amount: 5000

cost:
    enabled: true # Enable/disable cost system
    currency: ce;nwcoin
    amount: "{global_custom_advance_cost_item}"

cost:
    enabled: true # Enable/disable cost system
    amount: 100

6. 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

7. Tiers

This feature allows you to set the success chance based on the tiers of the item placed in the item slot.

options:
    ....
    tiers:
      enabled: false
      no-tier-chance: 10
      no-tier-max-sockets: 1
      socket-color:
        - "Uncolored"
        - "Red"
        - "Blue"
        - "Green"
      tier-list:
        - tier: COMMON
          chance: 2
          max-sockets: 1
        - tier: RARE
          chance: 15
          max-sockets: 1

8. Remove Durability When Fail

If you fail to add a socket, your item's durability will be completely removed.

remove-durability-when-fail: 
    enabled: true

9. Destroy Item When Fail

If an item upgrade fails, the item will be replaced with a predefined material.

destroy-item-when-fail:
  enabled: false
  item-return:
    type: MATERIAL
    id: STEEL_INGOT
    amount: 1

10. Match item socket color

The match-item-socket-color feature allows you to control socket creation behavior based on the item being upgraded.

When a socket is added to an item, the plugin will check the configured rules and apply the socket settings that match the item’s type, ID, and tier.

⚙ Configuration Example

match-item-socket-color:
  enabled: true
  lists:
    - SWORD;KATANA;4;ultra_red
    - SWORD;;3;Yellow;COMMON,RARE,LEGENDARY
    - SWORD;;2;Red
    - armor;;1;Blue

📘 Rule Format

Each entry in lists follows this format:

<type>;<id>;<empty_socket>;<color>;<tier>

Parameters

type Item type (e.g. SWORD, armor)
id (optional) MMOItem ID Leave empty to apply the rule to all items of this type
empty_socket Number of empty sockets to add
color Socket color to apply (e.g. Red, Blue, Yellow, ultra_red)
tier (optional) Item tiers this rule applies to If not specified, the rule applies to all tiers

🔍 Matching Logic & Priority

Rules are evaluated from top to bottom
More specific rules (type + ID + tier) take priority
Less specific rules act as fallbacks

This allows you to define detailed behavior while keeping a simple default setup.

🧠 How It Works

When a socket is added:

The plugin checks if match-item-socket-color is enabled
It scans the lists for a matching rule
The first matching rule is applied
The socket is created with the configured amount and color

Previous🔄 Update Item Next💎 Gem Add Item

Last updated 3 months ago

hashtag🛠️ How Add Socket Works

hashtag🔑 Permission

hashtag🌟 Features

hashtag1. Material Item

hashtagNote:

hashtagOptions

hashtag2. Chance Item

hashtagNote:

hashtagOptions

hashtag3. Add Socket Case

hashtag3.1 Default Add Socket

hashtag3.2 Tiers Add Socket

hashtag4. Material Formula

hashtagMaterial Increase

hashtagFormula Configuration

hashtag5. Cost

hashtag6. Default Chance

hashtag7. Tiers

hashtag8. Remove Durability When Fail

hashtag9. Destroy Item When Fail

hashtag10. Match item socket color

hashtag⚙ Configuration Example

hashtag📘 Rule Format

hashtag🔍 Matching Logic & Priority

hashtag🧠 How It Works

🛠️ How Add Socket Works

🔑 Permission

🌟 Features

1. Material Item

Note:

Options

2. Chance Item

Note:

Options

3. Add Socket Case

3.1 Default Add Socket

3.2 Tiers Add Socket

4. Material Formula

Material Increase

Formula Configuration

5. Cost

6. Default Chance

7. Tiers

8. Remove Durability When Fail

9. Destroy Item When Fail

10. Match item socket color

⚙ Configuration Example

📘 Rule Format

🔍 Matching Logic & Priority

🧠 How It Works