CauldronWitchery#

Unfortunately Spigot does not have a general item parsing mechanics. So plugin authors need to create their own. CauldronWitchery addon uses BentoBox Item Parser. If function is not supported by it, then you cannot.

However, you can always use in-game admin GUI to set any items you want. There is not any limitation.

There could be several reasons for that. If there is obvious error, log file should contain the error message with it.

However, you can start with checking if all recipes starts with - and every item (ingredient, cauldron, level, etc) are alligned by the left side.

Another reason could be that the entity, item or book does not exist. You should check if the input for them are correct.

Yes, definitely you can. You can add it via [book_id]-[locale_code].yml or changing existing one.

Yes, just remove recipe section from the book.

Yes, just create a new file under books directory. File must be named [book_id]-[locale_code].yml and it must start with [book_id]:.

To customize Addon GUI's you need to have version 2.0. This is a first version that has implemented them. Addon will create a new directory under /plugins/BentoBox/addons/CauldronWitchery with a name panels

Currently you can customize 2 GUI's:

• Stick Panel: stick_panel - panel that contains all magic sticks and users can purchase or get them.
• Recipe Panel: recipe_panel - panel that contains all recipes that are available for the magic stick.

Each GUI contains functions that is supported only by itself.

The PREVIOUS and NEXT button types allows creating automatic paging, when you have more sticks or recipes than spaces in GUI. These types have extra parameters under data:

• indexing - indicates if button will show page number.

Example:

    icon: TIPPED_ARROW:INSTANT_HEAL::::1
    title: cauldron-witchery.gui.buttons.previous.name
    description: cauldron-witchery.gui.buttons.previous.description
    data:
      type: PREVIOUS
      indexing: true
    action:
      left:
        tooltip: cauldron-witchery.gui.tips.click-to-previous

The RETURN button type is available in recipe_panel. It allows returning to the sticks panel.

Example:

    icon: OAK_DOOR
    title: cauldron-witchery.gui.buttons.return.name
    description: cauldron-witchery.gui.buttons.return.description
    data:
      type: RETURN
    action:
      left:
        tooltip: cauldron-witchery.gui.tips.click-to-return

This button is available in stick_panel. The STICK button creates a dynamic entry for a magic stick. Button will be filled only if there exist a magic stick. F.e. if you have only 3 magic sticks, but defined 7 spots for them in the GUI, then only 3 spots will be filled. Other spots will be left empty.

By default sticks will be ordered by their order numbers, however, you can specify a specific stick to be in a specific slot with id parameter under data.

  data:
    type: STICK
    id: example_stick

Specifying title, description and icon will overwrite dynammic generation based on database data. By default these values will be generated from database entries. This button supports 2 different action types:

• RECIPES - opens a recipe view panel
• PURCHASE - purchases or gives the magic stick for a player.

Example:

  data:
    type: STICK
  actions:
    left:
      type: RECIPES
      tooltip: cauldron-witchery.gui.tips.left-click-to-view
    right:
      type: PURCHASE
      tooltip: cauldron-witchery.gui.tips.right-click-to-buy

This button is available in recipe_panel. The RECIPE button creates a dynamic entry for a recipe. Button will be filled only if there exist a recipe. F.e. if you have only 3 recipes, but defined 7 spots for level in the GUI, then only 3 spots will be filled. Other spots will be left empty.

By default recipes will be ordered by their order number and then by their reward item name. Specifying title, description and icon will overwrite dynammic generation based on database data. By default these values will be generated from database entries.

Example:

  data:
    type: RECIPE

All recipes require 3 things:

• Magic Stick in the player main hand
• Main Ingredient in the player offhand
• Extra Ingredients

Extra Ingredients must be dropped into cauldron or kept in inventory. This depends on addon config option: mix-in-cauldron. If option is disabled, then items must be in player inventory.

If nothing is missing, recipe will work.

Yes, as long as Spigot supports them. However, you will not be able to do it via template file. Only Admin GUI supports custom item adding.

Players can buy magic sticks using /[player_cmd] witchery command.

Admins can also create their own way how to distribute sticks. There is an admin command to generate them:

/[admin_cmd] witchery get stick <stick_id>

The main ingredient is always the "last" item player needs to have for recipe. It is always an item in player offhand.

Extra ingredients are items that must be either in player inventory or dropped into cauldron (depending on config).

If mix-in-cauldron option is enabled in addon settings, then no items will burn in lava cauldron and they will not despawn. It is necessary for addon operation, as there can be recipes that requires lava cauldron. These recipes would not be possible to fulfill if items were burning off. Item depsawning inside cauldron is disabled just as protective measure.

Yes, you can limit which user groups can use the sticks using Island Protection Flags. CauldronWitchery adds CAULDRON_WITCHERY_ISLAND_PROTECTION which can be toggled from island visitor till owner.

Users outside member group will not be able to use magic sticks on island.

Please add it to the list here.