Enchantments

Enchantable Items

To make a NovaItem enchantable, add the Enchantable item behavior.

val EXAMPLE_ITEM = registerItem("example_item", Enchantable)

# The enchantment value
enchantment_value: 10 # (1)!
# The enchantment categories
enchantment_categories: ["weapon", "breakable"] # (2)!

1. The enchantment value of the item. This value defines how enchantable an item is. A higher enchantment value means more secondary and higher-level enchantments.
   Vanilla enchantment values: wood: 15, stone: 5, iron: 14, diamond: 10, gold: 22, netherite: 15
2. The enchantment categories of the item. This defines which enchantments can be applied to this item.

Working with enchantable items

Utility functions to work with enchantable items can be found in the companion object of Enchantable.
Those utility functions can be used for both vanilla and custom items and both vanilla and custom enchantments.

Enchantments

Vanilla Enchantments

This is a list of all vanilla enchantments and which category they belong to. They can be obtained in code from VanillaEnchantments.

Custom Enchantments

To create a custom enchantment, you'll need to create an EnchantmentRegistry:

@Init(stage = InitStage.PRE_PACK) // (1)!
object Enchantments : EnchantmentRegistry by ExampleAddon.registry {

    val EXAMPLE_ENCHANTMENT = enchantment("curse_of_gigantism")
        .categories(/*...*/) // (2)!
        .maxLevel(/*...*/) // (3)!
        .tableDiscoverable(/*...*/) // (4)!
        .tableLevelRequirement(/*...*/) // (5)!
        .rarity(/*...*/) // (6)!
        .curse(/*...*/) // (7)!
        .incompatibleWith(/*...*/) // (8)!

        // Without functionality (not yet implemented):
        .treasure(/*...*/) // (9)!
        .tradeable(/*...*/) // (10)!

        .register()

}

1. Nova will load this class during addon initialization, causing your enchantment categories to be registered.
2. The categories that this enchantment belongs to. Can be one or multiple. Can be custom or vanilla.
3. The maximum level of this enchantment. Defaults to 1.
4. Whether this enchantment can be found in the enchantment table.
5. The level requirement range of this enchantment in the enchantment table. This defines whether an enchantment can be displayed in an enchantment table slot of a certain level. You either specify an IntRange, or a lambda that accepts the enchantment level and returns an IntRange.
   Defaults to { val min = 1 + it * 10; min..(min + 5) } (vanilla behavior).
6. A weight value used to determine how likely this enchantment is to be found in the enchantment table. Common: 10, Uncommon: 5, Rare: 2, Very Rare: 1. Defaults to 10.
7. Whether this enchantment is a curse. Defaults to false.
8. Enchantments that this enchantment is incompatible with. Alternatively, you can also specify a list of enchantments that this enchantment is compatibly with, or set a lambda that accepts an enchantment and returns whether it is compatible.
9. Whether this enchantment is a treasure enchantment. Defaults to false. Note: There is currently no built-in way to make treasure enchantments spawn in the world
10. Whether this enchantment is tradeable. Defaults to false. Note: Not yet implemented

Enchantment Categories

Enchantment categories are groups of enchantments for certain types of items.
In vanilla, the enchantment categories themselves define which item types they apply to, but in Nova, the item itself chooses which enchantment categories it wants to be in via the Enchantable item behavior.

Vanilla Enchantment Categories

This is a list of all vanilla enchantment categories and the enchantments they contain. They can be obtained in code from VanillaEnchantmentCategories or referenced in, for example, the enchantment_categories config entry using their namespaced name.

Custom Enchantment Categories

Of course, you can also create your own enchantment categories. To do this, you will need to create an EnchantmentCategory registry:

@Init(stage = InitStage.PRE_PACK) // (1)! 
object EnchantmentCategories EnchantmentCategoryRegistry by ExampleAddon.registry {

    val EXAMPLE_CATEGORY = registerEnchantmentCategory("example_category")

}

1. Nova will load this class during addon initialization, causing your enchantment categories to be registered.

To apply your enchantment category to an item, you'll need to use the Enchantable item behavior. (see above)

enchantment_categories: ["example_addon:example_category"]

@Init(stage = InitStage.PRE_PACK)
object Items EnchantmentCategoryRegistry by ExampleAddon.registry {

    val EXAMPLE_CATEGORY = enchantmentCategory("example_category")
        .enchants(Material.DIRT) // (1)!
        .enchants(Tag.LEAVES) // (2)!
        .register()

}