EpicKnarvik97/Blacksmith
EpicKnarvik97/Blacksmith
1
0
Fork 0
Code Issues Pull Requests Projects Releases 8 Wiki Activity
dev
Blacksmith/README.md

312 lines
45 KiB
Markdown
Raw Permalink Normal View History

Adds proper information in the README
2022-10-03 00:11:02 +02:00
# Blacksmith
add a template readme
2017-08-29 20:46:09 +02:00
Updates README header
2024-05-07 14:57:24 +02:00
The blacksmith plugin adds a blacksmith trait and a scrapper to Citizens NPCs. Blacksmith NPCs are able to repair a
player's held item for a fee. Costs are highly customizable. Scrapper NPCs can break down items into their crafting
recipe.
add a template readme
2017-08-29 20:46:09 +02:00
Adds proper information in the README
2022-10-03 00:11:02 +02:00
### Important changes from the original fork
minimal update to 1.13
2018-10-12 21:00:54 +02:00
Adds proper information in the README
2022-10-03 00:11:02 +02:00
- The problem with armor being unrepairable because the player would equip it instead has been fixed.
- A lot of configuration value have had their paths altered, so configurations need to be updated.
- By default, natural cost is used. The original fork made it cheaper the more damaged an item is, but natural cost
makes the cost increase the more damaged the item is.
- EnchantmentTarget is used instead of a hard-coded list of repairable items
Adds missing scrapper notice
2024-05-07 15:24:09 +02:00
- All settings, both global and for each blacksmith / scrapper, can be changed using commands,
Adds proper information in the README
2022-10-03 00:11:02 +02:00
and support tab-completion.
Improves un-setting of NPC values #10
2022-10-18 11:41:25 +02:00
- This plugin is not directly compatible with the original. If you are using the old one, you will need to set it up
again!
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Changes some configuration keys
2023-11-20 13:20:11 +01:00
### Required dependencies
Adds proper information in the README
2022-10-03 00:11:02 +02:00
- Citizens2
- Vault
Adds Economy plugin to dependencies to prevent confusion
2022-10-26 20:33:44 +02:00
- Any Vault-supported Economy plugin
Adds proper information in the README
2022-10-03 00:11:02 +02:00
## Basic usage
Improves setup information
2023-01-06 00:03:33 +01:00
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).
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
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).
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
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.
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Updates README to mirror recent behavioral changes
2022-10-12 13:37:25 +02:00
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
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
`/blacksmith` or `/scrapper` command when possible.
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Adds missing info about non-standard functionality
2024-05-07 03:27:36 +02:00
### Non-standard functionality
There is some non-standard optional functionality for blacksmiths and scrappers that goes beyond repairing things with
durability. They can all be enabled or disabled using configuration values.
- Blacksmiths can repair anvils if the option `reforgeAnvils` is enabled
- Scrappers can remove armor trim from items if `salvageArmorTrims` is enabled. This will always be done before
salvaging the item itself. If not enabled, the item is considered un-salvageable.
- Scrappers can remove netherite from items if `salvageNetherite` is enabled. This will be done if no armor trim exists,
before normal salvage. If not enabled, the item is considered un-salvageable.
- Scrappers can salvage enchanted items, and return some XP based on the enchantment set if `salvageEnchanted` is
enabled. If not enabled, the item is considered un-salvageable.
- Scrappers can salvage just about anything with a crafting table recipe if `extendedSalvageEnabled` is enabled. As long
as you have the amount of items produced by a crafting recipe, you can undo the recipe. Four planks can be salvaged
into a log as an example.
Adds proper information in the README
2022-10-03 00:11:02 +02:00
### Special behavior
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
In addition to just being able to repair items, blacksmiths / scrappers have some random features which can be cool or
annoying:
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
- 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
Adds proper information in the README
2022-10-03 00:11:02 +02:00
failReforgeChance to control the chance. Set it to 0 to remove the feature.
Implements a mix of #3 and #7 Adds a preset command which can be used to see available presets Adds preset filters which can be used to specify item sub-categories within a preset Removes SWORD_SMITH and RANGED_SMITH, as those are replaced by the RANGED and SWORD filters Adds a list of usable filters for each preset
2022-10-13 18:40:38 +02:00
- There is a chance a blacksmith may add an enchantment to a reforged item. You can control the probability using
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
extraEnchantmentChance, and set the maximum number of enchantments using maxEnchantments. EnchantmentBlockList can be
Improves some README descriptions
2023-01-11 14:29:59 +01:00
used to block any enchantments you don't want to randomly grant.
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
### 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
Changes ignored salvage into trash salvage according to #22
2024-05-05 18:02:12 +02:00
valuable items, `trashSalvage` can be configured. Trash salvage will only be returned if all non-trash items are
returned as well. 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.
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
When an item is salvaged, EXP will be returned based on enchantments on the item.
Adds a note about sticks being an NPC selector
2024-08-07 13:24:06 +02:00
Note that sticks are valid items to be handled by Scrappers if extended salvage is enabled. The item is also the default
item for selecting NPCs in Citizens. If you find the NPC selection message annoying, and don't normally use sticks for
selection, you can change the item in Citizens' config and replace it with STRUCTURE_VOID or some other unobtainable
item.
Adds proper information in the README
2022-10-03 00:11:02 +02:00
## Commands
Fixes some minor issues Fixes some repositories using http instead of https Fixes formatting for tables
2022-11-14 02:44:18 +01:00
| Command | Arguments | Description |
|-------------------|-------------------------------|----------------------------------------------------------------------------------------------|
| /blacksmith | \<option> \[new-value] | Changes a configuration option for the selected blacksmith (use Citizens' /npc select first) |
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
| /blacksmithConfig | \<reload/option> \[new-value] | Changes a default/global blacksmith configuration value |
Adds comments to every option in strings.yml
2023-11-16 22:51:20 +01:00
| /scrapper | \<option> \[new-value] | Changes a configuration option for the selected scrapper (use Citizens' /npc select first) |
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
| /scrapperConfig | \<reload/option> \[new-value] | Changes a default/global scrapper configuration value |
Fixes some minor issues Fixes some repositories using http instead of https Fixes formatting for tables
2022-11-14 02:44:18 +01:00
| /preset | \<preset>\[:filter] | Displays all materials included in the given preset, after applying the filter if set |
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
For /blacksmith, /blacksmithConfig, /scrapper and /scrapperConfig, if a new value isn't specified, a description of the
Adds comments to every option in strings.yml
2023-11-16 22:51:20 +01:00
configuration option, and the current value, is displayed instead.
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Adds comments to every option in strings.yml
2023-11-16 22:51:20 +01:00
For /blacksmith or /scrapper, using -1 or null as the value will clear a custom value, making the NPC use the default
value set in the config instead. Additionally, every value overridden for an NPC will display a marker (default: \[NPC])
when displaying the current value.
Improves un-setting of NPC values #10
2022-10-18 11:41:25 +02:00
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Note: basePrice, pricePerDurabilityPoint and enchantmentCost can be set like: `/blacksmithconfig option 4` or
like `/blacksmithconfig option material/enchantment 4` depending on whether you are setting the default or an override
Improves description of unsetting per-material/enchantment costs
2022-10-25 18:46:12 +02:00
for a specific material/enchantment. For /blacksmithconfig <basePrice/pricePerDurabilityPoint/enchantmentCost> <
material/enchantment>, using -1 or null as the value will clear the cost for the specified material/enchantment, using
the default one instead.
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Implements material wildcards for costs #14
2023-01-09 16:53:52 +01:00
basePrice and pricePerDurabilityPoint support using a wildcard "*" to set the price for multiple groups of materials at
once. `/blacksmithconfig basePrice golden* 43` would set the price of any material starting with "GOLDEN" to 43. You can
also set `netherite*: 34` directly in the config file to set the price of all netherite materials to 34.
Implements a mix of #3 and #7 Adds a preset command which can be used to see available presets Adds preset filters which can be used to specify item sub-categories within a preset Removes SWORD_SMITH and RANGED_SMITH, as those are replaced by the RANGED and SWORD filters Adds a list of usable filters for each preset
2022-10-13 18:40:38 +02:00
### Presets and filters:
Updates some incorrect README information
2024-05-06 12:17:22 +02:00
**Presets are a nice way to make specialized blacksmiths / scrappers by specifying categories of materials, instead of
manually listing every material manually. They can only be used for the `reforgeAbleItems` and `salvageAbleItems`
options.**
Adds negation for material names and presets #13
2023-01-09 05:03:28 +01:00
Updates some incorrect README information
2024-05-06 12:17:22 +02:00
Note: All of these can be used when specifying reforge-able and salvage-able items, such as
Fixes README formatting creating an unintended space
2022-10-26 20:08:34 +02:00
"preset:weapon-smith:bow,preset:armor_smith:gold,PRESET:TOOL_SMITH,shield"
Implements a mix of #3 and #7 Adds a preset command which can be used to see available presets Adds preset filters which can be used to specify item sub-categories within a preset Removes SWORD_SMITH and RANGED_SMITH, as those are replaced by the RANGED and SWORD filters Adds a list of usable filters for each preset
2022-10-13 18:40:38 +02:00
Improves description of the reforge-able items format
2022-10-26 20:20:35 +02:00
The format of reforge-able items requires each preset/material to be separated by a comma. If specifying a preset
Improves some README descriptions
2023-01-11 14:29:59 +01:00
instead of a material, start by typing "preset:". Then you can type BLACKSMITH, WEAPON_SMITH, ARMOR_SMITH or TOOL_SMITH.
If you want, you can add another colon and one of the filters supported by the preset.
For example: "preset:WEAPON_SMITH:BOW" to make the blacksmith only repair bows and crossbows. You can use the same
preset several times with different filters. For example: "preset:ARMOR_SMITH:DIAMOND,preset:ARMOR_SMITH:NETHERITE"
would allow the blacksmith to repair all diamond and netherite armor.
Improves description of the reforge-able items format
2022-10-26 20:20:35 +02:00
Adds negation for material names and presets #13
2023-01-09 05:03:28 +01:00
Presets and filters can also be negated by applying a "-" character in front of the material name. For example,
Improves some README descriptions
2023-01-11 14:29:59 +01:00
"-SHIELD" would make shields unrepairable, even if included in a listed preset. "preset:WEAPON_SMITH,-SHIELD"
Adds negation for material names and presets #13
2023-01-09 05:03:28 +01:00
would allow the blacksmith to repair any weapon included in the WEAPON_SMITH preset except shields.
Improves some README descriptions
2023-01-11 14:29:59 +01:00
"preset:BLACKSMITH,-ELYTRA"would allow the blacksmith to repair any repairable item, except elytra. You can also negate
entire presets or filters. For example: "preset:blacksmith,-preset:armor-smith:diamond" would allow a blacksmith to
repair all items, except diamond armor.
Adds negation for material names and presets #13
2023-01-09 05:03:28 +01:00
Implements a mix of #3 and #7 Adds a preset command which can be used to see available presets Adds preset filters which can be used to specify item sub-categories within a preset Removes SWORD_SMITH and RANGED_SMITH, as those are replaced by the RANGED and SWORD filters Adds a list of usable filters for each preset
2022-10-13 18:40:38 +02:00
All currently supported presets, and available filters for each preset:
Adds negation for material names and presets #13
2023-01-09 05:03:28 +01:00
- BLACKSMITH (WEAPON_SMITH + ARMOR_SMITH + TOOL_SMITH)
Adds missing comments for BLACKSMITH filters
2024-05-07 17:01:20 +02:00
- GOLD (all gold armor, tools and weapons)
- IRON (all iron armor, tools and weapons)
- DIAMOND (all diamond armor, tools and weapons)
- NETHERITE (all netherite armor, tools and weapons)
Adds negation for material names and presets #13
2023-01-09 05:03:28 +01:00
- WEAPON_SMITH: (RANGED + SWORD + SHIELD)
- BOW (bows and crossbows)
- SWORD (swords)
- RANGED (bows, crossbows and tridents)
- ARMOR_SMITH: (HELMET + BOOTS + LEGGINGS + CHESTPLATE + ELYTRA)
- LEATHER (all pieces of leather armor)
- IRON (all pieces of iron armor)
- CHAINMAIL (all pieces of chainmail armor)
- GOLD (all pieces of gold armor)
- DIAMOND (all pieces of diamond armor)
- NETHERITE (all pieces of netherite armor)
- HELMET (all helmets)
- BOOTS (all boots)
- LEGGINGS (all leggings)
- CHESTPLATE (all chest-plates)
- TOOL_SMITH: (PICKAXE + AXE + HOE + SHOVEL + MISC)
- WOOD (all wood tools)
- STONE (all stone tools)
- IRON (all iron tools)
- GOLD (all gold tools)
- DIAMOND (all diamond tools)
- NETHERITE (all netherite tools)
- PICKAXE (all pickaxes)
- AXE (all axes)
- HOE (all hoes)
- SHOVEL (all shovels)
- MISC (FISHING_ROD + SHEARS + FLINT_AND_STEEL)
Implements a mix of #3 and #7 Adds a preset command which can be used to see available presets Adds preset filters which can be used to specify item sub-categories within a preset Removes SWORD_SMITH and RANGED_SMITH, as those are replaced by the RANGED and SWORD filters Adds a list of usable filters for each preset
2022-10-13 18:40:38 +02:00
Adds proper information in the README
2022-10-03 00:11:02 +02:00
## Permissions
Implements armor trim salvage #24
2024-05-06 14:48:48 +02:00
| Permission node | Description |
|------------------|----------------------------------------------------------------------------------------|
| blacksmith.admin | Allows overall blacksmith and scrapper configuration. |
| blacksmith.edit | Allows changing settings for the selected blacksmith or scrapper NPC. |
| blacksmith.use | Allows the player to repair items using blacksmiths and salvage items using scrappers. |
Adds proper information in the README
2022-10-03 00:11:02 +02:00
## Configuration options
Implements language selection properly Adds a configuration option for the plugin language Loads the selected language instead of always loading "en" Makes sure the language is updated upon reloading
2022-10-21 00:46:01 +02:00
### Plugin Options
Fixes some minor issues Fixes some repositories using http instead of https Fixes formatting for tables
2022-11-14 02:44:18 +01:00
| Key | Value type | Description |
|----------|------------|----------------------------------------------------------------------------------------------|
| language | string | The language used for this plugin. Only "en" is supported, unless you add a custom language. |
Implements language selection properly Adds a configuration option for the plugin language Loads the selected language instead of always loading "en" Makes sure the language is updated upon reloading
2022-10-21 00:46:01 +02:00
Changes some configuration keys
2023-11-20 13:20:11 +01:00
### Blacksmith global-only options
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Fixes some savage fail problems Fixes item not being returned when salvage fails Removes some redundancy when giving back items Makes extended salvage return 50% of the salvage (no items if only one item would be returned) Adds a better message when failing to salvage extended salvage items Fixes a bug in the caching of smith presets
2024-05-07 01:45:48 +02:00
| Key | Value type | Default | Description |
|---------------------------|-------------------------|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| basePrice | positive decimal number | default: 10.0 | 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. You can use for example "netherite*: 10" to set the value for any material beginning with "netherite". |
| pricePerDurabilityPoint | positive decimal number | default: 0.005 | 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. You can use for example "netherite*: 10" to set the value for any material beginning with "netherite". |
| enchantmentCost | positive decimal number | default: 5 | 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 | true | 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). |
| showExactTime | true/false | false | If true, blacksmiths will display exact time remaining in minutes and seconds, instead of vague expressions. |
| chippedAnvilReforgingCost | positive decimal number | 10.0 | The price for reforging a chipped anvil (slightly damaged). No other costs apply! |
| damagedAnvilReforgingCost | positive decimal number | 20.0 | The price for reforging a damaged anvil (very damaged). No other costs apply! |
Improves README by using tables
2022-10-12 13:31:35 +02:00
Changes some configuration keys
2023-11-20 13:20:11 +01:00
### Blacksmith per-npc (with default values set in config.yml)
Adds proper information in the README
2022-10-03 00:11:02 +02:00
#### Configuration values
Adds default configuration values README.md
2024-05-06 00:11:35 +02:00
| Key | Value type | Default | Description |
|--------------------------------|-----------------------------------------|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| dropItem | true/false | true | Whether the blacksmith should drop the repaired item on the ground (instead of putting it into the player's inventory). |
| failReforgeChance | 0-100 | 10 | The chance of the blacksmith failing to repair an item (further damaging it, or just repairing it a bit), and either removing or downgrading all enchantments (if failReforgeRemovesEnchantments is true). |
| failReforgeRemovesEnchantments | true/false | false | Whether a failed reforge should remove or downgrade all enchantments on the item. |
| extraEnchantmentChance | 0-100 | 5 | The chance of the blacksmith adding an enchantment to an item. |
| maxEnchantments | 0-10 | 3 | The maximum number of different enchantments a blacksmith can add. |
| maxReforgeWaitTimeSeconds | 0-3600 | 30 | The maximum number of seconds a player needs to wait for an item to be repaired. |
| minReforgeWaitTimeSeconds | 0-3600 | 5 | The minimum number of seconds a player needs to wait for an item to be repaired. |
| reforgeCoolDownSeconds | 0-3600 | 60 | 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". |
| blacksmithTitle | text string | blacksmith | The title displayed as part of the message explaining that a blacksmith doesn't recognize a player's held item |
| enchantmentBlockList | string list | binding_curse,mending,vanishing_curse | A string list of all enchantments a blacksmith should not be allowed to add to items. |
| reforgeAnvils | true/false | false | Whether to allow the blacksmith to reforge anvils. If enabled, chipped and damaged anvils will be replaced with a normal anvil. |
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
#### Messages
Adds proper information in the README
2022-10-03 00:11:02 +02:00
Implements armor trim salvage #24
2024-05-06 14:48:48 +02:00
| Message Key | Default | Explanation |
|--------------------------|-------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------|
| busyPlayerMessage | &cI'm busy at the moment. Come back later! | The message displayed when the blacksmith is serving another player. |
| busyReforgeMessage | &cI'm working on it. Be patient! I'll finish {time}! | The message displayed when the blacksmith is busy reforging an item. |
| coolDownUnexpiredMessage | &cYou've already had your chance! Give me a break! I'll be ready {time}! | The message displayed when the player has to wait for the cool-down to expire before using the blacksmith again. |
| costMessage | &eIt will cost &a{cost}&e to reforge that &a{item}&e! Click again to reforge! | The message displayed when telling a player about the cost of repairing an item. |
| failReforgeMessage | &cWhoops! Didn't mean to do that! Maybe next time? | The message displayed when a blacksmith fails to reforge an item. |
| insufficientFundsMessage | &cYou don't have enough money to reforge that item! | The message displayed when a player is unable to pay for reforging an item. |
| invalidItemMessage | &cI'm sorry, but I'm a/an {title}, I don't know how to reforge that! | The message displayed when a blacksmith is presented an item which it cannot repair. |
| itemChangedMessage | &cThat's not the item you wanted to reforge before! | The message displayed when a player changes their item after being shown the repair cost. |
| startReforgeMessage | &eOk, let's see what I can do... | The message displayed when a blacksmith starts reforging an item. |
| successMessage | There you go! All better! | The message displayed when a blacksmith successfully repairs an item. |
| notDamagedMessage | &cThat item is not in need of repair | The message displayed if a player tries to reforge an item with full durability. |
Adds a separate message for clicking an NPC with an empty hand
2024-08-03 13:09:09 +02:00
| noItemMessage | Please present the item you want to reforge | The message displayed when a blacksmith is clicked with an empty hand |
Adds license files and language customization info
2022-10-18 12:19:29 +02:00
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
### Scrapper global-only options
Implements netherite salvaging #24
2024-05-06 21:26:21 +02:00
| Key | Value type | Default | Description |
|-----------------------|------------------------------------------------------------|---------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| salvagePrice | positive decimal number | 0 | The cost of using a scrapper to salvage an item. |
| armorTrimSalvagePrice | positive decimal number | 5 | The cost of using a scrapper to remove armor trim from an item. |
| netheriteSalvagePrice | positive decimal number | 15 | The cost of using a scrapper to remove netherite from an item. |
| showExactTime | true/false | false | If true, scrappers will display exact time remaining in minutes and seconds, instead of vague expressions. |
| giveExperience | true/false | true | If true, each enchantment level on the salvaged item will give one EXP level as salvage. |
| trashSalvage | TARGET_MATERIAL:IGNORED_MATERIAL\[,\*_TARGET2:\*_IGNORED2] | `"*_SHOVEL;*_PICKAXE;*_AXE;*_HOE;*_SWORD;SHIELD;*_BOW:STICK"` | The items that should be deferred when calculating partial salvage. Because receiving just the sticks when salvaging a diamond pickaxe is kind of sad, this allows specifying for example: `*_SHOVEL;*_PICKAXE;*_AXE;*_HOE;*_SWORD;SHIELD;*_BOW:STICK` (the default) for deferring sticks in salvage for shovels, pickaxes, axes, hoes and swords. A `:` character splits selected items and the trash salvage. Different item specifications are split by a `;` character. Use `,` to split separate trash salvages when using commands, like: `SHIELD:STICK,BOW_STRING`. |
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
### Scrapper per-npc (with default values set in config.yml)
#### Configuration values
Adds default configuration values README.md
2024-05-06 00:11:35 +02:00
| Key | Value type | Default | Description |
|---------------------------|-----------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| dropItem | true/false | true | Whether the scrapper should drop the repaired item on the ground (instead of putting it into the player's inventory). |
| failSalvageChance | 0-100 | 0 | The chance of the scrapper failing to salvage an item, either further damaging the item, partly repairing the item or causing some items to disappear. |
| salvageAbleItems | DIAMOND_LEGGINGS,GOLD-pickaxe,bow, etc. | [] | Specifies which items this scrapper is able to salvage. If set to "" or null, all normally repairable items can be salvaged. If set to a list of items, only the items specified can be salvaged. 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". |
| maxSalvageWaitTimeSeconds | 0-3600 | 5 | The maximum number of seconds a player needs to wait for an item to be salvaged. |
| minSalvageWaitTimeSeconds | 0-3600 | 30 | The minimum number of seconds a player needs to wait for an item to be salvaged. |
| salvageCoolDownSeconds | 0-3600 | 60 | The cool-down, in seconds, a player has to wait between each time they use one specific scrapper. |
Implements armor trim salvage #24
2024-05-06 14:48:48 +02:00
| scrapperTitle | text string | scrapper | The title displayed as part of the message explaining that a scrapper doesn't recognize a player's held item. |
Adds default configuration values README.md
2024-05-06 00:11:35 +02:00
| extendedSalvageEnabled | true/false | false | Whether to enable the extended salvage behavior for this scrapper. As long as it is allowed by salvageAbleItems and it can be crafted in a crafting table, it can be salvaged. This includes things like four planks salvaged into wood. |
| salvageEnchanted | true/false | false | Whether the scrapper is able to salvage enchanted items. This is disabled by default as it's very easy to accidentally salvage heavily enchanted items if one is not careful. |
Implements netherite salvaging #24
2024-05-06 21:26:21 +02:00
| salvageArmorTrims | true/false | true | Whether the scrapper is able to salvage armor trims from items. |
| salvageNetherite | true/false | true | Whether the scrapper is able to salvage netherite items into diamond items. |
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
#### Messages
Fixes some savage fail problems Fixes item not being returned when salvage fails Removes some redundancy when giving back items Makes extended salvage return 50% of the salvage (no items if only one item would be returned) Adds a better message when failing to salvage extended salvage items Fixes a bug in the caching of smith presets
2024-05-07 01:45:48 +02:00
| Message Key | Default | Explanation |
|---------------------------------|-----------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| busyPlayerMessage | &cI'm busy at the moment. Come back later! | The message displayed when the scrapper is serving another player. |
| busySalvageMessage | &cI'm working on it. Be patient! I'll finish {time}! | The message displayed when the scrapper is busy salvaging an item. |
| coolDownUnexpiredMessage | &cYou've already had your chance! Give me a break! I'll be ready {time}! | The message displayed when the player has to wait for the cool-down to expire before using the scrapper again. |
| invalidItemMessage | &cI'm sorry, but I'm a/an {title}, I don't know how to salvage that! | The message displayed when a scrapper is presented an item which it cannot salvage. |
| tooDamagedForSalvageMessage | &cThat item is too damaged to be salvaged into anything useful | The message displayed when a scrapper is presented with an item too damaged to produce salvage. |
| successSalvagedMessage | There you go! | The message displayed when a scrapper successfully repairs an item. |
| failSalvageMessage | &cWhoops! The item broke! Maybe next time? | The message displayed when a scrapper fails to salvage an item. |
| failExtendedSalvageMessage | &cWhoops! I was unable to extract much, if any, salvage! Maybe next time? | The message displayed when a scrapper fails to salvage an item without durability (only relevant is extended salvage is enabled). |
| itemChangedMessage | &cThat's not the item you wanted to salvage before! | The message displayed when a player changes their item after being shown the salvage cost. |
| startSalvageMessage | &eOk, let's see what I can do... | The message displayed when a scrapper starts salvaging an item. |
| insufficientFundsMessage | &cYou don't have enough money to salvage an item! | The message displayed when a player is unable to pay for salvaging an item. |
| costMessage | &eIt will cost &a{cost}&e to salvage that &a{item}&e! {yield} &eClick again to salvage! | The message displayed when telling a player about the cost of salvaging an item. |
| costMessageArmorTrim | &eIt will cost &a{cost}&e to salvage that &a{item}&e's armor trim! | The message displayed when telling a player about the cost of salvaging an item's armor trim. |
| costMessageNetherite | &eIt will cost &a{cost}&e to salvage that &a{item}&e into diamond! | The message displayed when telling a player about the cost of salvaging a netherite item into a diamond item. |
| fullSalvageMessage | &aI should be able to extract all components from that pristine item.&r | The message displayed as part of costMessage's yield placeholder if all components will be returned. |
| partialSalvageMessage | &cI cannot extract all components from that damaged item.&r | The message displayed as part of costMessage's yield placeholder if only some components will be returned. |
| cannotSalvageEnchantedMessage | &cI'm sorry, but I'm unable to salvage enchanted items! | The message displayed when telling a player that the scrapper cannot salvage enchanted items. |
| cannotSalvageArmorTrimMessage | &cI'm sorry, but I'm unable to salvage armor trims! | The message displayed when telling a player that the scrapper cannot salvage items with armor trim. |
| armorTrimSalvageNotFoundMessage | &cI'm sorry, but I don't know how to salvage that armor trim! | The message displayed when telling a player that the scrapper cannot find the correct items to return as armor trim salvage. This will happen if more armor trim materials are added, or the Spigot API is changed. |
| cannotSalvageNetheriteMessage | &cI'm sorry, but I'm unable to salvage netherite items! | The message displayed when telling a player that the scrapper cannot salvage netherite items. |
Adds a separate message for clicking an NPC with an empty hand
2024-08-03 13:09:09 +02:00
| noItemMessage | Please present the item you want to salvage | The message displayed when a scrapper is clicked with an empty hand |
Finishes the scrapper implementation
2024-05-04 01:01:56 +02:00
Adds license files and language customization info
2022-10-18 12:19:29 +02:00
## Language customization
All strings, even time units, are customizable. If you place a strings.yml file in the plugin folder, it will take
priority over built-in languages. If you want to change strings, look at Blacksmith/src/main/resources/strings.yml for
the proper keys. All strings have the format: ENUM: "Displayed string". The enum must be identical as it defines which
string you have changed. All strings belonging to a language are beneath the language code and indented with two spaces.
The easiest way to add a new language is to copy an existing language and paste it into your custom strings.yml and
change strings as necessary. If you don't include all strings, the remaining will use the built-in English translation.
Remember to change the language code to whichever you use for your custom language.
The interval messages are unique in that if several values are separated by comma (option1,option2,option3), a random
message will be chosen each time it's displayed.
## License
Blacksmith is licensed under the GNU Public License Version 3.0. This includes every source and resource file. See the
HEADER file for a more detailed license description.
Reference in New Issue Copy Permalink