Home

Plugin installation and configuration

Just drop the plugin jar to /plugin on a spigot or fork of spigot, restart, and it should work.

Plugin configuration guide will come later in this wiki (not the priority). Preferably, use /configanvil to configure the plugin.

If you like to make your custom enchantment plugin compatible with Custom Anvil, the rest of the documentation will help you with that.

Here are the general step to make your plugin compatible with Custom Anvil:

Add CustomAnvil as softdepend or depend
On startup, if CustomAnvil is present, listen to the necessary event.
On event trigger, Register Enchantments, Material Group and Enchantment Conflict.
(Optional) Also register bulk operation for optimization if possible.

You can also register Custom anvil recipe if you like to.

Custom Anvil is available on Maven Central. You can check the lastest version here

Make sure mavenCentral() is present in your Gradle repositories

<dependency>
    <groupId>xyz.alexcrea</groupId>
    <artifactId>CustomAnvil</artifactId>
    <version>1.6.9</version>
</dependency>

dependencies {
    implementation 'xyz.alexcrea:CustomAnvil:1.6.9'
}

for easy copy paste:

implementation 'xyz.alexcrea:CustomAnvil:1.6.9'

dependencies {
    implementation("xyz.alexcrea:CustomAnvil:1.6.9")
}

for easy copy paste:

implementation("xyz.alexcrea:CustomAnvil:1.6.9")

Right now, documentation is incomplete and more page will be provided later.

The API is also incomplete and is missing unit repair.
Current version may recreate object if deleted by user (fixed on next version).

Join the discord server for quick support.