HologramAPI | Leaderboards & Custom Holograms [1.19.4 - 1.21] ⚡ Java Library

HologramAPI | Leaderboards & Custom Holograms [1.19.4 - 1.21] ⚡ Java Library -----

Packet-based text display API with animations, leaderboards, emojis, minimessage, and more!

Download Now
Via external site

ᴛʜɪs ɪs ᴀ ʟɪʙʀᴀʀʏ.

FEATURES

Text animations
Minimessage support
Packet based
Per player holograms
Dynamic leaderboard creation
Advanced hologram customization
Attachmed holograms
Flexible rendering modes

This api only works on 1.19.4+
The holograms do not work for Bedrock players
Its just a Java API. This plugin does not work standalone.

SETUP

Download the plugin .jar
Download Packet Events
Upload the .jar files onto your server (yourserver/plugins folder)
Add the plugin as a dependency to your plugin and use it

PROJECT SETUP
View documentation on GitHub

Gradle

Code (Text):

repositories {
maven { url 'https://jitpack.io' }
}

dependencies {
compileOnly 'com.github.max1mde:HologramAPI:1.4.8'
}

Maven

Code (Text):

<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
<dependency>
<groupId>com.github.max1mde</groupId>
<artifactId>HologramAPI</artifactId>
<version>1.4.8</version>
<scope>provided</scope>
</dependency>

You need to add this line to your plugin.yml:

Code (YAML):

depend :
- HologramAPI

CODE EXAMPLES
Getting the instance

Code (Java):

private HologramManager hologramManager ;

@Override
public void onEnable ( ) {
hologramManager = HologramAPI. getManager ( ). orElse ( null ) ;
if (hologramManager == null ) {
getLogger ( ). severe ( "Failed to initialize HologramAPI manager." ) ;
return ;
}
}

Code (Java):

TextHologram hologram = new TextHologram ( "unique_id" )
. setMiniMessageText ( "<aqua>Hello world!" )
. setSeeThroughBlocks ( false )
. setBillboard (Display. Billboard. VERTICAL )
. setShadow ( true )
. setScale (1.5F, 1.5F, 1.5F )
. setTextOpacity ( ( byte ) 200 )
. setBackgroundColor ( Color. fromARGB ( 60, 255, 236, 222 ). asARGB ( ) )
. setAlignment (TextDisplay. TextAlignment. CENTER )
. setViewRange ( 1.0 )
. setMaxLineWidth ( 200 ) ;

Code (Java):

hologramManager. spawn (hologram, <location > ) ;
hologramManager. remove (hologram ) ;

Leaderboard creation

Code (Java):

Map < Integer, String > leaderboardData = new LinkedHashMap <> ( ) { {
put ( 1, "PlayerOne:1000" ) ;
put ( 2, "PlayerTwo:950" ) ;
put ( 3, "PlayerThree:900" ) ;
} } ;

TextHologram leaderboard = hologramManager. generateLeaderboard (
location,
leaderboardData,
HologramManager. LeaderboardOptions. builder ( )
. title ( "Top Players" )
. showEmptyPlaces ( true )
. scale (1.2f )
. maxDisplayEntries ( 10 )
. suffix ( "kills" )
. build ( )
) ;

You can find more information in on the in the GitHub readme