LiteHD - Lightweight Holographic Displays
Simple, customizable, and efficient holograms for your Minecraft server!
Introduction
LiteHD is a feather-light Minecraft server plugin designed for Paper/Bukkit 1.20.1 and newer versions. It offers a straightforward way to create, manage, and personalize holographic displays, supporting both text and item visuals. Say goodbye to complex setups and hello to easy, beautiful holograms!
✨ Core Features
- Effortless Management: Create and manage holograms with simple, intuitive commands.
- Custom Line Heights: Precisely control the vertical spacing between each line of your hologram.
- Item Displays: Showcase Minecraft items directly within your holograms.
- PlaceholderAPI Ready: Dynamically display server or player information using PlaceholderAPI placeholders (toggleable in config).
- Live Refresh: Holograms automatically update their content, keeping placeholders current (refresh interval is configurable).
- Self-Healing: Automatically restores any hologram entities that might go missing.
- Clean & Tidy: No lingering hologram entities after server restarts or plugin removal. All holograms are reloaded from `data.yml`.
- Highly Configurable: Customize all settings and messages via easy-to-edit configuration files.
- Full Color Support: Use traditional `&` color codes and modern `#RRGGBB` hex color codes for vibrant text.
- Modern Technology: Utilizes Minecraft 1.20+'s Display Entities (TextDisplay and ItemDisplay) for optimal performance and appearance.
- Display Properties: Supports text alignment (e.g., centered) and shadow effects.
- Good View Distance: Holograms are visible from up to 48 blocks away by default.
Getting Started: Installation
- Download the latest `LiteHD.jar` file.
- Place the `LiteHD.jar` file into your server's `plugins` folder.
- Restart your server or load the plugin using a plugin manager.
- Use `/lhd help` in-game to see available commands.
Commands
All commands require the `litehd.use` permission (OPs have this by default).
Code (YAML):
/lhd create <id> - Creates a new hologram at your current location with the given ID.
(You'll then edit its content in data.yml
)
/lhd remove <id> - Removes the hologram with the specified ID.
/lhd reload - Reloads the plugin's configuration files
(config.yml, message.yml, data.yml
).
/lhd help - Displays this help message with
all available commands.
Permissions
Code (YAML):
litehd.use - Grants access to all LiteHD plugin commands. (Default
: OP
)
Customizing Your Holograms
All hologram content, including lines, items, and line heights, is managed within the `data.yml` file located in your `/plugins/LiteHD/` folder. After making changes to `data.yml`, use `
/lhd reload` to apply them.
Defining Hologram Structure (in `data.yml`)
Here's the basic format for a hologram in `data.yml`:
Code (YAML):
# <id>: This is the unique identifier you used with /lhd create <id>
# location: <world_name>, <x_coordinate>, <y_coordinate>, <z_coordinate>
# lines:
# - 'Text line content here'
# - 'ICON: ITEM_NAME' # To display an item
# - 'height: <value>' # Sets the space *above* this line (or below the previous line)
# Example:
my_awesome_hologram:
location
: world, 100.5, 65.0, 200.5
lines:
- 'ICON
: DIAMOND_SWORD'
- 'height
: 0.8'
# Space between the sword and the text below
- '&bBehold! A mighty blade!'
- '&cForged in server fires.'
- 'height
: 0.2'
# Smaller space
- '
%player_name%, you are viewing this!'
Custom Line Heights
You can add a `height: <value>` line to control the spacing *above* the line it's defined for (or, effectively, the space below the *previous* line).
- Default height for a text line (if `height` is not specified for the line below it): `0.3`
- Default height for an item line (if `height` is not specified for the line below it): `0.5`
Example:
Code (YAML):
height_example:
location
: world, 0.0, 70.0, 0.0
lines:
- 'ICON
: GOLD_INGOT'
- 'height
: 1.0'
# Large 1.0 unit space between the gold ingot and the text below
- '&6Shiny Gold!'
- 'height
: 0.2'
# Small 0.2 unit space between "Shiny Gold!" and "Very valuable."
- '&eVery valuable.'
- '&7
(Default 0.3 space below this line
)'
# Next line will have default spacing if no height is set
- 'Another line'
Displaying Items
To show an item, use the format `ICON: MINECRAFT_ITEM_ID` on a line in your `data.yml`.
- Use valid Minecraft Item IDs (e.g., `DIAMOND`, `CHEST`, `ENCHANTED_BOOK`).
- If an invalid item ID is provided, a STONE block will be displayed as a fallback.
Example:
Code (YAML):
item_showcase:
location
: world, 10.0, 68.0, 10.0
lines:
- 'ICON
: NETHER_STAR'
- '&dBehold, the Nether Star!'
- 'ICON
: APPLE'
- '&cAn apple a day
...'
Using Color Codes
LiteHD supports both classic and modern color codes:
- **Classic `&` codes:** `&a` (green), `&c` (red), `&l` (bold), etc.
- **Hex `#RRGGBB` codes:** `#FF0000` (red), `#00FF00` (green), `#3498DB` (a nice blue), etc.
Example:
Code (YAML):
color_example:
location
: world, 20.0, 72.0, 20.0
lines
:
- '&aThis is bright green.'
- '&cThis is &lbold red.'
- '
#FF5733This is a vibrant orange.'
- '
#8E44ADAnd this is a deep purple!'
PlaceholderAPI Integration
If you have PlaceholderAPI installed and `placeholder-support` is enabled in `config.yml`, you can use any PAPI placeholders in your hologram text.
Example:
Code (YAML):
papi_hologram:
location
: world, 30.0, 75.0, 30.0
lines
:
- '&eWelcome, &6
%player_name%&e!'
- '&aOnline Players
:
&f%server_online%'
- '&bServer TPS
:
&f%server_tps%'
Configuration Files
All configuration files are located in the `/plugins/LiteHD/` folder.
1. `config.yml`
Main plugin settings.
Code (YAML):
# Enable debug mode for more console output (true/false)
debug
: false
# Hologram refresh interval in server ticks (20 ticks = 1 second)
# This is how often placeholders are updated.
refresh-interval
: 20
# Automatically refresh holograms (true/false)
auto-refresh
: true
# Enable PlaceholderAPI support for hologram text (true/false)
# Requires PlaceholderAPI to be installed.
placeholder-support
: true
2. `message.yml`
Customize plugin messages, like command feedback and error messages.
Example Snippet:
Code (YAML):
prefix
:
"&7[&bLiteHD&7] "
reload
:
"&aPlugin reloaded successfully!"
create-success
:
"&aSuccessfully created hologram &e{id}"
# ... and more customizable messages
3. `debugmessage.yml`
Customize messages shown when `debug: true` is set in `config.yml`.
Example Snippet:
Code (YAML):
debug-prefix
:
"&7[&cDebug&7] "
hologram-load
:
"&aLoading hologram &e{id}"
# ... and more debug messages
4. `data.yml`
This is where all your hologram data (locations, lines, items, heights) is stored.
Refer to the " Customizing Your Holograms" section above for detailed examples and format. Remember to use `
/lhd reload` after editing this file.
Dependencies
- **Required:** PaperMC (or a Paper fork like Pufferfish, Purpur) / Spigot (Bukkit) server software, version **1.20.1 or newer**. This is crucial as LiteHD uses Display Entities introduced in Minecraft 1.19.4 and heavily utilized from 1.20 onwards.
- **Optional:** PlaceholderAPI - Required if you want to use placeholders like `%player_name%` in your holograms. Can be disabled in `config.yml`.
Important Notes & Technical Tidbits
- Hologram entities are designed to be temporary in-game; their definitions are always loaded from `data.yml` on server start or plugin reload.
- If you remove the LiteHD plugin, all its hologram entities will be cleanly removed from the world, leaving no residue.
- Always use `/lhd reload` after making manual changes to `data.yml` or other configuration files to see your changes live.
- Holograms automatically refresh to update PAPI placeholders. The refresh speed is configurable in `config.yml`.
- The plugin includes a system to detect and restore any lost hologram entities, ensuring they remain visible.
- LiteHD leverages Minecraft's modern Display Entities (specifically `TextDisplay` and `ItemDisplay`) for efficient and visually appealing holograms.