🔧 Custom Addons

Custom Addons are extensions that allow you to extend, modify, or enhance Phoenix Crates behavior with your own Java code.

#Before You Start

1. Add the API dependency from the API page.
2. Create your addon project (Maven or Gradle).
3. Make sure your final artifact is a shaded or standalone JAR when needed.

#addon.yml

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

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.

package your.path;

import com.phoenixplugins.sdk.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

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

#Next Step

After your addon loads correctly, continue with 🎞️ Custom Animations to register your own crate animation phases.