module soulbound - magemonkeystudio/divinity GitHub Wiki

πŸ”’ Soulbound Module

The Soulbound module allows items to become permanently linked to a specific player and prevents them from being traded, dropped, or used outside the owner’s control. This page documents its configuration and command usage.

πŸ“ File Location

plugins/Divinity/modules/soulbound/settings.yml

🧾 Configuration

command-aliases: soulbound

item-requirements:
  soulbound:
    enabled: true
    name: Soulbound
    format:
      main: '&6%state%%name%: %value%'
      value:
        free: Required
        applied: '&f%player%'
  untradeable:
    enabled: true
    name: Trade State
    format:
      main: '&6%state%%name%: %value%'
      value:
        free: Will be untradeable on pickup
        applied: Untradeable

bind-to-player:
  on-item-drop: true
  on-item-pickup: true
  on-item-click: true
  on-item-interact: true

interact:
  allow-drop: true
  drop-on-death: false
  blocked-commands:
    - 'market'
    - 'auc'
    - 'ah'

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

πŸ’¬ Commands

Command Description
`/soulbound soul <add remove> [position]`
`/soulbound untradeable <add remove> [position]`
/soulbound help Show help page.
/soulbound reload Reload the soulbound module.

The [position] argument defines the lore line slot to apply or remove the tag from. Example: /soulbound soul add 2 adds the soulbound line to position 2 in the item's lore.

πŸ›‘οΈ Permissions

Node Description
divinity.soulbound.command Grants access to all /soulbound commands.
divinity.soulbound.edit Required to add/remove soulbound or untradeable flags.
divinity.soulbound.reload Allows use of /soulbound reload.

πŸ” Feature Behavior

Soulbound Tag

When active, the item shows a line like:

Soulbound: PlayerName

This prevents other players from using or interacting with the item.

Untradeable Tag

When added, the item becomes:

Trade State: Untradeable

The item cannot be listed in auction house, market, or picked up by others.

Bind Triggers

These automatic behaviors cause an item to become soulbound:

  • When dropped (on-item-drop)
  • When picked up (on-item-pickup)
  • On click or interaction (on-item-click, on-item-interact)

🚫 Interactions Blocked

When the item is bound, it cannot be used with the following commands:

  • /market
  • /auc
  • /ah

Also, soulbound items are not dropped on player death (drop-on-death: false).

πŸ”— Back to Home

← Return to Home

⚠️ **GitHub.com Fallback** ⚠️