UltimateAdvancementAPI

A powerful API to create custom advancements for your Minecraft server, forked here with NMS variants for Minecraft 1.21.5, 1.21.11 and 26.x.

---

About

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

This repository is a fork of frengor's UltimateAdvancementAPI, whose authors are frengor and EscanorTargaryen. The fork keeps the older 1.21.x NMS layers and carries the 1.21.5 (v1_21_R4), 1.21.11 (v1_21_R7) and 26.x (v26_1_R2, v26_2_R1, v26_3_R1) variants used by this server family. It follows the upstream license, LGPL-3.0-or-later.

The links below point at the upstream project, not at this fork; the fork does not run its own CI, Javadoc or wiki.

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://escanortargaryen.dev/UltimateAdvancementGenerator/
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.0</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.

Automatic advancement layout

Pass true when registering a tab to calculate vanilla-style tree coordinates from each advancement's parent relationship:

tab.registerAdvancements(root, true, advancements);
// Set overload:
tab.registerAdvancements(root, advancementsSet, true);

The existing overloads keep the coordinates supplied through AdvancementDisplay.

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, please use the formatting style settings present under .idea/codeStyles folder.

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.

This repository is a fork of frengor/UltimateAdvancementAPI and inherits its LGPL-3.0-or-later terms. The LICENSE file holds the full GPL-3.0 text and COPYING.LESSER the LGPL-3.0 additional permissions, which together make up LGPL-3.0; the LGPL file is the same LGPL text under its short name.

Credits

This repository is a fork of UltimateAdvancementAPI, originally by frengor together with EscanorTargaryen. The fork adds the 1.21.5 / 1.21.11 / 26.x NMS variants and follows the upstream license, LGPL-3.0-or-later.

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