EnchantmentAPI

Lifesteal Enchantment

Overview

The plugin is made primarily for developer usage as it doesn't do much on its own. It does however provide very easy access into creating custom enchantments that look like normal enchantments and can be added through both the enchanting table and programmatically! Now developers can make new enchantments such as life steal even with very little code!

Don't want to code your own enchantments? Visit EnchantmentPack for a large collection of enchantments!

Features

Silly Enchantment
(a lv5190 enchantment)

  • An extendable class for plugins for simple setting up of enchantments
  • An abstract CustomEnchantment class for quick enchantment creation
  • Automatic effect activation when the enchanted item hits something
  • Automatic enchanting table integration
  • Enchantments are easily added onto any item
  • The max level of enchantments is that of an integer variable
  • Large enchantment levels should probably be avoided though (above is a good reason why)
  • Any item can use the enchantments (torches, signs, you name it)
  • Enchantment effects can be for attacking, defending, breaking blocks, equipping, unequipping, or mix of them all!
  • Any enchantment can be completely disabled by editing the config
  • Configurable weights, max levels, conflict groups, and item sets for all enchantments
  • All items can be used in enchanting tables if they have an enchantment bound to them as of v3.0!
  • Anvils can now handle custom enchantments very similar to any vanilla enchantment (v4.0)
  • Randomly generated names can be applied to enchanted items! (You can turn this off)
  • Permissions per enchantment (with v4.10)

Statistics

New Enchantment Table Mechanics

For an in-depth explanation on the new mechanics for the enchantment table (because it needed some to get every item to work), go here
Thanks to Diemex for coming up with this idea :)

Config

A config file is generated as new enchantments are added. Adding more enchantments later will simply automatically add onto the config with its default values the next time you reload your server. All changes you make will override the enchantment values. You can edit them while the server is running and reloading the server will apply them.

The config allows you to change the following things:

  • weight: chance of getting the enchantment from a table
  • items: the items that can receive the enchantment from a table
  • enabled: whether or not the enchantment can be obtained and used
  • table: whether or not the enchantment can be obtained in the enchantment table
  • group: the conflict group of the enchant - items in the same group will conflict unless its the default group
  • max: the maximum level for the enchantment
  • base: the minimum modified enchantment level that can get the enchantment
  • interval: the amount of modified enchantment levels above the base it takes to get the next tier

    Vanilla enchantments cannot be completely disabled, although you can stop them from being received in the enchantment table.

    Disabled custom enchantments will no longer work on items that had received it before disabling it.

Commands

  • /enchantapi list [page] - Providing the page gives a detailed list while no page just shows you the complete list
  • /enchantapi reload - Reloads the plugin data
  • /enchantapi book - gives you a book with descriptions for every enchantment
  • /enchantapi add <enchantName> [enchantLevel] - Supports vanilla names such as "sharpness" as of v4.0!
  • /enchantapi stats <item> <level> - Displays probabilities for every possible enchantment for the item at the given level (item name or item ID)
  • /enchantapi graph <item> <enchant> - Displays a graph for probabilities of the enchantment on the item over all 30 levels (item name or item ID)
    Yes, you do have to include spaces for the addenchant command with the enchantment name!
    Note: the graph takes 3-5 seconds to generate because it generates 3,000,000 samples in order to get reliable results!

    graph command

Permissions

  • EnchantmentAPI.list - access to the list command
  • EnchantmentAPI.book - access to giving yourself a description book
  • EnchantmentAPI.admin - access to adding enchants to items, reloading the plugin, and viewing statistics
  • EnchantmentAPI.table - access to custom enchantments from the table
  • EnchantmentAPI.names - access to random names from enchanting (needs table as well)

    Version 4.10 permissions
  • EnchantmentAPI.enchant - access to all enchantments in the table (default is true)
  • EnchantmentAPI.enchant.enchantName - access to the enchantment in the table (replace 'enchantName' with the name of the enchantment with all lowercase letters and no spaces)

    Version 4.11 permissions
  • EnchantmentAPI.enchant.vanilla - access to all vanilla enchantments (default is true)
    Note, with this permission added, removing the permission EnchantmentAPI.enchant will still leave players with access to vanilla enchantments. You must remove both for them not to have the access!

Javadocs, Source Code, and Tutorials

Javadocs

Javadocs are found here
Thanks to JefferiesTube for the space for the javadocs!

Source Code

Github

Tutorials

Troubleshooting

  • Losing items in the enchanting table? Try deleting your config files as they are probably outdated
  • If the you start getting loading problems that point to EnchantPlugin saying that the class cannot be loaded, try adding this line to your plugin.yml:
depend: [EnchantmentAPI]

Example Enchantments

Forum

I have created a forum for this that you can submit ideas, projects you are working on, and bugs to. Its completely optional but it might help organize what's going on with this project :)

Special Thanks

  • zag09 for finding several bugs and making suggestions
  • JefferiesTube for the Javadocs space and the bountiful suggestions
  • Diemex for cleaning up my sloppy code

Like the project?

You must login to post a comment. Don't have an account? Register to get one!

  • Avatar of Eniripsa96 Eniripsa96 May 27, 2015 at 18:01 UTC - 0 likes

    @DarkWolf1974: Go

    How do lapis normally work? Is it 1 lapis = 9 levels or something?

    @TheAgusIV: Go

    There's not currently a way to disable it.

    BFAK:86513,955c39aa0fd005d53a0df93f256769ca83f60e42d36afbeaf01fab5fcc205630My Plugins: SkillAPI | Parties | MCCore | LegendaryWeapons | EnchantmentAPI | EnchantmentPack

  • Avatar of DarkWolf1974 DarkWolf1974 May 27, 2015 at 17:22 UTC - 0 likes

    @Eniripsa96: Go

    Not playing Minecraft?? I'm shocked! :)

    Yup. 1.8 consumes 3 lapis and 3 levels used for the max enchant, needing at least 30 [or whatever the level enchant is] levels to fire it.

    I also noticed that if I stick over 3 lapis in (lazy me, chucked a stack in), it consumed the entire stack. Assuming this is linked to the lack of 1.8 mechanics handling.

  • Avatar of TheAgusIV TheAgusIV May 26, 2015 at 22:56 UTC - 0 likes

    Hello, I have a problem with the anvil , a bug duplicate items , tell me how desabilito the anvil ? please

  • Avatar of Eniripsa96 Eniripsa96 May 26, 2015 at 20:57 UTC - 0 likes

    @DarkWolf1974: Go

    I didn't implement 1.8 mechanics in the current version as I wasn't even aware how they worked (that's what I get for not playing Minecraft).

    @Nanjeang: Go

    There's settings for the cooldowns in the config for the corresponding enchant pack if you are using the EnchantmentPack.

    @Zombiesking4260: Go

    Yes, the only way to make custom enchantments with this is via code. There are pre-built examples though in EnchantmentPack.

  • Avatar of Zombiesking4260 Zombiesking4260 May 26, 2015 at 02:35 UTC - 0 likes

    do you have to code to make a custom enchantment?

  • Avatar of Metalclaws101 Metalclaws101 May 25, 2015 at 16:21 UTC - 0 likes

    Hi I Have A Server And This Awesome Plugin Has Made It So Much Better So Thank You Eniripsa96 for making it

  • Avatar of Nanjeang Nanjeang May 25, 2015 at 03:31 UTC - 0 likes

    How do I cooldown settings?

  • Avatar of DarkWolf1974 DarkWolf1974 May 24, 2015 at 04:34 UTC - 0 likes

    Any time I enchant anything at the max, it uses up all 30 levels instead of the new 1.8 methods of using 3 lapis and 3 levels. Am I missing something?

  • Avatar of Elreith Elreith May 23, 2015 at 23:55 UTC - 0 likes

    Hai! I just want to say thank you for making such an awesome plugin! Keep up the good work! :D

  • Avatar of Eniripsa96 Eniripsa96 May 23, 2015 at 18:09 UTC - 0 likes

    @Wilbo1234: Go

    Alright, just uploaded a fix for that. It should be available soon (v4.23)

Facts

Date created
May 31, 2013
Category
Last update
May 23, 2015
Development stage
Release
Language
  • enUS
License
MIT License
Curse link
EnchantmentAPI
Downloads
32,527
Recent files

Authors