Caramel

Holograms

Caramel holograms are lightweight wrappers around Minecraft TextDisplay entities, designed for easy multi-line floating text. They use individual displays for each line, making for better support with ViaBackwards.

---

Creating a hologram

You can create a hologram either empty, or pre-filled with lines.

// Empty hologram as a base
CaramelHologram hologram = new CaramelHologram();

// Hologram with initial lines
CaramelHologram hologram = new CaramelHologram(List.of(
        new CaramelHologramLine(CaramelUtility.colorcomp("<blue>Hello")),
        new CaramelHologramLine(CaramelUtility.colorcomp("<red>World"))
));

Before spawning, you must set a location (and update() it after):

hologram.setLocation(location);

---

Managing lines

You can fully control the hologram’s lines after creation.

hologram.addLine(new CaramelHologramLine(CaramelUtility.colorcomp("New Line")));
hologram.addFront(new CaramelHologramLine(CaramelUtility.colorcomp("Top Line")));
hologram.addBack(new CaramelHologramLine(CaramelUtility.colorcomp("Bottom Line")));

Removing lines:

hologram.removeLine(0); // via index
hologram.removeLine(line); // via direct line object
hologram.clear(); // removes all lines, keeps it spawned if it is

Replacing all lines:

hologram.setLines(List.of(
  new CaramelHologramLine(CaramelUtility.colorcomp("Replaced"))
));

Retrieving lines:

List<CaramelHologramLine> lines = hologram.getLines();

Each line also has properties that can help it:

line.withTextOpacity(byte opacity); // out of 225, -1 for unset
line.withSeeThrough(boolean seeThrough);
line.withShadow(boolean shadow);
line.withLineWidth(int lineWidth); // highly recomended to not change. -1 for auto.
line.withText(Component text);
line.withBackground(Color color); // can be null for unset
line.withBillboard(Display.Billboard value);
line.withAlignment(TextAlignment alignment);

And default gap lines also exist: CaramelHologramLine.gapLine()

---

Line spacing

Line spacing is controlled via lineHeight.

hologram.setLineHeight(0.25);
double spacing = hologram.getLineHeight();

Values are in blocks. Typical values range from 0.22 to 0.30, the default is 0.25 for seamless.

---

Showing and hiding

Once configured, the hologram can be shown or hidden without despawning:

hologram.show();
hologram.hide();

• show() spawns the hologram if needed and makes it visible
• hide() visually hides it without removing entities

---

Updating holograms

If line content or formatting changes, call update() to reapply settings:

hologram.update();

This reapplies all CaramelHologramLine settings to their backing TextDisplay entities.

---

Destroying holograms

To fully remove the hologram and clean up entities:

hologram.destroy();

This removes all spawned TextDisplay entities and clears internal state.

---

Accessing entities

If you need direct access to the underlying displays:

List<TextDisplay> entities = hologram.getEntities();

This can be useful for advanced effects or debugging.

---

Summary

Typical usage flow:

CaramelHologram hologram = new CaramelHologram();
hologram.setLocation(location);

hologram.addLine(new CaramelHologramLine(CaramelUtility.colorcomp("Line 1")));
hologram.addLine(new CaramelHologramLine(CaramelUtility.colorcomp("Line 2")));

hologram.setLineHeight(0.25);
hologram.show();

That’s all you need for clean, stable holograms.