> For the complete documentation index, see [llms.txt](https://obey.gitbook.io/wiki/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://obey.gitbook.io/wiki/tools/messages.md).

# Messages

## Default messages.yml

```yaml
messages:
  tool-broke: '%prefix% Your %tool% broke. You can pay to repair it. Check the Tool for more Information.'
  tool-removed: '%prefix% Your tool broke and was removed from your inventory.'
  tool-broken: '%prefix% You can not use this tool. Its broken :c'
  tool-repaired: '%prefix% You repaired your %tool%%white% for %accent%$%price%%white%.'
  tool-given: '%prefix% You gave a %tool-type% of type %usage-type% with value %value% to %player%.'
  unlimited: Unlimited

  # drills
  drill-display-name: '<#8e3dff>⛏ <#8e3dff>&lDRILL'
  drill-display-name-broken: '<#8e3dff>⛏ <#8e3dff>&lDRILL</b> <gray>[Broken]'
  drill-lore-uses:
    - '&8ᴛᴏᴏʟѕ'
    - '&f'
    - '<#8e3dff>Description:'
    - '&fThe Drill allows you to break'
    - '&fblocks in a 3x3 area.'
    - '&f'
    - '<#8e3dff>Information:'
    - '&fUses&8: <#8e3dff>%uses%&8/<#8e3dff>%max-uses%'
    - '&fBroken Blocks&8: <#8e3dff>%secondary%'
    - '&f'
  drill-lore-broken-uses:
    - '&8ᴛᴏᴏʟѕ'
    - '&f'
    - '<#8e3dff>Description:'
    - '&fThe Drill allows you to break'
    - '&fblocks in a 3x3 area.'
    - '&f'
    - '<#8e3dff>Information:'
    - '&fUses&8: <#8e3dff>%uses%&8/<#8e3dff>%max-uses%'
    - '&fBroken Blocks&8: <#8e3dff>%secondary%'
    - '&f'
    - '&fPrice&8: &8[<#3dff87>$%price%&8]'
    - '<#3dff87>Shift Rightclick to Repair'
    - '&f'
  drill-lore-time:
    - '&8ᴛᴏᴏʟѕ'
    - '&f'
    - '<#8e3dff>Description:'
    - '&fThe Drill allows you to break'
    - '&fblocks in a 3x3 area.'
    - '&f'
    - '<#8e3dff>Information:'
    - '&fExpires&8: <#8e3dff>%expires%'
    - '&fRemaining&8: <#8e3dff>%remaining%'
    - '&fBroken Blocks&8: <#8e3dff>%secondary%'
    - '&f'
  drill-lore-broken-time:
    - '&8ᴛᴏᴏʟѕ'
    - '&f'
    - '<#8e3dff>Description:'
    - '&fThe Drill allows you to break'
    - '&fblocks in a 3x3 area.'
    - '&f'
    - '<#8e3dff>Information:'
    - '&fExpires&8: <#8e3dff>%expires%'
    - '&fRemaining&8: <#8e3dff>%remaining%'
    - '&fBroken Blocks&8: <#8e3dff>%secondary%'
    - '&f'

  # excavator
  excavator-display-name-broken: <#FFB347>🔱 <b>EXCAVATOR</b> <gray>[Broken]
  excavator-display-name: <#FFB347>🔱 <b>EXCAVATOR</b>
  excavator-lore-uses:
    - '&8ᴛᴏᴏʟѕ'
    - '&f'
    - '<#FFB347>Description:'
    - '&fThe Excavator allows you to break'
    - '&fblocks in a 3x3 area.'
    - '&f'
    - '<#FFB347>Information:'
    - '&fUses: <#FFB347>%uses%/%max-uses%'
    - '&fBroken Blocks: <#FFB347>%secondary%'
    - '&f'

  # endless bucket
  endless_bucket-display-name-broken: <#00FF8D>🪣 <b><ENDLESS BUCKET></b> <gray>[Broken]
  endless_bucket-display-name: <#00FF8D>🪣 <b><ENDLESS BUCKET></b>

  # infinity rocket
  infinity_rocket-display-name-broken: <#FF4D6D>☄ <b>INFINITY ROCKET</b> <gray>[Broken]
  infinity_rocket-display-name: <#FF4D6D>☄ <b>INFINITY ROCKET</b>

  # instant axe
  instant_axe-display-name-broken: <#00FF8D>🪓 <b>INSTANT AXE</b> <gray>[Broken]
  instant_axe-display-name: <#00FF8D>🪓 <b>INSTANT AXE</b>

  # multi tool
  multi_tool-display-name-broken: <#9B5DE5>⚑ <b>MULTI TOOL</b> <gray>[Broken]
  multi_tool-display-name: <#9B5DE5>⚑ <b>MULTI TOOL</b>
```

## What these values mean

### System Messages

* `tool-broke`: Message sent when a tool depletes its uses or time limit and enters the broken state.
* `tool-removed`: Message sent when a tool breaks and is permanently removed (when `remove-on-destruction: true`).
* `tool-broken`: Message sent when a player attempts to use a broken tool.
* `tool-repaired`: Message sent to a player upon successfully repairing a broken tool.
* `tool-given`: Message sent to an administrator after giving a tool via `/tools give`.
* `unlimited`: The text used in lore placeholders when a tool has unlimited uses or time (`value = -1`).

### Tool Display Names & Lore

* `<tool>-display-name`: Display name format applied to custom tools when active. Supports MiniMessage and legacy color formatting.
* `<tool>-display-name-broken`: Display name format applied when a tool becomes broken.
* `<tool>-lore-uses` / `<tool>-lore-time`: Lore template for active tools operating in `USES` mode or `TIME` mode.
* `<tool>-lore-broken-uses` / `<tool>-lore-broken-time`: Lore template displayed on broken tools, featuring the repair price and instructions.