GlowingEntities

An util to easily set glowing entities (or blocks) per-player on a Spigot server.

No ProtocolLib, no dependency, compatible from Minecraft 1.17 to 26.2!

How to install?

Add this requirement to your maven pom.xml file:

<dependency>
  <groupId>fr.skytasul</groupId>
  <artifactId>glowingentities</artifactId>
  <version>{VERSION}</version>
  <scope>compile</scope>
</dependency>

Then, configure the maven shade plugin to relocate the classes location. You can also use the Spigot library resolver to download the library, or Paper's plugin loader.

[!NOTE] Until 1.3.4, the util was under the groupId io.github.skytasul.

After 1.3.5, it has changed to fr.skytasul.

[!IMPORTANT] When initializing the GlowingEntities object, the server must have at least 1 world loaded. If your plugin's load strategy in plugin.yml is STARTUP, you have to wait until a world has loaded in before initializing GlowingEntities. If your load strategy is POSTWORLD (the default load strategy), you can initialize it immediately.

How to use?

Make entities glow

1. Initialize the GlowingEntities object somewhere where you can easily get it, using new GlowingEntities(plugin). It is not recommended to create multiple GlowingEntities instances!

2. Use GlowingEntities#setGlowing(Entity entity, Player receiver, ChatColor color) to make an entity glow a color for a player!

3. You can change its glowing color by reusing the same method but changing the color parameter.

4. If you no longer wants your entity to glow, use GlowingEntities#unsetGlowing(Entity entity, Player receiver).

5. When you are completely done with the glowing API (for instance, when your plugin is shutting down), remember to use GlowingEntities#disable().

Make blocks glow

The same as before but with the GlowingBlocks class :)

Warning The GlowingBlocks util can only be used on Paper-based servers, not Bukkit or Spigot ones!

Advanced usage (fake entities)

If you want to make fake entities glow (= entities that do not really exist in the world, i.e. that don't have Bukkit Entity instances), you'll have to use the setGlowing(EntityIdentifier entity, String teamID, Player receiver, ChatColor color, byte otherFlags) method.

The EntityIdentifier instance is what allows GlowingEntities to track which entity to make glow by providing an accurate entity ID (EID). Since the EID of an entity can change during its lifespan (e.g. when changing world), you have to carefully craft an EntityIdentifier implementation.

If your fake entity is a simple one that keeps the same entity ID and does not change worlds, you can use the pre-made implementation: new EntityIdentifierEID(entityId, world).