module item_hints

💡 Item Hints

The Item Hints module adds visual and textual enhancements to items dropped on the ground, such as custom name displays and item glow effects. This helps players better identify valuable or important items at a glance.

---

📁 File Location

plugins/Divinity/modules/item_hints/settings.yml

---

🛠️ Configuration Example

command-aliases: itemhints,hints

glow:
  enabled: false
  ignored-items:
    vanilla: false
    by-material:
    - BEDROCK
    - BARRIER
    by-name:
    - 'some word'
    - '***{'
    - 'QS_SHOWCASE'
    by-lore:
    - 'some lore word'
    by-module:
    - 'module name'

hint:
  enabled: true
  format:
    singular: '%name%'
    plural: '%name% &7x%amount%'
  ignored-items:
    vanilla: false
    by-material:
    - BEDROCK
    - BARRIER
    by-name:
    - 'some word'
    - '***{'
    - 'QS_SHOWCASE'
    by-lore:
    - 'some lore word'
    by-module:
    - 'module name'

---

🔑 Key Sections

📛 command-aliases

Defines the commands players can use to manage or toggle item hint behavior:

• /itemhints
• /hints

✨ glow

Controls whether items glow when on the ground.

• enabled: If true, items will emit a glow effect unless ignored.
• ignored-items: Filters that prevent certain items from glowing based on:
  • vanilla: If true, all non-custom (vanilla) items are ignored.
  • by-material: Material names like BEDROCK, BARRIER.
  • by-name: Partial name matches to ignore specific custom items.
  • by-lore: Filters based on item lore text.
  • by-module: Excludes items created by a specific module.

📝 hint

Controls the floating text display above dropped items.

• enabled: Enables or disables name hints entirely.
• format: Defines how item names are formatted.
  • singular: Used when there's only one of an item.
  • plural: Used when item stack is larger than one.
• ignored-items: Same filter system as glow to prevent hints from showing on certain items.

---

✅ Example Usage

When a player drops an item:

• If hint.enabled is true, the item’s name is shown floating above it.
• If glow.enabled is true, the item may also glow unless filtered out.

This helps highlight rare drops or quest items on the ground.

---

💬 Commands & Permissions

Command	Description	Permission
/itemhints help	Show help page	divinity.itemhints.help
/itemhints reload	Reload the module	divinity.itemhints.reload