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 BrutalMC BrutalMC Jul 18, 2014 at 16:46 UTC - 0 likes

    Could someone either update this plugin for someone take it over? The owner has told me he has stopped working on it.

  • Avatar of TimothyLampen TimothyLampen Jul 14, 2014 at 15:38 UTC - 0 likes

    Hi, is there a way that I can add an enchantment to an item via code? For example player.getItemInHand().addEnchantment(CustomEnchantment.LifeSteal) or something like that.

    Thanks, Tim

  • Avatar of OzOwnz OzOwnz Jul 03, 2014 at 18:20 UTC - 0 likes

    @nashoxx: Go

    Compile the commit from mvn-repo on Github. It makes anvils usable again, although tell your users not to use it with custom enchants.

  • Avatar of MisterSanglad MisterSanglad Jun 06, 2014 at 17:45 UTC - 0 likes

    Can you update 1.7.9 ? :D

  • Avatar of KevinABC96 KevinABC96 May 31, 2014 at 15:08 UTC - 0 likes
    • Fix anvil bug
    • Add permission to see the enchantments in the table before picking them
    • Enchant an item multiple times
  • Avatar of TheRynoMyte TheRynoMyte May 06, 2014 at 00:20 UTC - 0 likes

    Great plugin, i have had it sitting dormant in the background of my server for a while now, then I found it again!!! I ended up using this and the [shop] plugin to sell enchantapi items to players for different arenas. They can purchase the items in the arena, with arena tokens, and works great. But seems the Life chestplate from time to time carries over to the normal world, which is separate inventories per world. Any ideas how this slight nuisance of a glitch/bug can be figured out? Restarting the server works, but would be a drastic measure to remove the extra hearts per map.

    sig

    [1.7.9 Spigot]

  • Avatar of nashoxx nashoxx May 02, 2014 at 22:06 UTC - 0 likes

    Does anyone knows how to fix the anvilg bug?

  • Avatar of MCRanger175 MCRanger175 Apr 29, 2014 at 23:03 UTC - 0 likes

    Is there anyway I can have a player spawn with an enchanted item in kitpvp? Say I want a stick with dash 55, is it possible?

  • Avatar of NathanWolf NathanWolf Apr 24, 2014 at 21:00 UTC - 0 likes

    Hello!

    Would it be possible for you to add an item exclusion list? Either a nice static API method I can call, or something in the config files?

    If I could tell the plugin to leave certain items (e.g. wood_hoe) alone that would fix a lot of issues with this plugin interacting with my own, and I'd appreciate it!

    (cc: @shadowofdoom100)

    BFAK:1034,0c13cf5d490f7c7bab438f2c4298c44509c85d916593cec4815c2ae51a52ecf6

  • Avatar of JKMODz JKMODz Apr 24, 2014 at 05:55 UTC - 1 like

    Please fix the anvil it just will not load the default Anvil GUI no matter what i do :(

Facts

Date created
May 31, 2013
Category
Last update
Jan 03, 2014
Development stage
Release
Language
  • enUS
License
All Rights Reserved
Curse link
EnchantmentAPI
Downloads
17,279
Recent files

Authors