Pages » Qrpg » Modules » Soulbound


Commands

Command Arguments Description Player only Permission(s)
/soulbound soul [add]
[remove]
Add or remove item soulbound requirement. Yes quantumrpg.soulbound.cmd.soul
/soulbound untradeable [add]
[remove]
Add or remove item untradeable attribute. Yes quantumrpg.soulbound.cmd.untradeable

Permissions

Permission Description
quantumrpg.soulbound Full access to Soulbound module.
quantumrpg.soulbound.cmd Access to all Soulbound commands.

Settings.yml

# Additional item requirements.
item-requirements:
  # Player soulbound requirement.
  soulbound:
    # Enable/Disable requirement from being registered on plugin load.
    enabled: true
    # Requirement name.
    name: Soulbound
    # Requirement lore format.
    format:
      # Total requirement display.
      # Placeholders:
      # - %state% - Requirement state. Configurable in - ENGINE CONFIG -.
      # - %name% - Requirement name.
      # - %value% - Requirement value, see below.
      main: '&6%state%%name%: %value%'
      # Requirement value format.
      value:
        free: Required
        # Use %player% for player name.
        applied: '&f%player%'
  # Item untradeable attribute.
  untradeable:
    enabled: true
    name: Trade State
    format:
      main: '&6%state%%name%: %value%'
      value:
        free: Will be untradeable on pickup
        applied: Untradeable

# Defines the triggers when item with Untradeable attribute should be bound to the player.
bind-to-player:
  # Bounds when player drops Untradeable item.
  on-item-drop: true
  # Bounds when player pickups Untradeable item.
  on-item-pickup: true
  # Bounds when player click Untradeable item in Inventory/GUI.
  on-item-click: true
  # Bounds when player uses Untradeable item.
  on-item-interact: true

# Settings for interact with Untradeable/Soulbounded items.
interact:
  # Allow/Disallow drop of untradeable/soulbounded items.
  allow-drop: true
  # Allow/Disallow drop on death of untradeable/soulbounded items.
  drop-on-death: false
  # Block certain commands while holding untradeable/soulbounded items.
  # You don't need to provide all command aliases, plugin will find them automatically.
  blocked-commands:
  - 'market'
  - 'auc'
  - 'ah'

# Soulbound GUI.
gui:
  title: '&2&l<&2&nSoulbound&2&l>'
  size: 9
  item-slot: 3
  source-slot: 4
  result-slot: 5
  content:
    filler:
      material: BLACK_STAINED_GLASS_PANE
      skull-hash: ''
      enchanted: false
      name: ''
      lore: []
      slots: 0,1,2,3,4,5,6,7,8
      type: NONE
    accept:
      material: LIME_STAINED_GLASS_PANE
      skull-hash: ''
      enchanted: false
      name: '&2« &aAccept &2»'
      lore:
      - '&7The item will be soulbounded'
      - '&7with you.'
      - ''
      - '&7After that, you can not'
      - '&7trade your item &canymore&7.'
      slots: '8'
      type: ACCEPT
    exit:
      material: RED_STAINED_GLASS_PANE
      skull-hash: ''
      enchanted: false
      name: '&4« &cCancel &4»'
      lore: []
      slots: '0'
      type: EXIT'
18+