Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jikoo/planarenchanting

A more flexible and customizable system mimicking vanilla's enchanting functionality.
https://github.com/jikoo/planarenchanting

anvil bukkit enchanting

Last synced: about 1 month ago
JSON representation

A more flexible and customizable system mimicking vanilla's enchanting functionality.

Awesome Lists containing this project

README 

        
# PlanarEnchanting



![Build](https://github.com/Jikoo/PlanarEnchanting/workflows/Build/badge.svg)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Jikoo_PlanarEnchanting&metric=coverage)](https://sonarcloud.io/dashboard?id=Jikoo_PlanarEnchanting)  

Yet another Bukkit-related library.



## About



Enchanting is tied to a couple excessively complex systems in Minecraft.

Not only is there a lot of arcane math involved, it's all done in extremely long run-on methods that

are largely incomprehensible. Even with Mojang's mappings distributed, variable names inside methods

are not exposed, so you have to read the entirety of the code and understand exactly how it works

before attempting to manually deobfuscate it. PlanarEnchanting is an effort to take the enchanting

systems and divide them up into readable, manageable, customizable segments.



## Offerings



### Anvil Enchanting



Anvil enchanting is primarily accessed via the

[`AnvilOperation`](src/main/java/com/github/jikoo/planarenchanting/anvil/AnvilOperation.java).

This is a class containing several simple ways to modify anvil behaviors.



For basic vanilla-style combination, all you need is an ordinary `AnvilOperation`.



```java

class MyAnvilHandler implements Listener {

  @EventHandler

  private void onPrepareAnvil(PrepareAnvilEvent event) {

    AnvilInventory inventory = event.getInventory();

    AnvilOperation operation = new AnvilOperation();

    AnvilResult result = operation.apply(inventory);



    event.setResult(result.item());

    inventory.setRepairCostAmount(result.materialCost());



    // Note: depending on how anvil actually functions, may need to update cost on a 0-tick delay.

    // May also need to set relevant window property for client.

    inventory.setRepairCost(result.levelCost());

  }

}

```



For specific use cases (i.e. removing or changing enchantment level cap) you can provide the

`AnvilOperation` with different functions which will be used by the default `AnvilFunction`

implementations.



Allowing conflicting enchantments to be added:

```java

AnvilOperation operation = new AnvilOperation();

operation.setEnchantsConflict((enchant1, enchant2) -> false);

```



If you have even more specific needs but still want to leverage certain vanilla-style functionality,

you can write your own `AnvilOperation` and override `AnvilOperation#apply` to set your own

operation order.



A custom `AnvilOperation` that only performs rename operations:



```java

class RenameOperation extends AnvilOperation {

  @Override

  public void apply(@NotNull AnvilInventory inventory) {

    AnvilOperationState state = new AnvilOperationState(this, inventory);



    if (ItemUtil.isEmpty(state.getBase().getItem())) {

      return AnvilResult.EMPTY;

    }



    // Apply base cost.

    state.apply(AnvilFunction.PRIOR_WORK_LEVEL_COST);

    // Apply rename.

    state.apply(AnvilFunction.RENAME);



    return state.forge();

  }

}

```



### Enchanting Table Enchanting



Enchanting Table-style enchanting is accessed via the [`EnchantingTable`](src/main/java/com/github/jikoo/planarenchanting/table/EnchantingTable.java).



The constructor accepts a collection of enchantments that may be applied and the `Enchantability` (a

wrapper for a magic value representing an enchantment bonus; constants for vanilla values are

provided) of the item.



Minecraft's enchantment system is a mess of magic values, RNG, and a tiny bit of math. As there's no

really great way to expose that math and make it modifiable (you may as well just write your own

system then anyway), the enchantment system is not particularly customizable beyond what you see on

the surface. You may manipulate incompatibility between enchantments and enchantments' max levels.



Allow enchanting `Material.STONE` with enchantments usually available for tools:



```java

class StoneEnchantListener extends TableEnchantListener {



  // Set up table.

  private final EnchantingTable table = new EnchantingTable(

      List.of(

          Enchantment.DIG_SPEED,

          Enchantment.DURABILITY,

          Enchantment.LOOT_BONUS_BLOCKS,

          Enchantment.SILK_TOUCH),

      Enchantability.STONE);



  StoneEnchantListener(@NotNull Plugin plugin) {

    super(plugin);

  }



  @Override

  protected @Nullable EnchantingTable getTable(

      @NotNull Player player,

      @NotNull ItemStack enchanted) {

    // Use stored instance.

    return table;

  }



  @Override

  protected boolean isIneligible(

      @NotNull Player player,

      @NotNull ItemStack enchanted) {

    // Only allow enchanting stone.

    return itemStack.getType() != Material.STONE;

  }



}

```



If you want more specific functionality you can write your own listener from scratch.



## For Developers



Please relocate PlanarEnchanting when including its files in your project! Bundled library conflicts

are not fun, make your life easier.



### License [![WTFPL](http://www.wtfpl.net/wp-content/uploads/2012/12/wtfpl-badge-2.png)](http://www.wtfpl.net/)



This project is licensed under the WTFPL. You can do whatever you want with the content.

If you do use it and decide to credit me, thanks! I think you're just swell.



### Version Control



PlanarEnchanting is available via [JitPack](https://jitpack.io). I pretty much only use Maven in my

projects, so that's the only full writeup you get, but JitPack supports Gradle, Maven, SBT, and

Leiningen.



### Maven



Replace `$planarVersion` with the version you desire to work with. The `minimizeJar` option is

recommended to prevent inflating your plugin with unnecessary classes.



Sample configuration:



```xml



  

    

      jitpack.io

      https://jitpack.io

    

  



  

    

      com.github.jikoo

      planarenchanting

      $planarVersion

      compile

    

  



  

    

      

        org.apache.maven.plugins

        maven-shade-plugin

        3.3.0

        

          

            package

            

              shade

            

            

              

                

                  com.github.jikoo.planarenchanting

                  com.example.myplugin.planarenchanting

                

              

            

          

        

      

    

  



```