💠 gems-items

This page explains how to create and configure gem items used in the Divinity plugin. Gem items provide bonuses, skills, and effects when socketed into equipment.

---

📁 File Location

Gem item files are stored in:

plugins/Divinity/modules/gems/items/

Each .yml file represents one gem.

---

🧾 Example

material: GOLD_NUGGET
name: 'Nugget of Agility'
socket-display: '&aAgility Nugget %ITEM_LEVEL_ROMAN% &7(&fDodge +%ITEM_STAT_DODGE_RATE%%&7)'
lore:
  - '&7Dodge Rate: &f+%ITEM_STAT_DODGE_RATE%%'
tier: rare
enchanted: false
item-flags:
  - '*'

level:
  min: 1
  max: 3

uses-by-level:
  '1': 1

success-rate-by-level:
  '1': '40:80'
  '2': '35:70'
  '3': '30:60'

bonuses-by-level:
  '1':
    item-stats:
      DODGE_RATE: 2.0
  '2':
    item-stats:
      DODGE_RATE: 2.5
  '3':
    item-stats:
      DODGE_RATE: 3.0

skills:
  my_custom_skill: # Skill name used in the Fabled editor
    level: 1
    lore-format:
      - '&bAgility Dash: &7[&f%level%&7]'

target-requirements:
  level:
    '1': '1:10'
    '2': '10:20'
    '3': '30'
  type:
    - ARMOR
  socket: common
  module:
    - '*'

---

🧠 Skill Integration

If you're using the Fabled plugin, you can grant custom skills to gems using the skills: section.

skills:
  my_custom_skill: # Skill name used in the Fabled editor
    level: 2
    lore-format:
      - '&9Special Skill: &7[&f%level%&7]'

• The key (my_custom_skill) must match the registered Fabled skill name.
• The level defines which version or strength of the skill to activate.
• The lore-format controls how the skill is displayed in the gem’s tooltip.

---

🔍 Key Sections

Key	Description
material	Minecraft material of the gem item
name, lore	Display name and tooltip text
socket-display	Text shown when the gem is socketed
tier, enchanted	Gem tier and visual glow effect
level	Minimum and maximum gem level
uses-by-level	Number of socketing uses by gem level
success-rate-by-level	Percent chance of successful socketing at each level
bonuses-by-level	Stats or effects applied when the gem is socketed (level-based)
skills	Grants abilities via the Fabled plugin using lore and level formatting
target-requirements	Restrictions on where the gem can be socketed (item type, level, etc.)