CoreAPI

CoreAPI: The Swiss Army tool for PocketMine plugins. CoreAPI is a utility plugin that provides a set of APIs for PocketMine-MP plugin developers. It aims to simplify common tasks and provide a consistent way to implement features across plugins.

Example Plugins

• https://github.com/DerCooleVonDem/Calendar
• https://github.com/DerCooleVonDem/CoreApiExample

Features

Command System

The command system provides a simple and flexible way to create commands with subcommands. It includes:

• NEW: Fluent CommandBuilder and SubCommandBuilder for easy command creation
• IMPROVED: Better error messages with suggestions and available commands
• A base command class that handles subcommand routing
• A subcommand class that handles command execution
• A command manager that handles command registration

For more information, see the Command System Documentation.

Manager System

The manager system provides a simple and flexible way to create managers for collections of objects. It includes:

• NEW: Generic TypedManager<T> for type-safe manager implementations
• IMPROVED: Optional persistence methods with default implementations
• A manageable interface that objects must implement to be managed
• A base manager class that provides common functionality for managers

For more information, see the Manager System Documentation.

Player Session API

The Player Session API provides a way to manage player-specific data and functionality through components. It includes:

• NEW: Factory pattern for component creation (no more cloning confusion)
• IMPROVED: Proper event listener registration scope
• Automatic session creation and cleanup when players join and leave
• Component-based architecture for modular functionality
• Components are automatically registered as event listeners
• Easy access to the player from any component

For more information, see the Player Session API Documentation.

Form API

The Form API provides a clean and modern way to create and manage forms in PocketMine-MP. It includes:

• NEW: Type-safe ModalForm, SimpleForm, and CustomForm classes
• IMPROVED: Clear image handling with ImageType enum
• IMPROVED: Better callback composition with button-specific callbacks
• Support for all form types: modal, simple, and custom
• A fluent interface for creating and configuring forms
• Automatic validation of form responses
• Convenient helper methods for common form types

For more information, see the Form API Documentation.

Scoreboard API

The Scoreboard API provides a comprehensive system for managing and displaying scoreboards to players. It includes:

• NEW: Automatic display system - scoreboards show to new players based on priority
• NEW: Form-based management interface with intuitive UI
• NEW: Command-line interface for power users
• NEW: Real-time updates with configurable intervals
• Multi-plugin support with priority-based display
• Dynamic tag system for live content replacement
• Session integration for per-player scoreboard management
• Factory pattern for easy scoreboard creation

For more information, see the Scoreboard API Documentation.

Custom Item System

The Custom Item System provides a comprehensive solution for creating and managing custom items with NBT data and metadata. It includes:

• NEW: Complete custom item creation with NBT data support
• NEW: Registry system with persistent storage and validation
• NEW: Command interface for CLI management (/customitem)
• NEW: Import/export functionality for sharing configurations
• Type-safe custom item management following CoreAPI patterns
• Namespace support to avoid conflicts between plugins
• Player interaction methods (give items, check items)
• Category-based organization and filtering

For more information, see the Custom Item System Documentation.

NPC API

The NPC API provides a simple and powerful way to create and manage NPCs (Non-Player Characters) in your server. It includes:

• NEW: Easy NPC creation and management with persistent storage
• NEW: Standalone NPC system with no external dependencies
• NEW: Look-at-player functionality with customizable distance
• NEW: Event-based interaction system for player clicks
• Extensible base class for creating custom NPC types
• Data storage system for NPC-specific information
• Configuration options for NPC behavior and appearance

For more information, see the NPC API Documentation.

Closure Event API

The Closure Event API provides a lightweight and flexible event system using closures. It includes:

• NEW: Simple event registration and triggering
• NEW: Closure-based event handlers for maximum flexibility
• NEW: Unique handler IDs for easy management
• NEW: Results collection from all handlers
• Namespace support to avoid conflicts between plugins
• Easy integration with existing code
• Minimal overhead compared to traditional event listeners

For more information, see the Closure Event API Documentation.

Installation

1. Download the latest release from the Releases page
2. Place the plugin in your server's plugins directory
3. Restart your server

Usage

To use CoreAPI in your plugin, add it as a dependency in your plugin.yml:

depend: [CoreAPI]

Then, in your plugin code, you can access the CoreAPI instance:

use JonasWindmann\CoreAPI\CoreAPI;

$coreAPI = CoreAPI::getInstance();

Quick Start Examples

Creating Commands (New Fluent API)

use JonasWindmann\CoreAPI\command\CommandBuilder;
use JonasWindmann\CoreAPI\command\SubCommandBuilder;

// Create a command with fluent interface
CommandBuilder::create("mycommand")
    ->description("My awesome command")
    ->aliases("mc", "mycmd")
    ->subCommands(
        SubCommandBuilder::create("hello")
            ->description("Say hello")
            ->executes(function($sender, $args) {
                $sender->sendMessage("Hello!");
            })
            ->build()
    )
    ->build(); // Automatically registered!

Creating Forms (New Type-Safe API)

use JonasWindmann\CoreAPI\form\ModalForm;
use JonasWindmann\CoreAPI\form\SimpleForm;

// Type-safe modal form
$modal = new ModalForm("Confirm", "Are you sure?", "Yes", "No",
    function($player, $response) {
        $player->sendMessage($response ? "Confirmed!" : "Cancelled");
    });

// Type-safe simple form with clear image handling
$simple = new SimpleForm("Menu", "Choose an option:")
    ->buttonWithImage("Teleport", "textures/ui/teleport.png")
    ->button("Settings", null, function($player) {
        $player->sendMessage("Opening settings...");
    });

Session Components (New Factory Pattern)

use JonasWindmann\CoreAPI\session\SimpleComponentFactory;

$sessionManager = CoreAPI::getInstance()->getSessionManager();
$sessionManager->registerComponentFactory(
    SimpleComponentFactory::createFactory("mycomponent", function() {
        return new MyComponent();
    })
);

Scoreboards (New Automatic System)

use JonasWindmann\CoreAPI\scoreboard\factory\ScoreboardFactory;

// Create a scoreboard that automatically displays to new players
$scoreboard = ScoreboardFactory::createServerInfo(
    "server_info",
    "§6My Server",
    "MyPlugin",
    true // Auto-display enabled
);

$scoreboard->setPriority(100); // High priority = shows by default
CoreAPI::getInstance()->getScoreboardManager()->registerScoreboard($scoreboard);

// Players can manage scoreboards with: /coresb manage

Custom Items (New System)

use JonasWindmann\CoreAPI\CoreAPI;
use pocketmine\item\VanillaItems;

$customItemManager = CoreAPI::getInstance()->getCustomItemManager();

// Create and register a custom item
$customItem = $customItemManager->createAndRegisterCustomItem(
    "magic_sword",           // Unique ID
    "§cMagic Sword",        // Display name
    "weapon",               // Category
    VanillaItems::IRON_SWORD(), // Base item
    [                       // Custom NBT data
        "damage" => "15",
        "element" => "fire"
    ],
    [                       // Lore
        "§7A powerful magical weapon",
        "§7Deals extra fire damage"
    ]
);

// Give to player
$customItemManager->giveCustomItem($player, "magic_sword", 1);

// Check if item is custom
if ($customItemManager->isCustomItem($item)) {
    $customId = $customItemManager->getCustomItemId($item);
    $damage = $customItemManager->getCustomData($item, "damage");
}

// Command interface: /customitem create magic_wand "§bMagic Wand" tool minecraft:stick

NPCs (New API)

use JonasWindmann\CoreAPI\CoreAPI;
use JonasWindmann\CoreAPI\npc\CoreNpc;
use pocketmine\player\Player;

// Create a custom NPC type
class GreeterNpc extends CoreNpc {
    protected function initNpc(): void {
        $this->setNpcName("§aGreeter");
        $this->lookDistance = 10.0; // Look at players up to 10 blocks away
    }

    public function onClick(Player $player): void {
        $player->sendMessage("§aHello, " . $player->getName() . "!");
    }
}

// Register the NPC type
$npcManager = CoreAPI::getInstance()->getNpcManager();
$npcManager->registerNpcType(GreeterNpc::class);

// Create an NPC at a player's location
$npc = $npcManager->createNpc("GreeterNpc", $player, [
    "message" => "Welcome to our server!"
]);

// Remove an NPC
$npcManager->removeNpc($npc->getId());

// Get all active NPCs
$npcs = $npcManager->getActiveNpcs();

Closure Events (New API)

use JonasWindmann\CoreAPI\CoreAPI;

$eventManager = CoreAPI::getInstance()->getEventManager();

// Register a new event
$eventManager->registerEvent("my_plugin.player_action");

// Register a handler for the event
$handlerId = $eventManager->registerHandler("my_plugin.player_action", function($player, $action) {
    $player->sendMessage("You performed action: $action");
    return true;
});

// Trigger the event with parameters
$results = $eventManager->triggerEvent("my_plugin.player_action", $player, "jump");

// Check if an event has handlers
if ($eventManager->hasHandlers("my_plugin.player_action")) {
    // Event has at least one handler
}

// Unregister a handler when no longer needed
$eventManager->unregisterHandler("my_plugin.player_action", $handlerId);

// Unregister an event completely
$eventManager->unregisterEvent("my_plugin.player_action");

License

This plugin is licensed under the MIT License. See the LICENSE file for more information.