https://github.com/dreamin-mc/dreamhud
HudLib for manage and create hud in minecraft server
https://github.com/dreamin-mc/dreamhud
dreamin hud hud-api hud-lib java lib minecraft minecraft-plugin
Last synced: 4 months ago
JSON representation
HudLib for manage and create hud in minecraft server
- Host: GitHub
- URL: https://github.com/dreamin-mc/dreamhud
- Owner: Dreamin-MC
- License: gpl-3.0
- Created: 2025-10-31T01:03:35.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-11-20T22:04:01.000Z (7 months ago)
- Last Synced: 2025-11-20T23:32:53.529Z (7 months ago)
- Topics: dreamin, hud, hud-api, hud-lib, java, lib, minecraft, minecraft-plugin
- Language: Java
- Homepage:
- Size: 23.7 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: changelog/1.0.0.md
- License: LICENSE
Awesome Lists containing this project
README
# ✨ DreamHud
[](https://github.com/dreamin/dreamintablist)
[](https://jitpack.io/#Dreamin-MC/DreamHud)
[](https://www.oracle.com/java/)
[](https://www.minecraft.net/)
[](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**
```xml
jitpack.io
https://jitpack.io
com.github.Dreamin-MC
DreamHud
Tag
```
**Gradle**
```groovy
repositories {
maven { url "https://jitpack.io" }
}
dependencies {
compileOnly 'com.github.Dreamin-MC:DreamHud:Tag'
}
```
---
### 🚀 Quick Overview
➡️ 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](API_USAGE_GUIDE.md)**
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](LICENSE)
---
## 📞 Support
- **Documentation**: [API Usage Guide](API_USAGE_GUIDE.md)
- **Examples**: [examples/](examples/)
- **Issues**: [GitHub Issues](https://github.com/dreamin/dreamhud/issues)
- **Discord**: [Join our Discord](https://discord.gg/dreamin)
---
**Made with ❤️ by the Dreamin Studio**