Hylograms - Name-Based Hologram System

Overview

Hylograms is a powerful hologram plugin for Hytale servers that allows you to create, manage, and customize named holograms with multi-line text support. Built with a clean API-first design, Hylograms combines ease of use with extensibility for server administrators and developers.

Key Features

• Name-Based Management: Create and manage holograms by simple text names instead of wrestling with entity references
• Multi-Line Support: Add multiple lines of text to a single hologram with easy line-by-line editing
• YAML Storage: Persistent storage in human-readable YAML format for easy manual editing and backup
• Entity Management: Automatic entity spawning, respawning, and cleanup with aggressive orphan detection
• Permission Nodes: Full permission control for each command
• Developer-Friendly API: Easy-to-use Java library API for plugin developers

Commands

All commands use the /holo parent command and require appropriate permission nodes.

/holo create <name>

Creates a new hologram at your current position.

• Permission: hylograms.create
• Example: /holo create welcome
• Creates a hologram with a help text guide to get started

/holo addline <name> --text="your text"

Adds a new line to an existing hologram.

• Permission: hylograms.addline
• Example: /holo addline welcome --text="Welcome to our server!"
• Lines are displayed from top to bottom in the order added

/holo setline <name> <line-num> --text="your text"

Edits a specific line number in a hologram.

• Permission: hylograms.setline
• Example: /holo setline welcome 1 --text="New welcome text"
• Use /holo list to see line numbers

/holo removeline <name> <line-num>

Removes a specific line from a hologram.

• Permission: hylograms.removeline
• Example: /holo removeline welcome 2
• Remaining lines are automatically reorganized

/holo delete <name>

Deletes a hologram and removes all its entities from the world.

• Permission: hylograms.delete
• Example: /holo delete welcome
• Completely removes the hologram and its data

/holo list

Displays all created holograms with their line counts and positions.

• Permission: hylograms.list
• Example: /holo list
• Shows useful info for managing your holograms

/holo save

Manually saves all holograms to the YAML file.

• Permission: hylograms.save
• Example: /holo save
• Automatically called after most operations, but useful for backups

/holo respawnHolograms --confirm

Aggressively cleans up and respawns all hologram entities.

• Permission: hylograms.respawn
• Example: /holo respawnHolograms --confirm
• Despawns all bat entities and respawns registered holograms
• Use this if holograms disappear or duplicate unexpectedly

Storage Format

Hylograms stores data in human-readable YAML format at mods/Hylograms/holograms.yml:

holograms:
  - name: "welcome"
    position:
      x: 100.50
      y: 64.00
      z: -200.50
    color: "#00FF00"
    text:
      - "Welcome to our server!"
      - "Have fun and enjoy!"
    createdAt: 1705264800000
  - name: "shop"
    position:
      x: 150.25
      y: 70.00
      z: 50.75
    color: "#FFFFFF"
    text:
      - "General Store"
      - "Buy items here"
    createdAt: 1705265000000

You can manually edit this file and reload the changes using /holo respawnHolograms --confirm

Library API

Developers can use Hylograms as a library to programmatically create and manage holograms.

Basic Usage

import dev.ehko.hylograms.HologramManager;
import dev.ehko.hylograms.util.HologramEntityUtil;
import com.hypixel.hytale.math.vector.Vector3d;
import com.hypixel.hytale.component.Store;
import com.hypixel.hytale.server.core.universe.world.storage.EntityStore;

// Create a new hologram
Vector3d position = new Vector3d(100, 64, -200);
String hologramName = "my_hologram";

HologramManager.createHologram(hologramName, position, null);

// Add text lines
HologramManager.addLine(hologramName, "Line 1");
HologramManager.addLine(hologramName, "Line 2");
HologramManager.addLine(hologramName, "Line 3");

// Get hologram data
HologramManager.HologramData data = HologramManager.getHologram(hologramName);
System.out.println("Position: " + data.getPosition());
System.out.println("Text items: " + Arrays.toString(data.getTextItems()));

// Edit a line
HologramManager.setLine(hologramName, 2, "Modified Line 2");

// Remove a line
HologramManager.removeLine(hologramName, 3);

// Delete the hologram
HologramManager.deleteHologram(hologramName);

// Save to YAML
HologramSerializer.saveAll();

Spawning Entities

To make holograms visible in-game, spawn their entities:

import dev.ehko.hylograms.util.HologramEntityUtil;

// Get hologram data
HologramManager.HologramData data = HologramManager.getHologram(hologramName);

// Spawn all text lines as entities
HologramEntityUtil.spawnHologramLines(
    store,                           // Entity store
    hologramName,                    // Hologram name
    data.getTextItems(),             // Text array
    data.getPosition(),              // Position
    data.getRotation(),              // Rotation
    null
);

Despawning Entities

// Remove all entities for a hologram
HologramEntityUtil.despawnHologramLines(store, hologramName);

Getting All Holograms

import java.util.Map;

// Get all holograms
Map<String, HologramManager.HologramData> allHolograms = HologramManager.getAllHolograms();

for (Map.Entry<String, HologramManager.HologramData> entry : allHolograms.entrySet()) {
    String name = entry.getKey();
    HologramManager.HologramData data = entry.getValue();
    System.out.println("Hologram: " + name);
    System.out.println("  Position: " + data.getPosition());
    System.out.println("  Lines: " + data.getTextItems().length);
}

Managing Entity References

For advanced usage, you can track entity references:

import java.util.List;
import com.hypixel.hytale.component.Ref;
import com.hypixel.hytale.server.core.universe.world.storage.EntityStore;

// Get all registered entity refs
List<Ref<EntityStore>> allRefs = HologramManager.getRegisteredEntityRefs();

// Get refs for a specific hologram
List<Ref<EntityStore>> hologramRefs = HologramManager.getRegisteredEntityRefsForHologram(hologramName);

// Clear all refs (use with caution)
HologramManager.clearEntityRefs();

Installation

1. Download the Hylograms JAR file
2. Place it in your server's mods/ folder
3. Restart your server
4. Grant appropriate permission nodes to players/groups
5. Start creating holograms with /holo create

Configuration

All configuration is automatic. Holograms are stored in mods/Hylograms/holograms.yml and loaded on server startup. You can manually edit the YAML file for bulk changes.

Permission Nodes

hylograms.create      - Create new holograms
hylograms.addline     - Add lines to holograms
hylograms.setline     - Modify existing lines
hylograms.removeline  - Remove lines from holograms
hylograms.delete      - Delete holograms
hylograms.list        - List all holograms
hylograms.save        - Save holograms to file
hylograms.respawn     - Respawn all hologram entities

Troubleshooting

Holograms not showing?

• Use /holo respawnHolograms --confirm to respawn all entities
• Check that players have line-of-sight to the hologram position
• Verify holograms were created with /holo list

Duplicate text appearing?

• This was a known issue that has been fixed - ensure you have the latest version
• Use /holo respawnHolograms --confirm if it persists

Support & Issues

https://discord.gg/pVwu4nfktU

For bug reports, feature requests, or support, please join our Discord server above.

Hylograms - Making holograms simple for Hytale servers.