|
|
|
Item upgrades are a way of adding some progression to your items. When successfully upgrading an item, its item statistics are increased which essentially makes the item better. Players can upgrade their items either using the right consumable, or by using a station **upgrading recipe**.\
|
|
|
|
When upgraded, items gain one level. The level is displayed next to the item display name. The display name suffix can be changed in the main plugin config file (_item-upgrading.name-suffix_).\
|
|
|
|
\
|
|
|
|
There are 3 things to setup in order to have a working item upgrading system: first of all, you need to setup the upgrading template, which dictates what stats are increased (+ by how much) when successfully upgrading an item. Then you need to some extra upgrading options for the item you want to upgrade. The last step is to setup either an upgrading consumable or an upgrading recipe.
|
|
|
|
There are 3 things to setup in order to have a working item upgrading system: first of all, you need to setup the upgrading template, which dictates what stats are increased (+ by how much) when successfully upgrading an item. Then you need to some extra upgrading options for the item you want to upgrade. The last step is to setup either an upgrading consumable or an [[upgrading recipe|Upgrading-Recipes]].
|
|
|
|
|
|
|
|
|
|
|
|
## Setting up the upgrading template
|
| ... | ... | @@ -46,9 +46,17 @@ Let's have a look at another example. Let's say we have a **sword with 10 Attack |
|
|
|
_Currently, item upgrading only applies for numeric stats like crit chance, attack damage, armor, PvE damage, etc._
|
|
|
|
|
|
|
|
## Setting up the upgrading options for the consumable
|
|
|
|
Players may use a consumable in order to upgrade an item. If so, you need to specify two options: the upgrading reference, which we will get back to later, and the upgrading chance. You can configurate both of these options in the edition menu.
|
|
|
|
Players may use a consumable in order to upgrade an item. If so, you need to specify two options: the **upgrading reference**, which we will get back to later, and the **upgrade chance**. You can configurate both of these options in the edition menu.
|
|
|
|
|
|
|
|
## Setting up the upgrading options for the weapon/armor/...
|
|
|
|
Any item, including armors, weapons, etc. can be upgraded, however you need a few options set up in order to upgrade an item. Just like consumables, weapons/armors also have an upgrading chance. The upgrading chances of the weapon and the consumable stack, i.e `total-upgrade-chance = <item-upgrade-chance> * <consumable-upgrade-chance>`. If both items have a 40% upgrade chance, the total upgrade chance is `40% * 40% = 16%`.
|
|
|
|
Any item, including armors, weapons, etc. can be upgraded, however you need a few options set up in order to upgrade an item. Just like consumables, weapons/armors also have an upgrading chance. The upgrading chances of the weapon and the consumable stack, i.e `total-upgrade-chance = <item-upgrade-chance> * <consumable-upgrade-chance>`. If both items have a 40% upgrade chance, the total upgrade chance is `40% * 40% = 16%`. When the item does not have 100% chance to be upgraded, you can enable an extra option which makes the **item break when failing to upgrade it.**
|
|
|
|
|
|
|
|
An item may also have a **maximum amount of upgrades**, meaning that once the item reaches a specific level, it cannot be upgraded anymore. This is an important option if you don't want specific items to get too OP with upgrades. |
|
|
\ No newline at end of file |
|
|
|
An item may also have a **maximum amount of upgrades**, meaning that once the item reaches a specific level, it cannot be upgraded anymore. This is an important option if you don't want specific items to get too OP with upgrades. An item can also be upgradable only via crafting stations and upgrading recipes.
|
|
|
|
|
|
|
|
Don't forget to bind an upgrading template to your item using the corresponding option in the edition GUI! Options described previously can also be setup using the item edition GUI.
|
|
|
|
|
|
|
|
## Upgrade reference
|
|
|
|
This option can be used for both upgrading consumables and upgradable items. The upgrade reference dictates whether or not a specific consumable can upgrade an item.\
|
|
|
|
There is one rule and two exceptions: a consumable may **only** upgrade an item if its upgrade reference matches the reference of the upgraded item. If a consumable has no upgrade reference specified, it can upgrade any item. If an item has no upgrade reference, it can be upgraded by any consumables, _unless you have the workbench-only option toggled on._
|
|
|
|
|
|
|
|
The upgrade reference is a piece of text which is not displayed in the item lore. It is only used internally to check if the two references match, therefore it could be anything, just make sure they match (just like the gem socket colors). |
|
|
\ No newline at end of file |
