Spigot library for displaying advancement banners
advance is...
- a library for displaying custom advancement banners
advance is not...
- a library for creating custom advancements in the advancements tab
- a library for creating custom advancements in general
advance is compatible with 1.16.5, 1.17 - 1.17.1, 1.18.2, 1.19 - 1.19.4 and 1.20 - 1.20.2.
Latest version: 1.3.2
Maven
<project>
<properties>
<!-- Replace with the latest version -->
<advance.version>1.3.2</advance.version>
</properties>
<dependencies>
<!-- General api module -->
<dependency>
<groupId>dev.cerus.advance</groupId>
<artifactId>api</artifactId>
<version>${advance.version}</version>
<scope>compile</scope>
</dependency>
<!-- Implementation for 1.16.5 -->
<!-- Only implement this if you need 1.16.5 support -->
<dependency>
<groupId>dev.cerus.advance</groupId>
<artifactId>api-16R3</artifactId>
<version>${advance.version}</version>
<scope>compile</scope>
</dependency>
<!-- Implementation for 1.17(.1) -->
<!-- Only implement this if you need 1.17(.1) support -->
<dependency>
<groupId>dev.cerus.advance</groupId>
<artifactId>api-17R1</artifactId>
<version>${advance.version}</version>
<scope>compile</scope>
</dependency>
<!-- ...other versions... -->
<!-- You can also add the "all-versions" module to shade all advance versions -->
<dependency>
<groupId>dev.cerus.advance</groupId>
<artifactId>all-versions</artifactId>
<version>${advance.version}</version>
<type>pom</type> <!-- This is very important -->
<scope>compile</scope>
</dependency>
<!-- Optional: Utilities for advance -->
<dependency>
<groupId>dev.cerus.advance</groupId>
<artifactId>util</artifactId>
<version>${advance.version}</version>
<scope>compile</scope>
</dependency>
</dependencies>
<!-- Shade advance into your jar -->
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-shade-plugin</artifactId>
<version>3.2.4</version>
<executions>
<execution>
<phase>package</phase>
<goals>
<goal>shade</goal>
</goals>
<configuration>
<relocations>
<relocation>
<pattern>dev.cerus.advance</pattern>
<!-- Replace YOUR_PACKAGE with the package name you're using -->
<shadedPattern>YOUR_PACKAGE.thirdparty.advance</shadedPattern>
</relocation>
</relocations>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project>public class YourClass {
public void doStuff(Player player) {
// Without utils module:
// (Replace with the implementation for the targeted version)
AdvanceApi api = new dev.cerus.advance.api.v16r3.AdvanceApiImpl();
// With utils module:
// (Automatically detects version)
api = new AdvanceApiFactory().makeApi();
api.showAdvancement(
// This doesn't have to be a Minecraft key
NamespacedKey.minecraft("advance/example"),
// Text that will be displayed in the banner
new BaseComponent[] {new TextComponent("Your text here")},
// Banner icon, can be any item
new ItemStack(Material.DIRT),
// Either CHALLENGE, GOAL or TASK
FrameType.CHALLENGE,
// Array of receiving players
player
);
// Also check out:
// AdvanceApi#showTask()
// AdvanceApi#showGoal()
// AdvanceApi#showChallenge()
// Advancement.of()
}
}