https://github.com/Furqit/HoloDisplays

A powerful packet-based hologram system built with Minecraft's display entities for better performance and flexibility.
https://github.com/Furqit/HoloDisplays

display-entity fabric hologram

Last synced: 10 months ago
JSON representation

A powerful packet-based hologram system built with Minecraft's display entities for better performance and flexibility.

• Host: GitHub
• URL: https://github.com/Furqit/HoloDisplays
• Owner: Furq07
• License: gpl-3.0
• Created: 2024-11-25T23:54:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-30T02:29:49.000Z (over 1 year ago)
• Last Synced: 2024-11-30T03:24:44.258Z (over 1 year ago)
• Topics: display-entity, fabric, hologram
• Language: Kotlin
• Homepage: https://modrinth.com/mod/holodisplays
• Size: 119 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# HoloDisplays

A high-performance, packet-based hologram system utilizing Minecraft’s display entities for optimal efficiency and flexibility.

[![Minecraft](https://img.shields.io/badge/Minecraft-1.20.6--1.21.4-green.svg)](https://minecraft.net)

[![Fabric](https://img.shields.io/badge/Mod%20Loader-Fabric-blue.svg)](https://fabricmc.net)

[![License](https://img.shields.io/badge/License-GPL%203.0-red.svg)](LICENSE)

[![Discord](https://img.shields.io/badge/Discord-Furq's%20Den-7289DA?logo=discord&logoColor=white)](https://discord.gg/XhZzmvzPDV)



---

## Overview

**HoloDisplays** is a Minecraft mod that enables efficient, virtual holograms using packet-based display entities. By avoiding real entity spawning, it significantly reduces server load while providing powerful, customizable visual effects.

---

## Features

| Feature                   | Description                                                                  |

|---------------------------|------------------------------------------------------------------------------|

| Packet-Based Architecture | Utilizes network packets instead of real entities to minimize server load.   |

| Animation Support         | Enables smooth, dynamic text animations.                                     |

| Multiple Display Types    | Supports text, item, and block displays with full customization.             |

| Placeholder Integration   | Fully compatible with the Text Placeholder API.                              |

| Advanced Text Formatting  | Includes gradient support, color codes, and QuickText formatting.            |

| GUI Display Manager       | Intuitive GUI for creating, editing, and managing displays.                  |

| Command System            | Command-based customization as an alternative to the GUI.                    |

| Public Developer API      | Allows developers to create holograms and displays controlled by their mods. |

---

## Planned Features

| Feature                 | Description                                                   | Status   |

|-------------------------|---------------------------------------------------------------|----------|

| Entity Display Support  | Show mob entities with configurable properties.               | Planned  |

| Block & Item Animations | Enable animations such as rotation, scaling, and translation. | Planned  |

| Particle Effects        | Integrate with Snowstorm for advanced particle visuals.       | Possible |

---

## Commands

Available commands:

- `/holodisplays`

- `/holo` (alias)

- `/hd` (alias)

For full documentation, refer to the [Wiki](https://github.com/Furq07/HoloDisplays/wiki).

---

## License

Licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for more information.