Build your own Phoenix Crates add-on

Setup

Maven, exactly as documented on API:

XML

<repositories>
	<repository>
		<id>phoenixplugins</id>
		<url>https://repo.phoenixplugins.com/</url>
	</repository>
</repositories>

XML

<dependency>
	<groupId>com.phoenixplugins.phoenixcrates</groupId>
	<artifactId>api</artifactId>
	<version>1.0.0-SNAPSHOT</version>
</dependency>

Gradle

The docs only show Maven snippets; no Gradle snippet is documented yet. Dependency details: see API.

Add-on structure

addon.yml

Create an addon.yml file in your project's resources folder.

YAML

name: AddonName
main: your.path.AddonExample
author: [YourName]
version: 1.0.0
description: Small description (optional)
website: https://your-website.com (optional)

Required fields:

name: Display name of your addon.
main: Fully qualified path to your addon main class.
author: One or more addon authors.
version: Addon version.

Main Class Example

The main value in addon.yml must point to your class that extends Addon.

JAVA

package your.path;

import com.phoenixplugins.phoenixcrates.api.sdk.plugin.addons.Addon;

public class AddonExample extends Addon {

	@Override
	public void onLoad() {
		// Called when the addon is loaded.
	}

	@Override
	public void onEnable() {
		// Register listeners, commands, tasks, etc.
	}

	@Override
	public void onDisable() {
		// Cleanup logic.
	}

	@Override
	public String getRequiredPluginVersion() {
		return "5.0.0";
	}
}

Build and Install

Build your addon JAR with your normal project build command.
Move the compiled JAR into plugins/PhoenixCrates/addons.
Restart the server.
Check console logs to confirm the addon was loaded successfully.

Source: Custom Addons.

Events

11 documented events, from Events. All are Bukkit events, listened to with @EventHandler.

Event	Fires when	Cancellable	Reference
`CratePlaceEvent`	A player places a crate item in the world	Yes	Docs · Javadoc
`CratePreviewOpenEvent`	The rewards preview menu is about to open	Yes	Docs · Javadoc
`CratePreOpenEvent`	An opening has been requested, before any check runs	Yes	Docs · Javadoc
`CrateOpenEvent`	The opening has started	No	Docs · Javadoc
`CrateRewardSelectionEvent`	A random crate is choosing which reward to award	No	Docs · Javadoc
`CrateSelectiveConfirmEvent`	A player confirms a reward in Selective mode	Yes	Docs · Javadoc
`CratePreRerollEvent`	A reroll has been requested	Yes	Docs · Javadoc
`CrateRerollEvent`	A reroll has produced a new reward	No	Docs · Javadoc
`CrateRewardWinItemsEvent`	The item list for a win has been built, before it is given	No	Docs · Javadoc
`CrateRewardPlayerEvent`	A player has been awarded a reward	No	Docs · Javadoc
`ItemDeliveryEvent`	Items are about to be delivered to a player	No	Docs · Javadoc

Also in the javadoc, not yet described in the docs: RewardCommandsEvent.

Complete example

Validate opening attempts before they start, verbatim from Examples:

JAVA

import com.phoenixplugins.phoenixcrates.api.crate.events.CratePreOpenEvent;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;

public final class OpenGuardListener implements Listener {

    @EventHandler
    public void onPreOpen(CratePreOpenEvent event) {
        if (!event.getPlayer().hasPermission("myaddon.open")) {
            event.setCancelled(true);
            event.getPlayer().sendMessage("You cannot open this crate right now.");
        }
    }
}

Registering a listener

The docs don't show listener registration inside an add-on yet.

More examples: Examples.

Configuration

Example Crate, verbatim from Crate Configuration File: