https://github.com/skytasul/glowingentities

An API to easily make Minecraft entities glow. No dependencies, compatible 1.17 -> 1.21.
https://github.com/skytasul/glowingentities

api bukkit glow glowing java minecraft spigot

Last synced: about 1 month ago
JSON representation

An API to easily make Minecraft entities glow. No dependencies, compatible 1.17 -> 1.21.

• Host: GitHub
• URL: https://github.com/skytasul/glowingentities
• Owner: SkytAsul
• License: mit
• Created: 2022-05-31T13:46:22.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-27T13:04:40.000Z (5 months ago)
• Last Synced: 2024-09-28T12:02:51.026Z (about 2 months ago)
• Topics: api, bukkit, glow, glowing, java, minecraft, spigot
• Language: Java
• Homepage:
• Size: 1.81 MB
• Stars: 63
• Watchers: 3
• Forks: 9
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# GlowingEntities

![Maven Central](https://img.shields.io/maven-central/v/fr.skytasul/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 1.21!

![Glowing entities animation](demo.gif)

![Glowing blocks animation](demo-blocks.gif)

## How to install?

### 1st method: copying the class

Copy the [GlowingEntities.java class](src/main/java/fr/skytasul/glowingentities/GlowingEntities.java) to your project

(and the [GlowingBlocks.java class](src/main/java/fr/skytasul/glowingentities/GlowingBlocks.java) if required).

### 2nd method: using maven

Add this requirement to your maven `pom.xml` file:

```xml

  fr.skytasul

  glowingentities

  {VERSION}

  compile

```

Additionnally, you can use the maven shade plugin to relocate the classes location.

> [!NOTE]  

> Until 1.3.4, the util was under the groupId `io.github.skytasul`.  

> After 1.3.5, it has changed to `fr.skytasul`.

## 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!