profiles gui settings - magemonkeystudio/divinity GitHub Wiki

🧩 gui.settings.yml

This file defines the Profile Settings GUI, which allows players to toggle personal options such as mob name visibility and helmet rendering. It is accessible from the main profile menu.


📂 File Location

/plugins/Divinity/profiles/gui.settings.yml


📘 Default Layout

title: '&8&m           &8&l[ &9&lSettings &8&l]&8&m           '
size: 36
content:
  entity-names:
    material: 'NAME_TAG'
    name: '&eMob Names'
    lore:
      - '&bCurrent Mode: &a%entity-names%'
      - '&7'
      - '&7Toggling this option will'
      - '&7require the chunk update to'
      - '&7be affected for nearby entities.'
      - '&7'
      - '&6Left-Click: &eChange'
    type: SETTING_ENTITY_NAMES
    slots: 0

  player-helmet:
    material: 'GOLDEN_HELMET'
    name: '&eHelmet Invisibility'
    lore:
      - '&bCurrent: &a%player-helmet%'
      - '&7'
      - '&7Hides your helmet for'
      - '&7other players.'
      - '&c(but not for you)'
      - '&7'
      - '&6Left-Click: &eChange'
    item-flags:
      - '*'
    type: SETTING_PLAYER_HELMET
    slots: 1

  return:
    material: 'BARRIER'
    name: '&c&lReturn'
    type: RETURN
    slots: 31

⚙️ Settings Explained

Key Description
title Title of the GUI. Supports color codes.
size Number of inventory slots (must be a multiple of 9).
content Each key defines a clickable setting or button within the GUI.

Each setting or button inside content supports the following fields:

Field Description
material Item used for display (e.g., NAME_TAG, BARRIER).
name Display name in the GUI. Supports color formatting.
lore Tooltip/lore lines. %placeholders% are replaced with current values.
type The action taken when clicked (see supported types below).
slots Slot(s) where the item appears (0-based index).
item-flags Optional. Can hide attributes or effects visually. * hides all.

🔄 Supported Setting Types

Type Description
SETTING_ENTITY_NAMES Toggles name visibility for entities (mobs).
SETTING_PLAYER_HELMET Toggles whether your helmet is visible to others.
RETURN Returns to the previous GUI.

💬 Placeholders

Placeholder Description
%entity-names% Displays the current mob name visibility mode.
%player-helmet% Displays whether helmet is hidden or visible.

💡 Tips

  • GUI changes are stored per player profile.
  • Options like Helmet Invisibility are cosmetic only and do not affect armor stats.
  • entity-names changes may require nearby chunks to reload to take visual effect.

Use /divinity reload or restart the server to apply any changes to this file.