Developer API

Phantom Dungeons internal APIs are coded using Singleton Pattern design, allowing developers to easily integrate into our core.

Internal APIs can change in future versions, so be aware when you are using methods marked as deprecated.

---

Overview

PhantomDungeons provides public APIs for external plugin integrations.

---

Available APIs

Economy API

Multi-currency system with async operations and automatic booster integration.

Quick Example:

EconomyAPI economy = EconomyAPI.get();

if (economy.hasBalance(player, "money", 1000)) {
    economy.removeBalance(player, "money", 1000)
        .thenAccept(newBalance -> {
            player.sendMessage("Purchase complete");
        });
}

Read Full Economy API Guide

---

Boosters API

Multiplier system supporting both temporary and permanent boosters.

Quick Example:

BoostersAPI boosters = BoostersAPI.get();

boosters.giveBooster(player, "money", 1.5, 3600)
    .thenAccept(success -> {
        if (success) {
            player.sendMessage("1.5x money booster activated for 1 hour");
        }
    });

Read Full Boosters API Guide

---

Getting Started

Step 1: Add Dependency

Update your plugin.yml:

name: MyPlugin
version: 1.0
main: com.example.MyPlugin
description: cool

depend:
  - PhantomDungeons

Step 2: Maven Dependency

PhantomDungeons does not have a central maven repository, so you will have to manually add the PhantomDungeons.x.x.x jar as a system dependency, as shown below.

When you have added it as a system dependency, you need to reload your pom to register it. You can do this by doing CTRL+SHIFT+O for windows machines only.

<dependencies>
    <dependency>
        <groupId>phantomdungeons</groupId>
        <artifactId>phantomdungeons-api</artifactId>
        <version>1.0.0</version>
        <scope>system</scope>
        <systemPath>${YOUR_PATH_TO_JAR}</systemPath>
    </dependency>
</dependencies>

Step 2: Hook the APIs

import me.fergs.phantomdungeons.modules.economy.api.EconomyAPI;
import me.fergs.phantomdungeons.modules.boosters.api.BoostersAPI;

public class MyPlugin extends JavaPlugin {
    private EconomyAPI economy;
    private BoostersAPI boosters;
    
    @Override
    public void onEnable() {
        try {
            this.economy = EconomyAPI.get();
            this.boosters = BoostersAPI.get();
            getLogger().info("PhantomDungeons APIs hooked");
        } catch (IllegalStateException e) {
            getLogger().severe("PhantomDungeons not loaded");
            Bukkit.getPluginManager().disablePlugin(this);
        }
    }
}

---

---

PhantomDungeons Official API Documentation v1.0 | Last Updated: January 2026