From b3128c05256922d0f49a1b4502b1c85f7cdadbed Mon Sep 17 00:00:00 2001 From: EpicKnarvik97 Date: Wed, 12 Oct 2022 13:31:35 +0200 Subject: [PATCH] Improves README by using tables --- README.md | 77 ++++++++++++++++++++++++++----------------------------- 1 file changed, 36 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 0bd615b..e0e0827 100644 --- a/README.md +++ b/README.md @@ -54,56 +54,51 @@ for a specific material/enchantment. ## Permissions -- blacksmith.admin - Allows overall blacksmith configuration -- blacksmith.edit - Allows changing settings for the selected blacksmith NPC -- blacksmith.use - Allows the player to repair items using blacksmiths +| Permission node | Description | +| --- | --- | +| blacksmith.admin | Allows overall blacksmith configuration | +| blacksmith.edit | Allows changing settings for the selected blacksmith NPC | +| blacksmith.use | Allows the player to repair items using blacksmiths | ## Configuration options ### Global-only options -- basePrice (positive decimal number) - The base price which has to be paid regardless of the durability remaining for - an item. Setting this without specifying a material sets the basePrice for any item the basePrice has not been set - for. -- pricePerDurabilityPoint (positive decimal number) - The price added for each durability point present/missing (depends - on natural cost's value). Setting this without specifying a material sets the pricePerDurabilityPoint for any item the - pricePerDurabilityPoint has not been set for. -- enchantmentCost (positive decimal number) - The added cost for each level of an enchantment present on the item. The - cost can be set for specific enchantments. Not specifying an enchantment sets the value for all enchantments without a - set value. -- useNaturalCost (true/false) - If true, each missing durability will add to the cost (price = basePrice + - missingDurability * pricePerDurabilityPoint + enchantmentCost). If false, durability will be used to calculate the - cost instead of missingDurability (this was the behavior before natural cost was added). +| Key | Value type | Description | +| --- | --- | --- | +| basePrice | positive decimal number | The base price which has to be paid regardless of the durability remaining for an item. Setting this without specifying a material sets the basePrice for any item the basePrice has not been set for. | +| pricePerDurabilityPoint | positive decimal number | The price added for each durability point present/missing (depends on whether natural cost is set to true or false). Setting this without specifying a material sets the pricePerDurabilityPoint for any item the pricePerDurabilityPoint has not been set for. | +| enchantmentCost | positive decimal number | The added cost for each level of an enchantment present on the item. The cost can be set for specific enchantments. Not specifying an enchantment sets the value for all enchantments without a set value. +| useNaturalCost | true/false | If true, each missing durability will add to the cost (price = basePrice + missingDurability * pricePerDurabilityPoint + enchantmentCost). If false, durability will be used to calculate the cost instead of missingDurability (this was the behavior before natural cost was added). | -### Per-npc (with default values) +### Per-npc (with default values set in config.yml) #### Configuration values -- dropItem (true/false) - Whether the blacksmith should drop the repaired item on the ground (instead of putting it into - the player's inventory) -- disableCoolDown (true/false) - Whether to completely disable the cool-down between repairs -- disableDelay (true/false) - Whether to completely disable the delay required to reforge an item -- failReforgeChance (0-100) - The chance of the blacksmith failing to repair an item -- extraEnchantmentChance (0-100) - The chance of the blacksmith adding an enchantment to an item -- maxEnchantments (0-10) - The maximum number of different enchantments a blacksmith can add -- maxReforgeDelay (0-3600) - The maximum number of seconds a player needs to wait for an item to be repaired -- minReforgeDelay (0-3600) - The minimum number of seconds a player needs to wait for an item to be repaired -- reforgeCoolDown (0-3600) - The cool-down a player has to wait between each time they use one specific blacksmith -- reforgeAbleItems (DIAMOND_LEGGINGS,GOLD-pickaxe,bow, etc.) - Specifies which items this blacksmith is able to reforge. - If set to "" or null, all items can be repaired. If set to a list of items, only the items specified can be repaired. - Some presets have been included for ease of use. Use a preset by specifying "preset:sword-smith" instead of a material - such as "gold-pickaxe". Available presets: SWORD_SMITH, WEAPON_SMITH, ARMOR_SMITH, TOOL_SMITH, RANGED_SMITH. +| Key | Value type | Description | +| --- | --- | --- | +| dropItem | true/false | Whether the blacksmith should drop the repaired item on the ground (instead of putting it into the player's inventory). | +| disableCoolDown | true/false | Whether to completely disable the cool-down between repairs. | +| disableDelay | true/false | Whether to completely disable the delay required to reforge an item. | +| failReforgeChance | 0-100 | The chance of the blacksmith failing to repair an item. | +| extraEnchantmentChance | 0-100 | The chance of the blacksmith adding an enchantment to an item. | +| maxEnchantments | 0-10 | The maximum number of different enchantments a blacksmith can add. | +| maxReforgeDelay | 0-3600 | The maximum number of seconds a player needs to wait for an item to be repaired. | +| minReforgeDelay | 0-3600 | The minimum number of seconds a player needs to wait for an item to be repaired. | +| reforgeCoolDown | 0-3600 | The cool-down, in seconds, a player has to wait between each time they use one specific blacksmith. | +| reforgeAbleItems | DIAMOND_LEGGINGS,GOLD-pickaxe,bow, etc. | Specifies which items this blacksmith is able to reforge. If set to "" or null, all normally repairable items can be repaired. If set to a list of items, only the items specified can be repaired. Some presets have been included for ease of use. Use a preset by specifying "preset:sword-smith" instead of a material such as "gold-pickaxe". Available presets: SWORD_SMITH, WEAPON_SMITH, ARMOR_SMITH, TOOL_SMITH, RANGED_SMITH. | #### Messages -- busyPlayerMessage - The message displayed when the blacksmith is serving another player -- busyReforgeMessage - The message displayed when the blacksmith is busy reforging an item -- coolDownUnexpiredMessage - The message displayed when the player has to wait for the cool-down to expire before using - the blacksmith again -- costMessage - The message displayed when telling a player about the cost of repairing an item -- failReforgeMessage - The message displayed when a blacksmith fails to reforge an item -- insufficientFundsMessage - The message displayed when a player is unable to pay for reforging an item -- invalidItemMessage - The message displayed when a blacksmith is presented an item which it cannot repair -- itemChangedMessage - The message displayed when a player changes their item after being shown the repair cost -- startReforgeMessage - The message displayed when a blacksmith starts reforging an item -- successMessage - The message displayed when a blacksmith successfully repairs an item \ No newline at end of file +| Message Key | Explanation | +| --- | --- | +| busyPlayerMessage | The message displayed when the blacksmith is serving another player | +| busyReforgeMessage | The message displayed when the blacksmith is busy reforging an item | +| coolDownUnexpiredMessage | The message displayed when the player has to wait for the cool-down to expire before using the blacksmith again | +| costMessage | The message displayed when telling a player about the cost of repairing an item | +| failReforgeMessage | The message displayed when a blacksmith fails to reforge an item | +| insufficientFundsMessage | The message displayed when a player is unable to pay for reforging an item | +| invalidItemMessage | The message displayed when a blacksmith is presented an item which it cannot repair | +| itemChangedMessage | The message displayed when a player changes their item after being shown the repair cost | +| startReforgeMessage | The message displayed when a blacksmith starts reforging an item | +| successMessage | The message displayed when a blacksmith successfully repairs an item | \ No newline at end of file