# Welcome

## Overview

HoloDisplays is a powerful, high-performance Minecraft mod that enables the creation of efficient virtual holograms using packet-based display entities. Unlike traditional hologram plugins that spawn real entities (which can cause server lag), HoloDisplays leverages Minecraft's built-in display entities sent via network packets. This approach minimizes server load while providing flexible, customizable visual effects for text, items, blocks, and entities.

The mod is designed for Fabric Loader on Minecraft versions 1.20.5 to 26.x. It integrates seamlessly with mods like Placeholder API for dynamic content and supports advanced text formatting, including gradients and color codes.

## Key Benefits

* **Performance**: No entity spawning means lower TPS impact, even with hundreds of holograms.
* **Flexibility**: Supports animations, conditions, and multiple display types.
* **Ease of Use**: Intuitive GUI for management, plus a comprehensive command system.
* **Developer-Friendly**: Public API for mod integration.

## Features

* **Multiple Display Types**: Text with multi-line support and gradients; items with render types; blocks and entities with scaling and poses.
* **Hologram Management**: Group displays with offsets, configure scale, rotation, view range, and conditions.
* **Animations**: Frame-based text cycling (planned: item/block animations).
* **Integration**: Compatible with Placeholder API for dynamic placeholders.
* **User Interface**: GUI editors for all aspects; command alternatives.
* **API**: Register holograms/displays programmatically.

Source code and downloads: [GitHub](https://github.com/Furq07/HoloDisplays) | [Modrinth](https://modrinth.com/mod/holodisplays)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://holodisplays.furq.dev/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.