Getting started

IMPORTANT: if you plan to use the API for a plugin for Minecraft 1.7-1.13, please follow the getting started guide for HeadsPluginAPI 1.9 and older.

---

API dependency

If you want to use the API in your own plugin, you can import the following dependency into your maven project:

<!-- HeadsPlugin API -->
<dependency>
    <groupId>com.github.CC007</groupId>
    <artifactId>headsplugin-api</artifactId>
    <version>3.0.0</version>
    <scope>provided</scope>
</dependency>

Repository

To use this dependency, you need to add the following repository to your maven project:

<repositories>
    <repository>
        <id>hpa</id>
        <url>https://maven.pkg.github.com/CC007/HeadsPluginAPI</url>
    </repository>
</repositories>

Be sure to follow this guide to be able to connect to that repository.

---

Javadoc

To get a better description of what all the functions in the API do, you an attach a javadoc file to the HeadsPluginAPI library/dependency. You can find the Javadoc file here.

If you want to look at the javadoc yourself, you can find it here: https://cc007.github.io/HeadsPluginAPI/v3.3.0/apidocs/