> For the complete documentation index, see [llms.txt](https://thanhpahts-organization.gitbook.io/product-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://thanhpahts-organization.gitbook.io/product-docs/mmoitems-station-gui/mmoitemsstationgui-wiki.md).

# MMoitemsStationGUi wiki

## I. INTRODUCTION

This plugin allows you to add MMOItems' equipment upgrade feature to your server, featuring a fully customizable interface, support for custom model data, adjustable success rates, and much more.

## II. FEATURES

### 1. Gem Socket

This feature allows you to create a socketing interface with configurable success rates and costs—supporting Vault and PlayerPoints—and accepts both vanilla items and MMOItems as materials.
\
You can also define a blacklist of items that players are prohibited from socketing.

```
  socket:

    enabled: true
    blacklist:
      # Example:
      # mmoitems:
      #   - MATERIAL
      #   - CONSUMABLE
      mmoitems: []
    max-sockets: 5
    cooldown-seconds: 3
    levels:
      1:
        success-rate: 100
        requirements:
          permission: ""
          money: 0
          playerpoints: 0
          vanilla-items: {}
          mmoitems: {}
      2:
        success-rate: 90
        requirements:
          permission: ""
          money: 0
          playerpoints: 0
          vanilla-items:
            type: DIAMOND
            amount: 1
          mmoitems: {}
```

### 2. Item Upgrading

The equipment upgrade interface is fully customizable using MMOItems templates, allowing you to define success rates and specific requirements, as well as the level-drop penalty for failed upgrades.

You can configure the system so that items lose levels upon a failed upgrade at specific tiers. Additionally, you can designate any Vanilla or MMOItems item as a "protection charm" to prevent the item from losing levels if the upgrade fails.

A blacklist feature is available, allowing you to specify items that players are prohibited from upgrading.

```
  upgrade:

    enabled: true
    # Blacklist only checks MMOItems type, for example: SWORD, ARMOR, TOOL.
    # Vanilla blacklist was intentionally removed because vanilla items are blocked
    # from equipment slots by default.
    blacklist:
      # Example:
      # mmoitems:
      #   - MATERIAL
      #   - CONSUMABLE
      mmoitems: []
    protection-charm:
      # Vanilla items allowed in the protection charm slot.
      vanilla:
        - NETHER_STAR
      # MMOItems protection charm format: TYPE:ID
      # Example:
      # mmoitems:
      #   - MATERIAL:PROTECTION_CHARM
      mmoitems: []
    min-level: 0
    max-level: 1
    cooldown-seconds: 3
    template:
      1:
        success-rate: 80
        # Failure mode:
        # "0"  = keep the same level on failure.
        # "-1" = downgrade one level on failure.
        # Protection charm prevents downgrade and is consumed only when it protects.
        failure-mode: "-1"
        requirements:
          permission: ""
          money: 0
          playerpoints: 0
          # Vanilla requirement example:
          # vanilla-items:
          #   type: DIAMOND
          #   amount: 1
          vanilla-items: {}
          # MMOItems requirement example:
          # mmoitems:
          #   gem1:
          #     type: MATERIAL
          #     id: UPGRADE_STONE
          #     amount: 1
          mmoitems: {}
```

### 3. Upgrading Transfer

Transfer one piece of equipment to another, with full support for transferring levels and gems, and fully customizable settings.

Supports transferring levels, gem sockets, or both simultaneously.

Includes a blacklist feature to specify items that players are prohibited from converting.

```
  transfer:
    enabled: true
    blacklist:
      # Example:
      # mmoitems:
      #   - MATERIAL
      #   - CONSUMABLE
      mmoitems: []
    transfer-mode: "UPGRADE_AND_SOCKET"
    cooldown-seconds: 3
    modes:
      socket-only:
        success-rate: 100
        transfer-mode: "SOCKET_ONLY"
        requirements:
          permission: ""
          money: 0
          playerpoints: 0
          vanilla-items: {}
          mmoitems: {}
      upgrade-only:
        success-rate: 100
        transfer-mode: "UPGRADE_ONLY"
        requirements:
          permission: ""
          money: 0
          playerpoints: 0
          vanilla-items: {}
          mmoitems: {}
      upgrade-and-socket:
        success-rate: 100
        transfer-mode: "UPGRADE_AND_SOCKET"
        requirements:
          permission: ""
          money: 0
          playerpoints: 0
          vanilla-items: {}
          mmoitems: {}
```

### 4. Gem Removal

Create a GUI for removing gems from equipment, with fully customizable rates and requirements.

Customize the chance of the gem shattering during removal, the success rate, and more.

```
 remove:

    enabled: true
    success-rate: 100
    blacklist:
      # Example:
      # mmoitems:
      #   - MATERIAL
      #   - CONSUMABLE
      mmoitems: []
    # Removal modes:
    # RETURN_GEM  = remove the gem and return it to the player's inventory.
    # DESTROY_GEM = remove the gem and delete it.
    removal-mode: "RETURN_GEM"
    cooldown-seconds: 3
    requirements:
      permission: ""
      money: 0
      playerpoints: 0
      vanilla-items: {}
      mmoitems: {}
```

### 5. Item Identify (Comming Soon)

### 6. Gui Effects

Customize GUI effects to your liking!

```
fill:

  slots: [0,1,2,3,4,5,6,7,8,9,14,15,16,17,18,26,27,35,36,37,38,39,40,41,42,43,44]
  states:
    ready:
      material: LIME_STAINED_GLASS_PANE
    not-ready:
      material: RED_STAINED_GLASS_PANE
    processing:
      material-a: LIGHT_BLUE_STAINED_GLASS_PANE
      material-b: CYAN_STAINED_GLASS_PANE
      blinks: 5
      interval-ticks: 4
    success:
      material: LIME_STAINED_GLASS_PANE
      hold-ticks: 20
    failure:
      material: RED_STAINED_GLASS_PANE
      hold-ticks: 20
```

## III. PLACEHOLDER

Built-in GUI placeholders:

* %player\_name%: Player name.
* %lim\_id%: LagoonItemManager (ItemID) item ID, or None when the item has no LIM ID.
* %mmoitems\_name%: MMOItems display name of the current item.
* %mmoitems\_type%: MMOItems type of the current item.
* %mmoitems\_id%: MMOItems ID of the current item.
* %upgrade\_level%: Current upgrade level on the item.
* %socket\_count%: Current socket count on the item.
* %upgrade\_success\_rate%: Success rate for the next upgrade template. Shows 0 when no item is placed.
* %socket\_success\_rate%: Success rate for the next socket level. Shows 0 when no item is placed.
* %remove\_success\_rate%: Gem removal success rate. Shows 0 when no item is placed.
* %transfer\_success\_rate%: Success rate for the currently selected transfer mode. Shows 0 until transfer items are placed.
* %transfer\_socket\_only\_success\_rate%: Success rate for SOCKET\_ONLY transfer mode.
* %transfer\_upgrade\_only\_success\_rate%: Success rate for UPGRADE\_ONLY transfer mode.
* %transfer\_upgrade\_and\_socket\_success\_rate%: Success rate for UPGRADE\_AND\_SOCKET transfer mode.
* {money\_require}: Required Vault money for the current action.
* {points\_require}: Required PlayerPoints for the current action.
* %ingredients% or %ingredient\_lines%: One lore line per required ingredient.

## IV. COMMAND & PERMISSION

### 1. Command

* /mis open - open gui
* /mis status - dependencies status
* /mis open remove|socket|upgrade|transfer - open gui

### 2. Permission

* mmoitemsstationgui.admin - admin permission
* mmoitemsstationgui.open - true in default

## V. DENPENDECY

Soft-dependencies (require):

* MMoitems ([https://www.spigotmc.org/resources/⚔️-mmoitems-⚔️-items-weapons-armor-sets-tiers-editor-gui-skills.39267/](https://www.spigotmc.org/resources/%E2%9A%94%EF%B8%8F-mmoitems-%E2%9A%94%EF%B8%8F-items-weapons-armor-sets-tiers-editor-gui-skills.39267/))

Dependencies:

* Vault (<https://www.spigotmc.org/resources/vault.34315/>)
* Playerpoints (<https://www.spigotmc.org/resources/playerpoints.80745/>)
* ItemID (comming soon)