GhettoEnchants 1.0.3

A simple and performant API for implementing custom enchantments

  1. vemacs
    Being dissatisfied with the current state of public APIs for custom enchantments (EnchantmentAPI comes to mind), I decided to write my own for my own server. This API allows developers to easily implement event-based enchants for tools and armor, and "ambient" enchants for armor. It supports dynamic enchant registration, uses lore for storage, provides sample enchant implementations, and provides a command to deliver items with vanilla and custom enchants to players. I would like to enable support for hooking into enchantment tables in the future.

    Unlike EnchantmentAPI, GhettoEnchants makes it easy to hook any event (or any method, really) into any ItemStack. See the implementation section for details.

    Unlike Custom Enchantments, ambient effects don't cause potion enchantments to flicker (as GhettoEnchants uses proper armor wear/remove events to handle this instead of clearing the potion list), this supports simple dynamic registration (which makes it much easier to use as an API), and the codebase is significantly cleaner.

    API usage:
    Put it in your build path. I'm currently looking into getting this into a public Maven repo. See sample implementations and main class for enchant registration.

    Compilation:
    mvn clean install, if you're compiling with an IDE, it would be wise to install the Lombok plugin for your IDE.

    Sample implementations:

    Register enchants by obtaining an instance of EnchantUtils by using EnchantsPlugin.getUtils(), and then registerEnchant(YourCustomEnchant.class).

    You can handle any event by extending BaseEnchant, in fact, all of the shipped abstract enchant classes are just BaseEnchants with canEnchant() implemented and perform() implemented to discard the handling of unnecessary events. If you need to hook it up to an arbitrary event, simply get an instance of EnchantUtils and run performEnchants(Event event, ItemStack... items)on an event handler, then register your BaseEnchant.

    For server owners:
    Unless you want to use the provided samples, you need to get a plugin that hooks into this one. If you wish to disable the samples, set the option to use samples to false in config.yml

    Commands/permissions examples:
    /giveenchanteditem|gei

    • Permission (default op): ghettoenchants.admin
    • Usage example: /gei vemacs diamond_pickaxe autosmelt:1,eff:3
    /listenchantments|listench
    • Permission (default op): ghettoenchants.admin
    Source code:
    https://github.com/vemacs/GhettoEnchants