Skip to content

Latest commit

 

History

History
59 lines (50 loc) · 2.64 KB

README.md

File metadata and controls

59 lines (50 loc) · 2.64 KB
Raw

CrazyAdvancementsAPI - Standalone Edition

This is a fork of the CrazyAdvancementsAPI by ZockerAxel that has been made Maven compatible. This means that the API can now be used with Maven and as a standalone dependency that can be bundled with your plugin. This way there is no need for the server to also have the CrazyAdvancementsAPI plugin.

Usage

The version of this API that you should use depends on the minecraft version your server/plugin is on. See the chart below.

Minecraft version API/dependency version
1.16.4 1.14.1
1.16.3 1.13.10
1.16.2 1.13.9
1.16.1 1.13.8
1.15.x 1.13.7

Add the dependency to your pom.xml

<dependency>
    <groupId>com.github.jely2002</groupId>
    <artifactId>StandaloneCrazyAdvancementsAPI</artifactId>
    <version>1.13.11</version>
</dependency>

Add the repository to your pom.xml

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

How to initialize the API

In order to initialize/disable the 'StandaloneCrazyAdvancementsAPI' you need to include the following code in your onEnable() and onDisable() methods. The rest of the process is almost the same as the original API.

Example onEnable() & onDisable() methods:

@Override
public void onEnable() {
   //Initializes the API. Requires the JavaPlugin the API gets used from.
  CrazyAdvancements advancementsAPI = new CrazyAdvancements(this);
  
  //Create a new advancementManager as per the original documentation
  AdvancementManager advancementManager = new AdvancementManager(Player... players)
}

@Override
public void onDisable() {
  //Disable the API
  advancementsAPI.disable();
}

How does the API work?

For more info on how you may use this API please take a look at the original documentation. There are also javadocs available, but please keep in mind the changes this Maven edition brings with.

Credits

I would like to thank ZockerAxel for writing the API this Maven edition is based on. This project has been made according to the GPL-3.0 license bundled with the original code. All changes can be seen through 'commits'.