push:

- uses: actions/checkout@v4

- name: Setup Java JDK

uses: actions/setup-java@v4.2.1

with:

java-version: 21

distribution: temurin

javadoc-branch: javadoc

target-folder: docs/javadoc

project: maven

If you'd like to make a config **without** having a template file in your resources folder (configs created at-runtime with changing filenames), use a `CaramelBlankConfig` instead of a `CaramelConfig` class!

First, make a variable for it:

CaramelConfig coolConfig;

Then in your onEnable, initialize it:

coolConfig = new CaramelConfig(this, "coolest-config.yml");

coolConfig.saveDefaultConfig();

And use it:

coolConfig.getData() // returns a FileConfiguration

coolConfig.getData().getString("my.path");

coolConfig.getData().setString("my.path", "Setting!");

The documentation for items are WIP, but here's a simple implementation while you wait:

public class MyItem implements CaramelItem {

@Override

public CaramelItemDetail getDetails() {

return CaramelItemDetail.builder()

.id("item_identifier") // Required

.defaultStack(1) // Required

.modelData(0) // Optional - Custom Model Data

.itemBase(Material.PAPER) // Required

.itemName(CaramelUtility.colorcomp("<gold><bold>Supports miniMessage")) // Required

.lore(Arrays.asList("Lore <red>is cool<yellow>!")) // Required

.build();

}

@Override

public ItemStack modifyBeforeFinalizing(ItemStack item) {

// You can add custom modifications (attributes) here.

// Return the item back to keep it the same.

return item;

}

@Override

public void onItemUse(ClickType type, ItemStack item, PlayerInteractEvent event) {

// Handle interactions here.

// ClickType is a dev.klash.caramel.items, not bukkit.

event.getPlayer().sendMessage(CaramelUtility.colorcomp("Hello!"));

}

}

Please see Commands for registering, but use `Caramel.getInstance().items` and define it as a `CaramelItem`.

First, get started by making a new class for your recipe, and implementing all the methods:

public class MyFirstRecipe extends CaramelRecipe {

public ItemStack getResult() {return ...;};

public CaramelRecipeDetail getDetails() {return ...;};

public NamespacedKey getKey() {return ...;};

}

Result needs to be an ItemStack to return as the output.

Key needs to be a NamespacedKey with your Plugin/Identifier and the recipe's identifier.

The details are where we define the actual recipe:

CaramelRecipeDetail.of(

new CaramelRecipeValue[] {},

new String[] {

" ",

" ",

" "

}

);

The array of values are your mappings for your pattern. See the values section below.

The array of strings is your pattern, and should be 3x tripple-letter strings.

<br/><br/>

A recipe value is a mapping of character <--> an itemstack or material to be used in the crafting grid.

You can create these by the `CaramelRecipeValueItem` and `CaramelRecipeValueMaterial` constructors:

new CaramelRecipeValueMaterial('D', Material.DIAMOND)

new CaramelRecipeValueItem('D', new ItemStack(Material.DIAMOND))

<br/><br/>

Recipes are registered through RecipeLists. You can create these directly from the instance of Caramel:

CaramelRecipeList myRecipes;

recipeList = Caramel.createRecipeList(

myFirstRecipe,

mySecondRecipe

);

recipeList.registerAll();

recipeList.cleanup();