EpicKnarvik97/Blacksmith
EpicKnarvik97/Blacksmith
1
0
Fork 0
Code Issues Pull Requests Projects Releases 8 Wiki Activity

Improves README by using tables

Browse Source
This commit is contained in:
Kristian Knarvik 2022-10-12 13:31:35 +02:00
parent 907389f978
commit b3128c0525
1 changed files with 36 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

77
README.md
View File

@ -54,56 +54,51 @@ for a specific material/enchantment.
## Permissions ## Permissions
- blacksmith.admin - Allows overall blacksmith configuration | Permission node | Description |
- blacksmith.edit - Allows changing settings for the selected blacksmith NPC | --- | --- |
- blacksmith.use - Allows the player to repair items using blacksmiths | 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 ## Configuration options
### Global-only options ### Global-only options
- basePrice (positive decimal number) - The base price which has to be paid regardless of the durability remaining for | Key | Value type | Description |
an item. Setting this without specifying a material sets the basePrice for any item the basePrice has not been set | --- | --- | --- |
for. | 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 | 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. |
on natural cost's value). Setting this without specifying a material sets the pricePerDurabilityPoint for any item the | 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.
pricePerDurabilityPoint has not been set for. | 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). |
- 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 #### Configuration values
- dropItem (true/false) - Whether the blacksmith should drop the repaired item on the ground (instead of putting it into | Key | Value type | Description |
the player's inventory) | --- | --- | --- |
- disableCoolDown (true/false) - Whether to completely disable the cool-down between repairs | dropItem | true/false | Whether the blacksmith should drop the repaired item on the ground (instead of putting it into the player's inventory). |
- disableDelay (true/false) - Whether to completely disable the delay required to reforge an item | disableCoolDown | true/false | Whether to completely disable the cool-down between repairs. |
- failReforgeChance (0-100) - The chance of the blacksmith failing to repair an item | disableDelay | true/false | Whether to completely disable the delay required to reforge an item. |
- extraEnchantmentChance (0-100) - The chance of the blacksmith adding an enchantment to an item | failReforgeChance | 0-100 | The chance of the blacksmith failing to repair an item. |
- maxEnchantments (0-10) - The maximum number of different enchantments a blacksmith can add | extraEnchantmentChance | 0-100 | The chance of the blacksmith adding an enchantment to an item. |
- maxReforgeDelay (0-3600) - The maximum number of seconds a player needs to wait for an item to be repaired | maxEnchantments | 0-10 | The maximum number of different enchantments a blacksmith can add. |
- minReforgeDelay (0-3600) - The minimum number of seconds a player needs to wait for an item to be repaired | maxReforgeDelay | 0-3600 | The maximum 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 | minReforgeDelay | 0-3600 | The minimum number of seconds a player needs to wait for an item to be repaired. |
- reforgeAbleItems (DIAMOND_LEGGINGS,GOLD-pickaxe,bow, etc.) - Specifies which items this blacksmith is able to reforge. | reforgeCoolDown | 0-3600 | The cool-down, in seconds, a player has to wait between each time they use one specific blacksmith. |
If set to "" or null, all items can be repaired. If set to a list of items, only the items specified can be repaired. | 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. |
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 #### Messages
- busyPlayerMessage - The message displayed when the blacksmith is serving another player | Message Key | Explanation |
- 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 | busyPlayerMessage | The message displayed when the blacksmith is serving another player |
the blacksmith again | busyReforgeMessage | The message displayed when the blacksmith is busy reforging an item |
- costMessage - The message displayed when telling a player about the cost of repairing an item | coolDownUnexpiredMessage | The message displayed when the player has to wait for the cool-down to expire before using the blacksmith again |
- failReforgeMessage - The message displayed when a blacksmith fails to reforge an item | costMessage | The message displayed when telling a player about the cost of repairing an item |
- insufficientFundsMessage - The message displayed when a player is unable to pay for reforging an item | failReforgeMessage | The message displayed when a blacksmith fails to reforge an item |
- invalidItemMessage - The message displayed when a blacksmith is presented an item which it cannot repair | insufficientFundsMessage | The message displayed when a player is unable to pay for reforging an item |
- itemChangedMessage - The message displayed when a player changes their item after being shown the repair cost | invalidItemMessage | The message displayed when a blacksmith is presented an item which it cannot repair |
- startReforgeMessage - The message displayed when a blacksmith starts reforging an item | itemChangedMessage | The message displayed when a player changes their item after being shown the repair cost |
- successMessage - The message displayed when a blacksmith successfully repairs an item | startReforgeMessage | The message displayed when a blacksmith starts reforging an item |
| successMessage | The message displayed when a blacksmith successfully repairs an item |