Skip to content

GitLab

Custom Enchantments · Changes

Page history
Update custom enchantment config authored by Phillip's avatar Phillip
Show whitespace changes
Inline Side-by-side
Showing with 144 additions and 90 deletions
Custom-Enchantments.md
View page @ 1ed4b3da
MythicEnchantments allows you to create fully functional enchants using the [Mythic Skill System](/../../../MythicMobs/-/wikis/Skills/Skills). Details of this system can be found on the [Mythic Manual](/../../../MythicMobs/-/wikis/home). MythicEnchantments allows you to create fully functional enchants using the [Mythic Skill System](/../../../MythicMobs/-/wikis/Skills/Skills).
Details of this system can be found on the [Mythic Manual](/../../../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). 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).
Inside each file, a custom enchantment can look like this: Inside each file, a custom enchantment can look like this:
```yaml ```yaml
BURNING: burning:
Display: 'Burning' Display: "<red>Burning</red>"
MinLevel: 1 SupportedItems:
- "diamond_sword"
- "netherite_sword"
Weight: 2
MaxLevel: 3 MaxLevel: 3
Rarity: COMMON MinCost:
EnchantableItems: Base: 1
- DIAMOND_SWORD AdditionalPerLevelCost: 0
- NETHERITE_SWORD MaxCost:
Base: 4
AdditionalPerLevelCost: 0
Skills: Skills:
- ignite{ticks=100} @trigger ~onAttack ?enchantLevel{level=1} - ignite{ticks=100} @target ~onAttack ?enchantleve{level=1}
- ignite{ticks=200} @trigger ~onAttack ?enchantLevel{level=2} - ignite{ticks=200} @target ~onAttack ?enchantleve{level=2}
- ignite{ticks=300} @trigger ~onAttack ?enchantLevel{level=3} - ignite{ticks=300} @target ~onAttack ?enchantleve{level=3}
``` ```
This enchantment would set whatever you hit on fire, just like Fire Aspect! Why did we remake Fire Aspect? Nobody knows! But in this case, it will set things on fire for 100 ticks per level. This enchantment would set whatever you hit on fire, just like Fire Aspect! Why did we remake Fire Aspect? Nobody knows! But in this case, it will set things on fire for 100 ticks per level.
...@@ -27,48 +35,69 @@ Most mechanics, conditions, and triggers from Mythic can be used in enchantments ...@@ -27,48 +35,69 @@ Most mechanics, conditions, and triggers from Mythic can be used in enchantments
When creating an enchantment these are the settings you can use. When creating an enchantment these are the settings you can use.
### Internal Name ### 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** This string will be how your enchant will be referenced internally in MythicEnchants and can be any name you like.
Must be a unique name and does not clash with other MythicEnchant names, **NO SPACES ALLOWED**
```yaml ```yaml
EXAMPLE_NAME: example_enchant:
``` ```
### Display ### Display
This is how you'd like the enchantment to be displayed when on an item. This is how you'd like the enchantment to be displayed on the item's lore.
```yaml ```yaml
EXAMPLE_NAME: example_enchant:
Display: '&7Custom Enchant' Display: "<red>Burning</red>"
``` ```
### MinLevel ### MaxLevel
The minimum level your enchantment can be. The maximum level your enchantment can be.
Defaults to `1`. Defaults to `1`.
```yaml ```yaml
EXAMPLE_NAME: example_enchant:
Display: '&7Custom Enchant' Display: "<red>Burning</red>"
MinLevel: 1 MaxLevel: 3
```
### Weight
Sets how common this enchantment will appear when enchanting. The higher the number, the more common the enchantment.
The value must be between 1 and 1024 (inclusive).
```yaml
example_enchant:
Display: "<red>Burning</red>"
MaxLevel: 3
Weight: 200
``` ```
### MaxLevel ### MinCost and MaxCost
The maximum level your enchantment can be. Sets the minimum cost for this enchantment in Enchanting Table.
Defaults to `5`.
```yaml ```yaml
EXAMPLE_NAME: example_enchant:
Display: '&7Custom Enchant' Display: "<red>Burning</red>"
MinLevel: 1
MaxLevel: 3 MaxLevel: 3
Weight: 200
MinCost:
Base: 1 # The cost at enchantment level 1
AdditionalPerLevelCost: 0 # Added to the base cost per level over 1
MaxCost:
Base: 3 # The cost at enchantment level 1
AdditionalPerLevelCost: 4 # Added to the base cost per level over 1
``` ```
### ItemType ### AnvilCost
The type of item. `ARMOR` `TOOL` `WEAPON` Sets the cost when applying this enchantment when using an anvil. The cost is halved when using a book, and the final cost is multiplied by the enchantment's level.
```yaml ```yaml
EXAMPLE_NAME: example_enchant:
Display: '&7Custom Enchant' Display: "<red>Burning</red>"
MinLevel: 1
MaxLevel: 3 MaxLevel: 3
ItemType: WEAPON Weight: 200
MinCost:
Base: 1 # The cost at enchantment level 1
AdditionalPerLevelCost: 0 # Added to the base cost per level over 1
MaxCost:
Base: 3 # The cost at enchantment level 1
AdditionalPerLevelCost: 4 # Added to the base cost per level over 1
AnvilCost: 3
``` ```
### Rarity <!--### Rarity
The rarity for the enchant. Check [rarity](/rarities) for more info. The rarity for the enchant. Check [rarity](/rarities) for more info.
```yaml ```yaml
EXAMPLE_NAME: EXAMPLE_NAME:
...@@ -77,94 +106,119 @@ EXAMPLE_NAME: ...@@ -77,94 +106,119 @@ EXAMPLE_NAME:
MaxLevel: 3 MaxLevel: 3
Rarity: COMMON Rarity: COMMON
``` ```
-->
### Options ### Options
This is a special field which comes with numerous sub-options, like determining if the mob should despawn, 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. 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 A list of available mob options can be found in the [Enchantment Options](/Options) page
```yaml ```yaml
EXAMPLE_NAME: example_enchant:
Display: '&7Custom Enchant' Display: "<red>Burning</red>"
MinLevel: 1
MaxLevel: 3 MaxLevel: 3
Options: Options:
ShowInLore: FALSE Cursed: true
``` ```
### ValidSlots ### ValidSlots
The slots the item can be in for the enchantment to be effective.\ The slots the item can be in for the enchantment to be effective.\
`ALL` `MAINHAND` `OFFHAND` `HEAD` `CHEST` `LEGS` `FEET` `any`, `mainhand`, `offhand`, `head`, `chest`, `legs`, `feet`, `armor`, and `body` (For Horses and Wolves)
```yaml ```yaml
EXAMPLE_NAME: example_enchant:
Display: '&7Custom Enchant' Display: "<red>Burning</red>"
MinLevel: 1
MaxLevel: 3 MaxLevel: 3
ValidSlots: ValidSlots:
- HAND - mainhand
- OFFHAND
``` ```
### EnchantableItems ### SupportedItems
A list of items that can be enchanted with this enchantment. A list of items that can be enchanted with this enchantment. Can take a list of items, if the config is set as a list, or an [item tag](https://minecraft.wiki/w/Tag#Item_tags_2) if not.
```yaml ```yaml
EXAMPLE_NAME: example_enchant:
Display: '&7Custom Enchant' Display: "<red>Burning</red>"
MinLevel: 1 MaxLevel: 3
ValidSlots:
- mainhand
SupportedItems:
- "diamond_sword"
- "iron_sword"
```
```yaml
example_enchant:
Display: "<red>Burning</red>"
MaxLevel: 3
ValidSlots:
- mainhand
SupportedItems: "swords"
```
### PrimaryItems
Item types that this enchantment appears on the Enchanting Table. Must be a subset of supported items. Can take a list of items, if the config is set as a list, or an [item tag](https://minecraft.wiki/w/Tag#Item_tags_2) if not.
```yaml
example_enchant:
Display: "<red>Burning</red>"
MaxLevel: 3 MaxLevel: 3
EnchantableItems: ValidSlots:
- DIAMOND_SWORD - mainhand
- IRON_SWORD SupportedItems: "swords"
- WOODEN_SWORD PrimaryItems:
- "diamond_sword"
- "iron_sword"
``` ```
### ConflictingEnchants ### 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 enchantments this enchant is incompatible with. Can take a list of enchantments, if the config is set as a list, or an [enchantment tag](https://minecraft.wiki/w/Tag#Enchantment_tags) if not.
A list of available vanilla [enchantments](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/enchantments/Enchantment.html) can be found on spigot javadocs
```yaml ```yaml
EXAMPLE_NAME: example_enchant:
Display: '&7Custom Enchant' Display: "<red>Burning</red>"
MinLevel: 1
MaxLevel: 3 MaxLevel: 3
ValidSlots:
- mainhand
SupportedItems:
- "diamond_sword"
- "iron_sword"
ConflictingEnchants: ConflictingEnchants:
- FIRE_ASPECT - "minecraft:fire_aspect"
- DAMAGE_ALL - "mending"
```
```yaml
example_enchant:
Display: "<red>Burning</red>"
MaxLevel: 3
ValidSlots:
- mainhand
SupportedItems: "swords"
ConflictingEnchants: "exclusive_set/damage"
``` ```
### Skills ### Skills
Using Mythics skills and mechanics you are able to apply countless effects and abilities while using your item. Visit the [MythicMobs Skills Page](/../../../MythicMobs/-/wikis/Skills/Skills) to read more. Using Mythic skills and mechanics you are able to apply countless effects and abilities while using your item. Visit the [MythicMobs Skills Page](/../../../MythicMobs/-/wikis/Skills/Skills) to read more.
```yaml ```yaml
EXAMPLE_NAME: example_enchant:
Display: '&7Custom Enchant' Display: "<red>Burning</red>"
MinLevel: 1
MaxLevel: 3 MaxLevel: 3
ValidSlots:
- mainhand
SupportedItems: "swords"
Skills: Skills:
- ignite{ticks=100} @trigger ~onAttack - message{m="Hello world"} @world ~onJump
``` ```
## Examples ## Examples
A replica of Fire Aspect which sets your target on fire when you attack it. A replica of Fire Aspect which sets your target on fire when you attack it.
```yaml ```yaml
BURNING: burning:
Display: 'Burning' Display: "<red>Burning</red>"
MinLevel: 1 SupportedItems:
MaxLevel: 3 - "diamond_sword"
MergeCostPerLevel: 5 - "netherite_sword"
Rarity: COMMON Weight: 2
ValidSlots:
- MAINHAND
Options:
ShowInLore: TRUE
LevelAsPower: FALSE
EnchantableItems:
- DIAMOND_SWORD
- NETHERITE_SWORD
ConflictingEnchants:
- FIRE_ASPECT
EnchantingTable:
MinExperience: 0
MaxExperience: 30
MinLevel: 1
MaxLevel: 3 MaxLevel: 3
MinCost:
Base: 1
AdditionalPerLevelCost: 0
MaxCost:
Base: 4
AdditionalPerLevelCost: 0
Skills: Skills:
- ignite{ticks=100} @target ~onAttack ?enchantleve{level=1} - ignite{ticks=100} @target ~onAttack ?enchantleve{level=1}
- ignite{ticks=200} @target ~onAttack ?enchantleve{level=2} - ignite{ticks=200} @target ~onAttack ?enchantleve{level=2}
......