diff --git a/README.MD b/README.MD index 6b2c169..c64b1c9 100644 --- a/README.MD +++ b/README.MD @@ -1,8 +1,17 @@ -### About -AnvilUnlocker is a Bukkit plugin allowing anvils to be used past the normal level cap of 40. No permissions. +# Anvil Unlocker -The level cap is set via configuration option `maximumCost`. Any integer from 41 to 32767 is valid. +Disables the ‘Too Expensive!’ message and allows using anvils past the normal level cap of 40. No permissions. -### Caveats -* Due to client limitations, repair costs over 40 levels cannot be displayed in red if the client lacks the experience required to complete the repair. For simplicity and consistency, AnvilUnlocker uses an approach that entirely removes the mechanic of the cost turning red when the client lacks the required experience, even when the cost is under 40 levels. -* Due to the client's inability to display items' costs greater than a short's max value (32767) and subsequent wrapping around, the new maximum is capped to 32767 instead of allowing any valid int value. +The new level cap is configurable. Any integer from 41 to 32,767 is valid. + +**[ProtocolLib](https://github.com/dmulloy2/ProtocolLib/releases) is required.** + +![Screenshot showing an anvil with ‘Enchantment Cost: 55’ in green.](https://cdn.modrinth.com/data/N4CZEMrg/images/2b745ef9e906c21c566d91d1ae95049e938cb655.png) + +## Caveats + +Due to Vanilla client limitations: + +* Anvil costs above 40 levels cannot be displayed in red if the client lacks the required + experience. For simplicity and consistency, the mechanic of the cost turning red is disabled entirely. +* Costs greater than 32,767 levels cannot be rendered correctly and are therefore not supported.