Item-Stats-and-Options.md

-The edition menu (_/mi edit_) lets you know what stats you can add to an item and how to configure it. While most are self explanatory, here are some specifications about some of them. This list thus does not contain every item stat or option you can find in MMOItems... However make sure you read the rest of the wiki, which may contains the information you are looking for! Item examples will help you configuring them manually if you feel like you don't need the edition menu. Lastly, things may change a bit depending on your server version (1.13 - Legacy)
+The edition menu (_/mi edit_) lets you know what stats you can add to an item and how to configure it. While most are self explanatory, here are some specifications about more complex item options. This list thus does not contain every item stat or option you can find in MMOItems... However make sure you read the rest of the wiki, which may contains the information you are looking for! Item examples will help you configuring manually if you don't really feel like using the edition menu. Keep in mind some fields like material/enchant/sound names may change a little depending on your server version (1.13 - 1.14+).
 
 **Tip:** use CTRL+F to find the desired item stat.
 
@@ -25,6 +25,20 @@ TEST_ITEM:
         dye-color: 100 100 100
 ```
 
+## Enchantments
+An enchantment is defined by an enchant type and a level. Use this format:
+```
+enchants:
+    efficiency:
+        base: 1
+        # There is no Efficiency 1.3, but that means that every
+        # 10 levels, the item will have an extra efficiency
+        # enchant level! This trick can also be used with potion effect levels.
+        scale: .1
+    # That format still works because an enchant level is a numeric value
+    sharpness: 10
+```
+
 ## Item Permissions
 A list of permissions any player must have in order to use this item.
 You may use the corresponding bypass permission to bypass that item restriction.
@@ -88,27 +102,17 @@ TEST_ITEM:
             saturation: 16
 ```
 
-## Potion Effects (Consumables)
-The potion effects a consumable item grants when consumed.
-All potion effect names can be found in the [Spigot javadocs](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/potion/PotionEffectType.html). Duration is input in seconds.
+## Permanent Potion Effects
+It's literally the same as with consumable potion effects (see above), but since these potion effects are supposed to be permanently given to the player when a specific item is held, you **do not have to specify the effect duration**. The `level` config section is also gone because it's cleaner without it.
 ```
-TEST_ITEM:
-    base:
-        material: BREAD
-        effects:
-            increased_damage:
-                level: 1
-                duration: 10
-```
-## Permanent Effects
-The potion effects your item grant to the holder. Format: [POTION_EFFECT]: [AMPLIFIER]
-```
-TEST_ITEM:
-    base:
-        material: IRON_SWORD
-        perm-effects:
-            increased_damage: 1
+perm-effect:
+    speed:
+        base: 1
+        scale: 1
+    # That format works too
+    haste: 3
 ```
+
 ## Item Cooldown
 The delay players must wait before EITHER using a consumable, or running all the commands from an item. In MMOItems Legacy, commands can all have different cooldowns and consumable have an option called `Consume Cooldown` which is similar to `Item Cooldown`.
 
@@ -116,6 +120,19 @@ The delay players must wait before EITHER using a consumable, or running all the
 **Autosmelt:** When toggled on, your tool automaticaly smelt mined iron and gold ores.
 **Bouncing Crack:** When toggled on, your tool mines extra blocks behind the initial one.
 
+## Item Elemental Stats
+```
+element:
+    fire:
+        defense: 
+            base: 10
+            scale: 3
+        # That format still works!
+        damage: 10
+    water:
+        defense: 50
+```
+
 ## Item Commands
 The list of commands your item performs when right clicking it. Commands may have a cooldown and a delay, after which it is automatically cast. You can use this option to create e.g consumables which teleport you back home using the /spawn command. **Warning**: the command cooldown differs from the consumable cooldown, therefore you need to make sure they are the same, otherwise the consumable may be consumed without casting the commands. You can use the %player% placeholder to get the command sender name.
 ```
@@ -202,3 +219,91 @@ Lutes are ranged weapons which emit a music projectile when right clicked. Lutes
 ## Custom Item Sounds
 Custom item sounds are sounds played when performing specific actions with your items like attacking entities, right clicking your item, picking up your item... **Warning**, these sounds do not correspond to the Spigot javadocs sound names, they correspond to the vanilla sound names like `entity.zombie.attack_iron_door` (instead of `ENTITY_ZOMBIE_ATTACK_IRON_DOOR`).\
 Since they utilize vanilla sound names, you may use the sounds you added to your server resource pack setup! You can find the sound name list online like on this [pastebin](https://pastebin.com/gLMhUyis).
+
+## Abilities
+Using the item generator, you can create items with special abilities which get stronger the higher the item level. Precisely, abilities have modifiers (how much damage it deals, how long a potion effect lasts..) which can scale on the item level. Use this format to add an ability to an item gen template/item gen modifier:
+```
+ability:
+    first-ability-id:
+        type: burn
+        mode: on_hit
+
+        # First ability modifier
+        cooldown:
+            base: 6
+            spread: .1
+            max-spread: .3
+
+        # Second ability modifier
+        duration:
+            base: 3
+            scale: .2
+    second-ability:
+        type: life-ender
+        mode: right-click
+        damage:
+            base: 10
+            scale: 3
+    third-ability:
+        type: blizzard
+        mode: left-click
+        damage:
+            base: 5
+        cooldown:
+            base: 7
+            scale: 2
+ 
+```
+You may notice that the format is the exact same as if you wanted to add an ability to a normal (not randomly generated) mmoitem. The only thing that changes is how you define the ability modifiers, because they are the only values which can really scale on the item level. The formulas used to define an ability modifier are the same as the formulas used with
+[numeric stats](Item-Generator-Templates).
+
+In this example, the on-hit burn ability has a 6s cooldown however that values fluctuates +/-10% in average with a maximum relative offset of 10%. The burn lasts for 6 seconds but that duration is increased by 0.2 second for every item level.
+
+Note that if you want to specify an ability modifier but do not want it to scale, you must still specify a base, and set the scale and/or max-spread to 0 or remove them completely. See the above example titled `third-ability`. In this example, damage will be 5 on every item generated using the blizzard ability. However, cooldown will still scale as specified.
+
+## Potion effects obtained when eating a consumable
+Remember a potion effect is defined by three options: the potion effect type, a duration and a potion level.
+```
+potion-effect:
+    speed:
+        level:
+            base: 1
+            scale: 1
+        duration:
+            base: 10
+            scale: 3
+```
+Notice how you start to see a repeating pattern with the `base/scale/spread/maxspread` based config sections which seem to be literally everywhere when dealing with randomly generated items. Like any other numeric values, the potion duration and level can scale on the item level.
+
+Since these are numeric stats, you can also use this format if you want for instance the level to be the same everytime:
+```
+potion-effect:
+    speed:
+        level: 1
+        duration: ...
+```
+This is the exact same as the following
+```
+potion-effect:
+    speed:
+        level:
+            base: 1
+            scale: 0
+            spread: 0
+            max-spread: 0
+        duration: ...
+```
+
+## Consumable Restore Power
+Restore power defines how much health, food and saturation a consumable restores when used.
+```
+restore:
+    health:
+        base: 3
+        scale: 2
+        spread: .3
+        max-spread: .5
+    # You could use a complex formula for food, or just use this format
+    food: 5
+    saturation: 3
+```
\ No newline at end of file