editor sockets - magemonkeystudio/divinity GitHub Wiki

πŸ’  Editor: Sockets

The Sockets editor option allows items to roll with socket slots for GEMs, ESSENCEs, and RUNEs. These sockets can later be filled with special enhancements, allowing for advanced item customization and build crafting.

πŸ“ Where Sockets Are Defined

Socket types and their contents are defined in the following module pages:

The socket slot behavior is configured in:

plugins/Divinity/item_stats/sockets.yml

βš™οΈ What the Editor Lets You Modify

For each socket type (GEM, ESSENCE, RUNE), you can:

  • Set minimum and maximum number of sockets
  • Define socket tiers (e.g., common, rare, legendary)
  • Assign roll chances per tier
  • Customize how sockets appear in the item’s lore

πŸ“„ Example (Item Generator File)

sockets:
  GEM:
    minimum: 0
    maximum: 2
    lore-format:
      - 'GEMS'
      - '%SOCKET_GEM_COMMON%'
      - '%SOCKET_GEM_RARE%'
      - '%SOCKET_GEM_UNCOMMON%'
      - '%SOCKET_GEM_LEGENDARY%'
      - '%SOCKET_GEM_VERYRARE%'
    list:
      common:
        chance: 35.0
      rare:
        chance: 15.0
      uncommon:
        chance: 0.0
      legendary:
        chance: 0.0
      veryrare:
        chance: 0.0
  ESSENCE:
    minimum: 0
    maximum: 2
    lore-format:
      - 'ESSENCES'
      - '%SOCKET_ESSENCE_DEFAULT%'
    list:
      default:
        chance: 35.0
  RUNE:
    minimum: 0
    maximum: 2
    lore-format:
      - 'RUNES'
      - '%SOCKET_RUNE_DEFAULT%'
    list:
      default:
        chance: 35.0

🧾 Explanation of Fields

Field Description
GEM, ESSENCE, RUNE Top-level socket types.
minimum / maximum Number of sockets that may roll for that type.
lore-format Defines how socket types and tiers appear in item lore.
list Contains individual tiers or variations with their roll chances.
chance % chance for the specific tier (e.g., rare, default) to roll.

πŸ”§ Placeholders

%SOCKET_{TYPE}_{TIER}%

Examples:

  • %SOCKET_GEM_COMMON%
  • %SOCKET_RUNE_DEFAULT%
  • %SOCKET_ESSENCE_DEFAULT%

πŸ§ͺ Use Case

  • Create loot with randomized socketing potential
  • Combine with other systems (e.g., Fabled or Gems) for deeper item progression
  • Design sockets for different item archetypes (e.g., magical vs physical gear)

Return to: Item Generator Module