Gem Add Socket


Add Socket

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

Add Socket Gui

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

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.


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


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" #Default value is ANY, but if using a colored GEM STONE, that color will be the primary one.
    - "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 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"

5. 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_socket_custom_advance_cost_item}" # cost amount

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. 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
      no-tier-max-sockets: 1
      socket-color:
        - "Uncolored" #Default value is ANY, but if using a colored GEM STONE, that color will be the primary one.
        - "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 # Item type (MATERIAL, MMOITEM)
    id: STEEL_INGOT # Item ID
    amount: 1

10. Applies To

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

applies-to:
  - SWORD
  - PICKAXE

Last updated