Enchantments
General Information
Configuration
For developers
Plugin Information
Creating Enchantments
Basic guide on creating enchantments
The enchantment creation process may seem difficult to begin with, but once you get the hang of it, it will become miraculously easy to do so. Firstly practice making simple enchants before getting into more complex creations.
Starting out
Firstly, a basic understanding of the enchantment template is required to start creating enchantments. Here's a run over the simple formatting:
1
<enchantment name>:
2
display: "<enchantment display>"
3
description: "<enchantment description>"
4
applies-to: "<applies to>"
5
type: "<enchantment type>"
6
group: "<group>"
7
applies:
8
- <material>
9
levels:
10
<level number>:
11
effects:
12
- "<effects>"
Copied!
This will be the basic template to use/learn when creating enchantments. Let's run over each of the required settings:
- <enchantment name>
- This will be the "back end" enchantment name, used in all commands/admin processes
- display
- This will be displayed in item lore, chat messages, and book formats
- Color codes can be used with the display
- Special placeholders:
- %group-color% - Use group's global color code
- description
- This will be the enchantment's description, used in various Menu's and book formats
- Supports "\n" character to split to the new line. Requires double-quotes symbol (") instead of single (')
- Color codes can be used with the display
- applied-to
- This will be used in Menu's, book formats, and chat messages
- Tells user which item category it may apply to (for instance: 'Armour', 'Weapons', etc.)
applies-to is visual only, meaning it won't have effect on what items it can actually be added onto- type
- Defines what triggers this enchantment
- group
- This sorts enchantment into specified groups from groups.yml file [TODO: create groups.yml page]
- This will also hint at the plugin what global color should be used for display
Group name needs to be all UPPER-CASE
- applies
- Sets a specified list of items which this enchantment can be added onto
- Supports plugin shortcuts such as:
- ALL[material]_ - Sets all specified material items ([Wooden, Stone, Iron, Diamond, Gold, Chain], e.g.: 'ALL_SWORD' will allow all types of swords)
- _[material]ARMOR - Supports all type of specified armor (Can also be used with the previous shortcut to create ALL_ARMOR item type, which will allow all possible armor pieces)
Other Options
There are a few other options that can be used when creating enchantments for more customization. These options are not required to create a basic enchant
1
<enchantment name>:
2
display: "<enchantment display>"
3
description: "<enchantment description>"
4
applies-to: "<applies to>"
5
type: "<enchantment type>"
6
group: "<group>"
7
applies:
8
- <material>
9
settings:
10
<setting>: <value>
11
levels:
12
<level number>:
13
cooldown: <number>
14
chance: <number>
15
condition:
16
- "<condition>"
17
effects:
18
- "<effects>"
Copied!
- settings
- Used to dictate special things for that specific enchantment
- cooldown
- The length between enchantment activations
- Time is measured in seconds
By default, if no cooldown is specified, is 0 seconds
- chance
- The chance of the enchantment activating when the type is triggered
- Measured from 0-100
By default, if no chance is specified, is 100%
- condition
- Require a certain placeholder to be parsed for enchant to activate
- Supports PAPI placeholders
- Have as many conditions as you want
Last modified 2mo ago