Hylograms

Hylograms

⚠️ Note: Due to current Hytale game limitations, colored/formatted hologram text is not available. This feature will be added when Hytale exposes the necessary APIs.

A powerful hologram plugin for Hytale servers with multi-line text, item displays, animations, and an easy-to-use API.

Commands

All commands use the /holo parent command.

Core Commands

Command Description

/holo create <name> Creates a new hologram at your position

/holo delete <name> Deletes a hologram

/holo list Lists all holograms

/holo save Saves all holograms to disk

/holo reload Reloads config and respawns holograms

⭐ Visual Editor

Command Description

/holo ui <name> Opens the visual hologram editor GUI

The /holo ui command opens a user-friendly interface where you can:

View and edit all hologram lines

Add new text or item lines

Modify line content with text fields

Real-time preview of changes

Line Management

Command Description

/holo addline <name> --text="text" Adds a new line

/holo setline <name> <line#> --text="text" Edits a specific line

/holo removeline <name> <line#> Removes a line

/holo alignline <name> <line#> <x> <y> <z> Offsets a line's position

Item Display Syntax:

item:ItemId - Basic item item:ItemId:scale - With scale (e.g., 1.5) item:ItemId:scale:pitch:yaw:roll - With rotation Movement & Position

Command Description

/holo move <name> Moves hologram to your position

/holo teleport <name> Teleports you to the hologram

Animation Commands

Command Description

/holo anim create <animName> [--loop=true] Creates a new animation

/holo anim keyframe <animName> <time> [options] Adds a keyframe

/holo anim list Lists all animations

/holo anim load <holoName> <line#> <animName> Loads animation onto a line

/holo anim play <holoName> <line#> Starts playing animation

/holo anim stop <holoName> <line#> Stops animation

/holo anim export <holoName> <line#> <animName> Exports line's animation

Keyframe Options:

--x, --y, --z - Position offset

--pitch, --yaw, --roll - Rotation (degrees)

--scale - Scale multiplier

--easing - LINEAR, EASE_IN, EASE_OUT, EASE_IN_OUT, BOUNCE, ELASTIC

Utility Commands

Command Description

/holo respawnHolograms --confirm Force respawns all holograms

/holo debugitem <itemId> Debug item model paths

Permission Nodes

hylograms.create - Create holograms hylograms.delete - Delete holograms hylograms.list - List holograms hylograms.save - Save to disk hylograms.reload - Reload config hylograms.addline - Add lines hylograms.setline - Edit lines hylograms.removeline - Remove lines hylograms.move - Move holograms hylograms.teleport - Teleport to holograms hylograms.alignline - Align line offsets hylograms.respawn - Force respawn hylograms.debug - Debug commands hylograms.ui - Use visual editor

hylograms.anim.create - Create animations hylograms.anim.keyframe - Add keyframes hylograms.anim.load - Load animations hylograms.anim.play - Play animations hylograms.anim.stop - Stop animations hylograms.anim.export - Export animations hylograms.anim.list - List animations

config.yml

Located at mods/Hylograms/config.yml:

# Line spacing between hologram lines (in blocks) lineSpacing: 0.3

# Default color for new holograms (hex format) defaultColor: "#FFFFFF"

holograms.yml

Hologram data is stored at mods/Hylograms/holograms.yml:

holograms: - name: welcome worldName: overworld position: x: 100.50 y: 64.00 z: -200.50 color: "#00FF00" text: - 'Welcome to our server!' - 'item:ItemDiamond:1.5' - 'Have fun!' lineOffsets: 1: x: 0.5 y: 0.0 z: 0.0 lineAnimations: 1: spin createdAt: 1705264800000 Manual Editing: Edit this file and run /holo reload to apply changes.

animations.yml

Reusable animations are stored at mods/Hylograms/animations.yml:

animations: spin: loop: true keyframes: - time: 0.0 x: 0.0 y: 0.0 z: 0.0 yaw: 0.0 scale: 1.0 easing: LINEAR - time: 2.0 yaw: 360.0 scale: 1.0 easing: LINEAR

bounce: loop: true keyframes: - time: 0.0 y: 0.0 easing: EASE_OUT - time: 0.5 y: 0.3 easing: EASE_IN - time: 1.0 y: 0.0 easing: EASE_OUT

Developer API

Hylograms provides a fluent, easy-to-use API for developers.

Creating Holograms

import dev.ehko.hylograms.api.HologramsAPI;

// Create with fluent builder HologramsAPI.create("shop", store) .at(100, 65, 200) .inWorld("overworld") .color("#00FF00") .addLine("Welcome to the Shop!") .addItem("ItemDiamond", 2.0f) .addLine("Click to browse") .spawn(); Modifying Holograms

HologramsAPI.get("shop") .setLine(1, "Shop is OPEN!") .alignLine(1, 0.5, 0, 0) .addLine("New items available!") .respawn(store) .save(store); Animations

HologramsAPI.get("shop") .loadAnimation(1, "spin") .playAnimation(store, 1);

// Stop animation HologramsAPI.get("shop").stopAnimation(1); Utilities

// Check existence if (HologramsAPI.exists("shop")) { ... }

// List all holograms List<String> names = HologramsAPI.list();

// Delete HologramsAPI.delete("shop", store);

// Spawn all on server start HologramsAPI.spawnAll(store);

Common Issues & Troubleshooting

Holograms not visible or duplicated?

Run /holo respawnHolograms --confirm to force cleanup and respawn

Items showing as wrong model?

Use /holo debugitem <itemId> to check model paths

Some items may not have 3D models in Hytale

YAML edits not applying?

Run /holo reload after editing files

Check server console for YAML parsing errors

Animations not playing?

Ensure the animation is loaded with /holo anim load

Run /holo anim play after loading

Check that the hologram is spawned

Ghost entities after crash?

Use /holo respawnHolograms --confirm to clean up orphaned entities

Installation

Download the Hylograms JAR

Place in your server's mods/ folder

Restart the server

Grant permission nodes as needed

Create holograms with /holo create or /holo ui