🆕Custom Addons

On this page you will have the information to create addons for our Plugins

Custom Addons

Custom Addons are extensions that allow users to extend, modify, or enhance the functionality of our plugin. Think of them as building blocks that enable you to tailor the behavior of the plugin, making it uniquely yours.

Maven Dependency

<repositories>
  <repository>
    <id>nexus</id>
    <url>https://repo.myphoenixstore.com/repository/maven-public/</url>
  </repository>
</repositories>

<dependency>
  <groupId>com.phoenixplugins.sdk</groupId>
  <artifactId>api</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

Addon.yml File:

• To begin customizing your plugin experience, ensure you have an "addon.yml" file in the resources of your Java project.

• Open the "addon.yml" file and configure it according to your addon's specifications.

name: AddonName
main: your.path.AddonExample
author: [YourName]
version: 1.0
description: Small Description (Optional)
website: Website (Optional)

The "addon.yml" file serves as the configuration hub for your Custom Addon, providing essential metadata such as the addon's name, main class path, author details, version, and optional description and website information.

Main Class:

• Ensure that the specified main class in the "addon.yml" file corresponds to the path of your addon class within your project.

package your.path;

import java.io.IOException;
import com.phoenixplugins.sdk.addons.Addon;

public class AddonExample extends Addon {

  public AddonExample() {
    // Your code here
  }

  @Override
  public void onLoad() {
    // Your code here
  }

  @Override
  public void onEnable() {
    // Your code here
  }

  @Override
  public void onDisable() {
    // Your code here
  }

  @Override
  public String getRequiredPluginVersion() {
    return "2.1.4"; // Define the main required version 
  }
}

Compile your Addon:

• Compile your Custom Addon following your Java project's build instructions.

Install your Addon:

• Move the compiled JAR file to the "addons" folder within the "PhoenixCrates" directory in your server plugins.

• Restart the server to apply changes and activate your Custom Addon.