arcaniax-development / headdatabase-api

API for the famous HeadDatabase plugin

---

Head Database is a fast and user-friendly plugin that allows you to obtain thousands of custom Minecraft skulls that feature unique designs. This easy-to-use heads plugin gives you access to creative designing opportunities that overall enhances the quality of your builds, and gives creative freedom to yourself and your players.

This is the API repository for HeadDatabase. This is not HeadDatabase. If you are looking for the plugin HeadDatabase, get it from spigot.

Links

• Discord
• Issues
• JavaDocs

How to use the API

Releases are published to the central repository, snapshots are published to S01 OSS Sonatype.

Gradle

repositories {
    mavenCentral()
}

dependencies {
    compileOnly("com.arcaniax:HeadDatabase-API:1.3.2")
}

Maven

<!-- HeadDatabase-API -->
<dependency>
    <groupId>com.arcaniax</groupId>
    <artifactId>HeadDatabase-API</artifactId>
    <version>1.3.2</version>
    <scope>provided</scope>
</dependency>

Building

Gradle is the recommended way to build the project. Use ./gradlew build in the main project directory to build the project.

Suggestions

Suggestions are welcome! We have a separate issue form for suggestions, that can be found here.

Example usage

import me.arcaniax.hdb.api.DatabaseLoadEvent;
import me.arcaniax.hdb.api.HeadDatabaseAPI;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.inventory.ItemStack;
import org.bukkit.plugin.java.JavaPlugin;

public class HeadDatabaseAPIPlugin extends JavaPlugin implements Listener {

    public void onEnable() {
        this.getServer().getPluginManager().registerEvents(this, this);
    }

    @EventHandler
    public void onDatabaseLoad(DatabaseLoadEvent e) {
        HeadDatabaseAPI api = new HeadDatabaseAPI();
        try {
            ItemStack item = api.getItemHead("7129");
            getLogger().info(api.getItemID(item));
        } catch (NullPointerException nullPointerException) {
            getLogger().info("Could not find the head you were looking for");
        }
    }
}

Tips:

• Don't forget to add HeadDatabase to depend or softdepend section of your plugin.yml
• Listen to DatabaseLoadEvent and register your events afterwards. The event is fired once HeadDatabase is loaded successfully.