|
|
Custom Enchantments
|
|
|
-------------
|
|
|
MythicEnchantments allows you to create fully functional enchants using the [Mythic Skill System](https://git.lumine.io/mythiccraft/MythicMobs/-/wikis/Skills/Start). Details of this system can be found on the [Mythic Manual](https://git.lumine.io/mythiccraft/MythicMobs/-/wikis/Skills/Start).
|
|
|
MythicEnchantments allows you to create fully functional enchants using the [Mythic Skill System](https://git.lumine.io/mythiccraft/MythicMobs/-/wikis/Skills/Skills). Details of this system can be found on the [Mythic Manual](https://git.lumine.io/mythiccraft/MythicMobs/-/wikis/home).
|
|
|
|
|
|
Getting started creating a new enchantment in MythicEnchants is fairly straight-forward! All custom enchantments are located in the `plugins/MythicEnchants/CustomEnchantments` folder, and to add a new one you just create a new file named after your enchant (or add it to an existing file).
|
|
|
|
... | ... | @@ -37,7 +37,124 @@ You can read more about the new toys added for skills in the manual: |
|
|
* [Enchant Triggers](Skills/Triggers)
|
|
|
* [Enchant Conditions](Skills/Conditions)
|
|
|
|
|
|
### Example with All Options
|
|
|
## Enchantment Config
|
|
|
When creating an enchantment these are the settings you can use.
|
|
|
|
|
|
### Internal Name
|
|
|
This string will be how your enchant will be referenced internally in MythicMobs and can be any name you like. Must be a unique name and does not clash with other internal enchantment names, **NO SPACES ALLOWED AND MUST BE ALL CAPS**
|
|
|
```yaml
|
|
|
EXAMPLE_NAME:
|
|
|
```
|
|
|
|
|
|
### Display
|
|
|
This is how you'd like the enchantment to be displayed when on an item.
|
|
|
```yaml
|
|
|
EXAMPLE_NAME:
|
|
|
Display: '&7Custom Enchant'
|
|
|
```
|
|
|
|
|
|
### MinLevel
|
|
|
The minimum level your enchantment can be.
|
|
|
```yaml
|
|
|
EXAMPLE_NAME:
|
|
|
Display: '&7Custom Enchant'
|
|
|
MinLevel: 1
|
|
|
```
|
|
|
|
|
|
### MaxLevel
|
|
|
The maximum level your enchantment can be.
|
|
|
```yaml
|
|
|
EXAMPLE_NAME:
|
|
|
Display: '&7Custom Enchant'
|
|
|
MinLevel: 1
|
|
|
MaxLevel: 3
|
|
|
```
|
|
|
|
|
|
### ItemType
|
|
|
The type of item. `ARMOR` `TOOL` `WEAPON`
|
|
|
```yaml
|
|
|
EXAMPLE_NAME:
|
|
|
Display: '&7Custom Enchant'
|
|
|
MinLevel: 1
|
|
|
MaxLevel: 3
|
|
|
ItemType: WEAPON
|
|
|
```
|
|
|
|
|
|
### Rarity
|
|
|
The rarity for the enchant. Check [rarity](/rarities) for more info.
|
|
|
```yaml
|
|
|
EXAMPLE_NAME:
|
|
|
Display: '&7Custom Enchant'
|
|
|
MinLevel: 1
|
|
|
MaxLevel: 3
|
|
|
Rarity: COMMON
|
|
|
```
|
|
|
|
|
|
### Options
|
|
|
This is a special field which comes with numerous sub-options, like determining if the mob should despawn,
|
|
|
setting knockback resistance, follow range, movement speed and many more.
|
|
|
A list of available mob options can be found in the [Enchantment Options](/Options) page
|
|
|
```yaml
|
|
|
EXAMPLE_NAME:
|
|
|
Display: '&7Custom Enchant'
|
|
|
MinLevel: 1
|
|
|
MaxLevel: 3
|
|
|
Options:
|
|
|
ShowInLore: FALSE
|
|
|
```
|
|
|
|
|
|
### ValidSlots
|
|
|
The slots the item can be in for the enchantment to be effective.\
|
|
|
`ALL` `MAINHAND` `OFFHAND` `HEAD` `CHEST` `LEGS` `FEET`
|
|
|
```yaml
|
|
|
EXAMPLE_NAME:
|
|
|
Display: '&7Custom Enchant'
|
|
|
MinLevel: 1
|
|
|
MaxLevel: 3
|
|
|
ValidSlots:
|
|
|
- HAND
|
|
|
- OFFHAND
|
|
|
```
|
|
|
|
|
|
### EnchantableItems
|
|
|
A list of items that can be enchanted with this enchantment.
|
|
|
```yaml
|
|
|
EXAMPLE_NAME:
|
|
|
Display: '&7Custom Enchant'
|
|
|
MinLevel: 1
|
|
|
MaxLevel: 3
|
|
|
EnchantableItems:
|
|
|
- DIAMOND_SWORD
|
|
|
- IRON_SWORD
|
|
|
- WOODEN_SWORD
|
|
|
```
|
|
|
|
|
|
### ConflictingEnchants
|
|
|
A list of enchantments this enchant is incompatible with. If the item being enchanted has one of these enchants it will not be able to receive the new enchant.\
|
|
|
A list of available vanilla [enchantments](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantment.html) can be found on spigot javadocs
|
|
|
```yaml
|
|
|
EXAMPLE_NAME:
|
|
|
Display: '&7Custom Enchant'
|
|
|
MinLevel: 1
|
|
|
MaxLevel: 3
|
|
|
ConflictingEnchants:
|
|
|
- FIRE_ASPECT
|
|
|
- DAMAGE_ALL
|
|
|
```
|
|
|
|
|
|
### Skills
|
|
|
Using Mythics skills and mechanics you are able to apply countless effects and abilities while using your item. Visit the [MythicMobs Skills Page](https://git.lumine.io/mythiccraft/MythicMobs/-/wikis/Skills/Skills) to read more.
|
|
|
```yaml
|
|
|
EXAMPLE_NAME:
|
|
|
Display: '&7Custom Enchant'
|
|
|
MinLevel: 1
|
|
|
MaxLevel: 3
|
|
|
Skills:
|
|
|
- ignite{ticks=100} @trigger ~onAttack
|
|
|
```
|
|
|
|
|
|
### Example Enchantment
|
|
|
A replica of Fire Aspect which sets your target on fire when you attack it.
|
|
|
```yaml
|
|
|
BURNING:
|
|
|
Display: 'Burning'
|
... | ... | @@ -45,18 +162,23 @@ BURNING: |
|
|
MaxLevel: 3
|
|
|
MergeCostPerLevel: 5
|
|
|
Rarity: COMMON
|
|
|
ValidSlots:
|
|
|
- MAINHAND
|
|
|
Options:
|
|
|
ShowInLore: TRUE
|
|
|
LevelAsPower: FALSE
|
|
|
EnchantableItems:
|
|
|
- DIAMOND_SWORD
|
|
|
- NETHERITE_SWORD
|
|
|
ConflictingEnchants: []
|
|
|
ConflictingEnchants:
|
|
|
- FIRE_ASPECT
|
|
|
EnchantingTable:
|
|
|
MinExperience: 0
|
|
|
MaxExperience: 30
|
|
|
MinLevel: 1
|
|
|
MaxLevel: 3
|
|
|
Skills:
|
|
|
- ignite{ticks=100} @trigger ~onAttack
|
|
|
- ignite{ticks=100} @target ~onAttack ?enchantleve{level=1}
|
|
|
- ignite{ticks=200} @target ~onAttack ?enchantleve{level=2}
|
|
|
- ignite{ticks=300} @target ~onAttack ?enchantleve{level=3}
|
|
|
``` |
|
|
\ No newline at end of file |