HologramLib | Leaderboards & Custom Holograms [1.19.4 - 1.21.x] ⚡ Java Library

HologramLib | Leaderboards & Custom Holograms [1.19.4 - 1.21.x] ⚡ Java Library -----

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

ᴛʜɪs ɪs ᴀ ʟɪʙʀᴀʀʏ.
There are no pre-made commands. It's a library for your own plugins.
FOLIA ✅ PAPER ✅ PURPUR ✅ 1.19.4 - 1.21 ✅
[IMG]

FEATURES

Text, Block & Item Holograms
Text animations
Minimessage support
Packet based
Per player holograms
Leaderboard generators
Advanced hologram customization
Passenger holograms

This api only works on 1.19.4+
The holograms do not work for Bedrock players
There can be some issues when using spigot on older versions (Preferably use Paper or a fork of it)
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:HologramLib:1.6.6'
}

Maven

Code (Text):

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

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

Code (YAML):

depend :
- HologramLib

CODE EXAMPLES

Getting the instance

Code (Java):

private HologramManager hologramManager ;

@Override
public void onLoad ( ) {
HologramLib. onLoad ( this ) ; /*Only needed if you shade HologramLib*/
}

@Override
public void onEnable ( ) {
HologramLib. getManager ( ). ifPresentOrElse (
manager -> hologramManager = manager,
( ) -> getLogger ( ). severe ( "Failed to initialize HologramLib manager." )
) ;
}

Text Hologram

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 ) ;

Item Hologram

Code (Java):

ItemHologram hologram = new ItemHologram ( "unique_id" )
. setItem ( new ItemStack. Builder ( )
. type (ItemTypes. DIAMOND_SWORD )
. build ( ) )
. setGlowing ( true )
. setGlowColor ( Color. ORANGE )
. setOnFire ( false )
. setDisplayType (ItemDisplayMeta. DisplayType. FIXED )
. setBillboard (Display. Billboard. VERTICAL )
. setScale (2.0F, 2.0F, 0.01F )
. setViewRange ( 1.0 ) ;

Spawing a hologram

Code (Java):

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

Leaderboard creation

Code (Java):

Map < Integer, String > leaderboardData = new LinkedHashMap <> ( ) { {
put ( 1, "MaximDe:1000" ) ;
put ( 2, "dream:950" ) ;
put ( 3, "BastiGHG:500" ) ;
put ( 4, "Wichtiger:400" ) ;
// ... more entries
} } ;

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

/*
Update the leaderboard later if needed
*/
hologramManager. updateLeaderboard (
leaderboard,
updatedData,
/*
ou can also use different options here
which will be applied to the leaderboard
*/
leaderboard. getOptions ( )
) ;

You can find more information in the GitHub readme