Skip to content

Overview

SkyblockCore exposes a clean API so other plugins and modules can read and modify islands. The core is published through JitPack.

Adding the Dependency

The core runs as its own plugin on the server, so you compile against it but don't bundle it — use compileOnly / provided.

repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    // A release tag, or 'main-SNAPSHOT' for the latest commit on main.
    compileOnly 'com.github.Dsngxddd:SkyblockCore:0.4.0'
}

<repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
</repository>

<dependency>
    <groupId>com.github.Dsngxddd</groupId>
    <artifactId>SkyblockCore</artifactId>
    <version>0.4.0</version>
    <scope>provided</scope>
</dependency>

What the API Gives You

Type Purpose
SkyblockPlugin Entry point: getIslandManager(), getRoleManager(), getEconomy(), getTopService(), getWarpService(), ...
Island / IslandManager Islands, members, roles, points, bank, warps
RoleData / RoleResolver Built-in and per-island custom roles
IslandCreateEvent / IslandDeleteEvent Bukkit events to listen for
SkyblockModule + ModuleContext Write a drop-in module

Getting the Plugin Instance

SkyblockPlugin core =
    (SkyblockPlugin) Bukkit.getPluginManager().getPlugin("Skyblock");

If you're writing a module, you instead receive the core through your ModuleContext in onLoad — no getPlugin lookup needed. See Writing a Module.

Example — Read and Modify an Island

Island island = core.getIslandManager().getByMember(player.getUniqueId());
if (island != null) {
    island.depositBank(1000);
    core.getIslandManager().saveAsync(island);
}

getByMember finds the island a player belongs to (as owner or member); there's also getByOwner and getIslandAt(Location) (an O(1) grid lookup).

Save your changes

Mutating an Island only changes it in memory. Call getIslandManager().saveAsync(island) to persist (and, on a network, broadcast the change over the proxy).

Next