> For the complete documentation index, see [llms.txt](https://tanishisherewith.gitbook.io/dynamic-hud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tanishisherewith.gitbook.io/dynamic-hud/dynamic-hud.md).

# Dynamic HUD

Build customizable Minecraft HUD widgets with DynamicHUD, a Fabric library for Minecraft 1.19.1+.

DynamicHUD is a special tool for Minecraft mod creators who use Fabric. It works with Minecraft 1.19.1 and newer versions. With DynamicHUD, you can make your own HUD parts that players can change and interact with, making their game look and feel better.

{% hint style="info" %}
The API is documented in the source code, with more examples.
{% endhint %}

DynamicHUD is constantly updating and the documentation differs from version to version!

### Support

Need assistance or have suggestions? Join our [Discord](https://discord.com/invite/Rqpn3C7yR5) community or submit an issue on our GitHub [repository](https://github.com/V-Fast/DynamicHUD).

### Contributing

Contributions are welcome. You can help by reporting bugs, proposing features, improving the documentation, or opening pull requests.

Before you contribute, check existing issues and discussions to avoid duplicate work and to align with the current roadmap.

For the full contribution process, setup instructions, and project guidelines, see the [CONTRIBUTING.md guide](https://github.com/V-Fast/DynamicHUD/blob/master/CONTRIBUTING.md).

#### To get started, visit these pages in order:

{% content-ref url="/spaces/DVOerbBYig9gngF4saif/pages/0LAqJn50yJqiibUU4EGN" %}
[Import using Gradle](/dynamic-hud/import-using-gradle.md)
{% endcontent-ref %}

{% content-ref url="/spaces/DVOerbBYig9gngF4saif/pages/pVDAD1WMbSz1spWeNPKG" %}
[Integrating DynamicHUD](/dynamic-hud/integrating-dynamichud/integrating-dynamichud.md)
{% endcontent-ref %}

{% content-ref url="/spaces/DVOerbBYig9gngF4saif/pages/SLsSRDxkkZ38C4v9eZHP" %}
[Adding Widgets](/dynamic-hud/integrating-dynamichud/adding-widgets.md)
{% endcontent-ref %}

### Credits

Creator: [Tanish](https://github.com/tanishisherewithhh)\
Wiki : [Tanish](https://github.com/tanishisherewithhh) and [Lumaa](https://lumaa.fr/github) ([V-Fast](https://lumaa.fr/v-fast))


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://tanishisherewith.gitbook.io/dynamic-hud/dynamic-hud.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.