BotchedDurability Configuration Guide

================
GENERAL SETTINGS
================

settings:
  lore-display: true
  lore-format: "&7Durability: &a%current% &7/ &c%max%"

lore-display
- true = Show durability in lore
- false = Disable lore display

lore-format
Available placeholders:
%current%
%max%

Example:

Durability: 4500 / 5000

===============
DAMAGE SETTINGS
===============

damage:
  weapon-hit: 1
  block-break: 1
  armor-hit: 1

weapon-hit
Durability lost when attacking entities.

block-break
Durability lost when breaking blocks.

armor-hit
Durability lost when armor takes damage.

==============
BREAK SETTINGS
==============

break:
  destroy-item: true
  play-sound: true
  sound: BLOCK_ANVIL_BREAK

  item-message: "&cYour item has broken!"
  armor-message: "&cA piece of your armor has broken!"

  minimum-durability: 1

destroy-item
true = item is destroyed
false = item remains at minimum durability

play-sound
Plays a sound when an item breaks.

minimum-durability
Used when destroy-item is false.

===============
REPAIR SETTINGS
===============

repair:
  money:
    enabled: true
    cost: 1000

    currency-name: "Coins"

enabled
Enable economy-based repairs.

cost
Default repair cost.

currency-name
Displayed currency name.

Vault is recommended.

Compatible with:
- CoinsEngine
- Essentials Economy
- CMI Economy
- Any Vault economy provider

=======================
RANK DURABILITY BONUSES
=======================

durability-multipliers:
  enabled: true
  default: 1.0

  ranks:
    Premium:
      permission: "group.premium"
      multiplier: 0.90

    VIP:
      permission: "group.vip"
      multiplier: 0.80

enabled
Enable rank durability bonuses.

default
Normal durability multiplier.

multiplier values:

1.00 = No bonus
0.90 = 10% save chance
0.80 = 20% save chance
0.70 = 30% save chance
0.60 = 40% save chance

Rank names can be changed.

Example:

Donator
Hero
Mythic
Titan

===========
BOOK PRICES
===========

book-prices:
  reinforced:
    1: 5000
    2: 10000
    3: 25000
    4: 50000
    5: 100000

  fortified:
    1: 7500
    2: 15000
    3: 30000
    4: 60000
    5: 125000

Used by:

/bd buybook

============
CUSTOM ITEMS
============

Register a custom item:

/bd register FireSword 5000 2500 false

Result:

custom-items:
  FireSword:
    material: IRON_SWORD
    max-durability: 5000

    repair:
      cost: 2500

    damage:
      weapon-hit: 1
      block-break: 1
      armor-hit: 1

    unbreakable: false

=================
UNBREAKABLE ITEMS
=================

Register:

/bd register AdminSword 5000 0 true

Result:

unbreakable: true

Unbreakable items never lose durability.

========
ENCHANTS
========

Reinforced

Reinforced I = 10%
Reinforced II = 20%
Reinforced III = 30%
Reinforced IV = 40%
Reinforced V = 50%

Effect:
Chance to ignore durability damage.

Fortified

Fortified I = +500
Fortified II = +1000
Fortified III = +1500
Fortified IV = +2000
Fortified V = +2500

Effect:
Increases maximum durability.

=============
ENCHANT BOOKS
=============

Apply Books:

1. Hold enchant book in main hand.
2. Hold BotchedDurability item in offhand.
3. Right-click.
4. Book is consumed.
5. Enchant is applied.

Books cannot downgrade existing enchants.

Example:

Reinforced V item
+
Reinforced III book

Result:

Book will not apply.

=========================
CUSTOM ITEM COMPATIBILITY
=========================

BotchedDurability has been tested with:

* Vanilla Minecraft Items
* Nexo Custom Items

Custom item support preserves:

* Custom Models
* Custom Names
* Durability Data
* Enchantments
* Persistence Across Restarts

Additional custom item plugins may be compatible but have not been officially tested.

=============
DAMAGE EDITOR
=============

Change the attack damage (and attack speed) of ANY item.

damage-editor:
  enabled: true

  materials:
    DIAMOND_SWORD:
      damage: 10
      speed: 1.6

    STICK:
      damage: 4

enabled
true  = Damage editor active
false = /bd damage disabled and no automatic updates

materials
Default damage for every item of that material.
speed is optional. Leave it out to keep the item's normal speed.

Custom items (registered with /bd register) can have their own values:

custom-items:
  FireSword:
    material: IRON_SWORD
    max-durability: 5000
    attack-damage: 14
    attack-speed: 1.8

How values work:
- Values are totals, exactly as shown in the tooltip.
  Vanilla diamond sword = 7 damage / 1.6 speed.
- Max damage 2048, max speed 1024.
- The plugin writes real Minecraft attributes, so attack cooldown,
  critical hits, Sharpness, Strength and armor still work normally.

Priority (highest first):
1. Manual edits with /bd damage set/add/multiply/speed
2. custom-items.<id>.attack-damage
3. damage-editor.materials.<MATERIAL>

Manual edits are stored on the item itself and are never
overwritten by config changes. Use /bd damage reset to clear one.

When items update:
- Player joins
- Item is held / swapped to main hand
- Item is picked up or crafted
- Inventory is closed
- /bd reload and /bd damage setdefault

If you remove a material or custom-item entry, items that got their
damage from that entry return to normal the next time they update.

=======================
SERVER COMPATIBILITY
=======================

BotchedDurability-1.1.1.jar (recommended, universal)
- Paper 1.21.8, 1.21.9, 1.21.10, 1.21.11  (Java 21+)
- Paper 26.1.x, 26.2, 26.3               (Java 25)

BotchedDurability-1.1.1-java25.jar
- Built with Java 25 against the Paper 26.3 API
- Paper 26.1.x, 26.2, 26.3 only

