UltimateAdvancementAPI

A powerful API to create custom advancements for your Minecraft server.

Important

3.0.0 Beta is available on the main-3.0.0 branch. Download the beta from Modrinth on Hangar (links below).
The Javadoc for the beta is published here.

Modrinth Page: https://modrinth.com/plugin/ultimateadvancementapi
Spigot Page: https://www.spigotmc.org/resources/95585/
Hangar Page: https://hangar.papermc.io/DevHeim/UltimateAdvancementAPI
UltimateAdvancementGenerator: https://generator.devheim.space
Discord: https://discord.gg/BMg6VJk5n3
Official Wiki: https://github.com/frengor/UltimateAdvancementAPI/wiki/
Javadoc: https://frengor.com/javadocs/UltimateAdvancementAPI/latest/
Jenkins: https://jenkins.frengor.com/job/UltimateAdvancementAPI/

Get it with maven:

<repositories>
    <repository>
        <id>fren_gor</id>
        <url>https://nexus.frengor.com/repository/public/</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.frengor</groupId>
    <artifactId>ultimateadvancementapi</artifactId>
    <version>2.8.1</version>
    <scope>provided</scope>
</dependency>

Example Plugin:

An example of plugin using UltimateAdvancementAPI can be found here.

More examples by the community can be found in the showcase forum on Discord.

Test Plugin:

The plugin used for tests can be found here.

Contributing

Feel free to open issues or pull requests. Feature requests can be done opening an issue, the enhancement tag will be applied by maintainers.

For pull requests, open them towards the dev branch, as the main branch is only for releases. Make sure to allow edits by maintainers. Also, if possible please use the formatting style settings present in the .editorconfig file. If you are using an IDE like IntelliJ, they should be picked up automatically. Otherwise, try to manually keep the style as consistent as possible in regard to the surrounding code.

Required Java version

Currently, the project is compiled for Java 16, although the minimum required Java version might change in future releases.

We consider changing the minimum required Java version a breaking change, so DO NOT expect it to be frequently modified.

In order to compile the code you must be using (at least) the Java version required by the last Minecraft version, since the project uses NMS.

License

This project is licensed under the GNU Lesser General Public License v3.0 or later.

Credits

UltimateAdvancementAPI has been made by fren_gor and EscanorTargaryen.
The API uses the following libraries:

• EventManagerAPI (released under Apache-2.0 license) to handle events
• Libby (released under MIT license) to handle dependencies at runtime
• CommandAPI (released under MIT license) to add commands to the plugin version of the API
• HikariCP (released under Apache-2.0 license) to connect to MySQL databases
• Config-Updater (released under MIT license) to update the configuration in the plugin version of the API
• bStats (the Java library is released under MIT license) to collect usage data (which can be found here) about the plugin version of the API