diff --git a/README.md b/README.md index 4492ecc..74de978 100644 --- a/README.md +++ b/README.md @@ -26,41 +26,57 @@ fee. Costs are highly customizable. To create a new blacksmith, simply add the blacksmith trait to an NPC by selecting it with `/npc select`, and then using `/trait add Blacksmith` (See Citizens' documentation for more details). -Right-clicking the NPC will tell you if the currently held item is repairable by the blacksmith. If it is, the -blacksmith should give a price quote. Right-clicking again starts the repair. The item should be given back or dropped -after a random delay according to the set limits. +To create a new scrapper, simply add the scrapper trait to an NPC by selecting it with `/npc select`, and then using +`/trait add Scrapper` (See Citizens' documentation for more details). -While costs are always set globally (no blacksmith can do the same job for cheaper), the blacksmith's messages, -cool-down between each reforge, whether the item is dropped or given, the chance of failing or adding an enchantment, -the maximum number of added enchantments, max and min delays, the length of the cool-down and which items the blacksmith -is able to reforge can be changed individually. +Right-clicking the NPC will tell you if the currently held item is repairable by the blacksmith / salvageable by the +scrapper. If it is, the blacksmith / scrapper should give a price quote. Right-clicking again starts the repair / +salvage. The item should be given back or dropped after a random delay according to the set limits. + +While costs are always set globally (no blacksmith or scrapper can do the same job for cheaper), the blacksmith / +scrapper's messages, cool-down between each reforge / salvage, whether the item is dropped or given, the chance of +failing or adding an enchantment, the maximum number of added enchantments, max and min delays, the length of the +cool-down and which items the blacksmith is able to reforge / salvage can be changed individually. Also note: As a change from the original plugin, unless a value for an NPC has been explicitly set for that NPC, it will mirror the values set in config.yml. This also means that configuration values aren't populated automatically in citizen's NPC save file. While you can manually set the values using the same keys as in config.yml, you should use the -/blacksmith command when possible. +`/blacksmith` or `/scrapper` command when possible. ### Special behavior -In addition to just being able to repair items, blacksmiths have some random features which can be cool or annoying: +In addition to just being able to repair items, blacksmiths / scrappers have some random features which can be cool or +annoying: -- There is a chance that blacksmiths fail to repair an item, leaving it at about the same durability as before. Use +- There is a chance that blacksmiths / scrappers fail to repair an item, leaving it at about the same durability as + before (scrappers with `extendedSalvageEnabled` turned on might cause items in a stack to be lost). Use failReforgeChance to control the chance. Set it to 0 to remove the feature. - There is a chance a blacksmith may add an enchantment to a reforged item. You can control the probability using - extraEnchantmentChance, and set the maximum number of enchantments using maxEnchantments. EnchantmentBlocklist can be + extraEnchantmentChance, and set the maximum number of enchantments using maxEnchantments. EnchantmentBlockList can be used to block any enchantments you don't want to randomly grant. +### Scrapper basics + +A scrapper will produce salvage for a damage-able item by calculating the amount of items returned based on items in the +recipe, and the percentage of durability left on the item. To avoid returning relatively worthless items instead of +valuable items, `ignoredSalvage` can be configured. If the item is fully repaired, the worthless items will be returned +as well, but otherwise, only the valuable items are considered as possible salvage. A scrapper will by default only +salvage damage-able items (same as blacksmiths), but enabling `extendedSalvageEnabled` for a scrapper will allow it to +salvage any crafting table recipe. Note that to salvage for example planks into wood, four wood will be taken. + +When an item is salvaged, EXP will be returned based on enchantments on the item. + ## Commands | Command | Arguments | Description | |-------------------|-------------------------------|----------------------------------------------------------------------------------------------| | /blacksmith | \