Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Dreamin-MC/DreamHud

Repository files navigation

✨ DreamHud

Version Java Minecraft License


🧠 Overview

DreamHud is a modern and high-performance library for displaying dynamic HUDs on Minecraft Paper 1.21+ servers using the bossbar system. Designed for customization, smoothness, and creativity, it allows developers to create immersive and completely custom-made interfaces.


⚡ Key Features

  • 🎨 Dynamic Components — Build your HUDs from Layout, Hud, and Element.
  • 🧩 Seamless Integration — Compatible with all plugins and APIs of the Dreamin Ecosystem.
  • 🧠 Intelligent Rendering — Automatically manages offsets, spacing, and display priorities.
  • 🔤 Full support for custom fonts (via resource pack).
  • 🪶 Ultra-lightweight and optimized — Zero lag, instant rendering via bossbars.
  • 🛠️ Intuitive API — Uses the latest features of Adventure & Kyori Components.

🧭 Project Goal

The idea behind DreamHud is to replace the basic Minecraft HUDs with a flexible and modular system capable of:

  • displaying contextual information (health, score, objectives, timers, etc.),
  • animating visual scenes or event transitions,
  • allowing servers to have a unique visual identity.

DreamHud is used in production on projects within the Dreamin' ecosystem, particularly for dynamic HUDs, cinematics, and immersive interfaces. ---

🧱 Project Structure

📦 DreamHud
┣ 📁 changelog/
┃ ┗ … (file changelog.)
┣ 📁 assets/
┃ ┗ … (visual resources, images, etc.)
┣ 📁 examples/
┃ ┗ … (usage examples, practical cases)
┣ 📁 src/
┃ ┣ 📁 api/
┃ ┃ ┗ … (public interfaces, builders, etc.)
┃ ┣ 📁 internal/
┃ ┃ ┗ … (internal implementations, rendering logic, etc.)
┣ 📄 API_USAGE_GUIDE.md
┗ 📄 README.md

🧩 Developer Integration

💻 Adding as a Dependency

Maven

<repositories>
<repository>
<id>jitpack.io</id>
<url>https://jitpack.io</url>
</repository>
</repositories>

<dependency>
<groupId>com.github.Dreamin-MC</groupId>
<artifactId>DreamHud</artifactId>
<version>Tag</version>
</dependency>

Gradle

repositories {
maven { url "https://jitpack.io" }
}
dependencies {
compileOnly 'com.github.Dreamin-MC:DreamHud:Tag'
}

🚀 Quick Overview

Banner

➡️ Each block is generated dynamically via the player's bossbar. Texts, colors, fonts, and positions are 100% configurable via code or a JSON file.


🧃 Dreamin’ Ecosystem

DreamHud is part of the Dreamin Ecosystem, a set of modular projects designed to enrich the server-side Minecraft experience:

Project Description
🧠 DreamAPI Central and abstract API common to all modules.
🌈 DreamHud Dynamic display of HUDs and overlays.

🛠️ Project Status

État Version Compatibilité
🧪 Under active development v1.0.2 Paper 1.21.8
🔜 Final migration DreamHud (v2) Stable and public API planned

⚠️ The current version (DreamHud v1) serves as the technical foundation for DreamHud v2. Major API changes are to be expected.


📚 Documentation

📘 → API Usage Guide Contains:

  • detailed code examples;
  • complete documentation of public classes;
  • integration examples with other modules of the Dreamin Ecosystem.

🤝 Contributing

Contributions are welcome! Before any PR, please check:

  • that the code follows the general project style;
  • that the added features are tested and documented;
  • that Minecraft/Paper 1.20+ compatibility is maintained.

📄 License

This project is distributed under the GPL-3.0 license. ➡️ See the LICENSE file


📞 Support


Banner

Made with ❤️ by the Dreamin Studio

About

Hud lib for manage and create hud in minecraft server

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Languages