essence settings - magemonkeystudio/divinity GitHub Wiki

⚙️ Essence Settings

The settings.yml file controls global behavior and visuals for the essence socketing system, including GUI layout, socketing mechanics, success/failure actions, and visual feedback.

📁 File Location

plugins/Divinity/modules/essences/settings.yml

🔧 Configuration Sections

cfg_version

cfg_version: 1.0

Used internally to track config versioning.

command-aliases

command-aliases: essence,essences

Defines alternative command names players can use (e.g., /essence, /essences).

socketing

Controls core socketing behavior, visual feedback, and success/failure outcomes.

💬 Example

socketing:
  allow-duplicated-items: true

Allows multiple identical socketed items.

🎞 Animated Progress Bar

animated-bar:
  enabled: true
  bar-title: '&e&lSocketing...'
  bar-char: ▾
  bar-size: 20
  bar-format: '&a&l%success%%&r %bar%&r &c&l%failure%%'
  color-neutral: DARK_GRAY
  color-success: GREEN
  color-failure: RED
  fill-interval: 1
  fill-amount: 1
  min-success: 50

Displays a dynamic socketing bar showing the success/failure ratio visually.

🏪 Merchant Support

merchant:
  enabled: true

Enables use of the merchant GUI (see essence-merchant).

🎉 Actions on Socketing Outcome

actions-complete (on success)

actions-complete:
  default:
    action-executors:
    - '[PARTICLE_SIMPLE] ~name: SPELL_WITCH; ...'
    - '[SOUND] ~name: BLOCK_NOTE_BLOCK_BELL; ...'
    - '[TITLES] ~title: &a&lSocketing; ...'

Triggered on successful socketing.

actions-error (on failure)

actions-error:
  default:
    action-executors:
    - '[SOUND] ~name: ENTITY_VILLAGER_NO; ...'
    - '[TITLES] ~title: &c&lSocketing; ...'

Triggered on failure. Customizable via the Actions system.

❌ Failure Handling

failure:
  destroy-target: true
  destroy-source: false
  wipe-filled-sockets: false
  • destroy-target: Destroy the item if socketing fails
  • destroy-source: Destroy the essence if socketing fails
  • wipe-filled-sockets: Clears already-filled sockets (if true)

🎯 Silent Rate Bonus (Optional Scaling)

silent-rate-bonus:
  max-bonus: 20
  by-item-sockets:
    '0': 7
    '1': 5
    '2': 3
    '3': 1

Grants a hidden bonus based on how many sockets the item has. Max bonus is capped.

📝 Item Format

Controls how the essence item is displayed:

item-format:
  name: '%TIER_COLOR%%ITEM_NAME% %ITEM_LEVEL_ROMAN%'
  lore:
    - '&7Enchant Chance: &a&l%ITEM_SUCCESS_RATE%%'
    - '&7Tier: %TIER_NAME%'
    ...
  • %ITEM_SUCCESS_RATE%, %ITEM_LEVEL_ROMAN%, etc., are dynamic placeholders
  • Used when viewing or previewing the essence item

🖼 Socketing GUI

Defines layout and buttons for the main socketing interface:

gui:
  title: '&4&l<&4&nEssence Socketing&4&l>'
  size: 9
  item-slot: 3
  source-slot: 4
  result-slot: 5

GUI Content Items

content:
  filler:
    material: BLACK_STAINED_GLASS_PANE
    slots: 0,1,2,3,4,5,6,7,8
  accept:
    material: LIME_STAINED_GLASS_PANE
    name: '&a&l&nAccept'
    slots: '8'
  exit:
    material: RED_STAINED_GLASS_PANE
    name: '&c&l&nCancel'
    slots: '0'

Use filler panes to decorate the interface and clearly define actions.

📚 Related Pages