https://github.com/frengor/UltimateAdvancementAPI

A powerful API to create custom advancements for your Minecraft server.
https://github.com/frengor/UltimateAdvancementAPI

advancement advancements api bukkit java minecraft plugin plugins spigot spigot-plugin

Last synced: 3 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/frengor/UltimateAdvancementAPI
• Owner: frengor
• License: gpl-3.0
• Created: 2021-06-04T20:32:34.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2025-12-27T01:01:00.000Z (about 2 months ago)
• Last Synced: 2025-12-27T10:39:49.075Z (about 2 months ago)
• Topics: advancement, advancements, api, bukkit, java, minecraft, plugin, plugins, spigot, spigot-plugin
• Language: Java
• Homepage: https://modrinth.com/plugin/ultimateadvancementapi
• Size: 2.32 MB
• Stars: 130
• Watchers: 2
• Forks: 19
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Notice: NOTICE

Awesome Lists containing this project

• awesome - frengor/UltimateAdvancementAPI - A powerful API to create custom advancements for your Minecraft server. (Java)

README

          
# UltimateAdvancementAPI

[![Build Status main Branch](https://jenkins.frengor.com/job/UltimateAdvancementAPI/job/main/badge/icon?subject=main&style=flat)](https://jenkins.frengor.com/job/UltimateAdvancementAPI/job/main/)

[![Build Status dev Branch](https://jenkins.frengor.com/job/UltimateAdvancementAPI/job/dev/badge/icon?subject=dev&style=flat)](https://jenkins.frengor.com/job/UltimateAdvancementAPI/job/dev/)

[![License](https://img.shields.io/badge/license-LGPL--3.0-orange?style=flat)](https://github.com/frengor/UltimateAdvancementAPI/blob/main/LGPL)

[![Version](https://img.shields.io/badge/version-2.7.2-blue?style=flat&color=007ec6)](https://jenkins.frengor.com/job/UltimateAdvancementAPI/)

[![Issues](https://img.shields.io/github/issues/frengor/UltimateAdvancementAPI?style=flat)](https://github.com/frengor/UltimateAdvancementAPI/issues)

[![Stars](https://img.shields.io/github/stars/frengor/UltimateAdvancementAPI?style=flat)](https://github.com/frengor/UltimateAdvancementAPI/stargazers)

[![Forks](https://img.shields.io/github/forks/frengor/UltimateAdvancementAPI?style=flat)](https://github.com/frengor/UltimateAdvancementAPI/network)

[![Contributors](https://img.shields.io/github/contributors/frengor/UltimateAdvancementAPI?style=flat)](https://github.com/frengor/UltimateAdvancementAPI/graphs/contributors)

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

![Advancement Tab Image](https://github.com/frengor/UltimateAdvancementAPI/wiki/images/spigot-photo.png)

> [!IMPORTANT]

> **3.0.0 Beta** is available on the [`main-3.0.0` branch](https://github.com/frengor/UltimateAdvancementAPI/tree/main-3.0.0). Download the beta from Modrinth on Hangar (links below).  

> The Javadoc for the beta is published [here](https://frengor.com/javadocs/UltimateAdvancementAPI/3.0.0-beta-1/).

**Modrinth Page:**   

**Spigot Page:**   

**Hangar Page:**   

**UltimateAdvancementGenerator:**   

**Discord:**   

**Official Wiki:**   

**Javadoc:**   

**Jenkins:** 

**Get it with maven:**

```xml

    

        fren_gor

        https://nexus.frengor.com/repository/public/

    

```   

```xml

    com.frengor

    ultimateadvancementapi

    2.7.2

    provided

```

#### Example Plugin:

An example of plugin using UltimateAdvancementAPI can be found [here](https://github.com/DevHeim-space/UltimateAdvancementAPI-Showcase).

More examples by the community can be found in the `showcase` forum on [Discord](https://discord.gg/BMg6VJk5n3).

#### Test Plugin:

The plugin used for tests can be found [here](https://github.com/frengor/UltimateAdvancementAPI-Tests).

## 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](https://www.gnu.org/licenses/lgpl-3.0.txt).

## Credits

UltimateAdvancementAPI has been made by [fren_gor](https://github.com/frengor) and [EscanorTargaryen](https://github.com/EscanorTargaryen).  

The API uses the following libraries:

  * [EventManagerAPI](https://github.com/frengor/EventManagerAPI) (released under Apache-2.0 license) to handle events

  * [Libby](https://github.com/AlessioDP/libby) (released under MIT license) to handle dependencies at runtime

  * [CommandAPI](https://github.com/CommandAPI/CommandAPI) (released under MIT license) to add commands to the plugin version of the API

  * [HikariCP](https://github.com/brettwooldridge/HikariCP) (released under Apache-2.0 license) to connect to MySQL databases

  * [Config-Updater](https://github.com/tchristofferson/Config-Updater) (released under MIT license) to update the configuration in the plugin version of the API

  * [bStats](https://bstats.org/) (the Java library is released under MIT license) to collect usage data (which can be found [here](https://bstats.org/plugin/bukkit/UltimateAdvancementAPI/12593)) about the plugin version of the API