DynamicHUD for Minecraft Fabric

DynamicHUD is a library for Minecraft mod creators using Fabric (Minecraft 1.19.4+). It lets developers create customizable HUD elements that players can modify and interact with, enhancing both visuals and gameplay.

Features

• Automatic Loading & Saving: Widgets automatically save their state and reload upon game restart, providing a seamless experience for players.
• Dynamic Values: Widgets can display real-time information, adapting to in-game events and data changes.
• Inbuilt Widgets: Start with TextWidget for easy text display and expand with more specialized widgets.
• Utility Classes: Utilize DrawHelper, ColorHelper, and TextureHelper for efficient and streamlined development.
• ContextMenu: A general context menu featuring boolean, slider, runnable, color options, and list/enum selections for widget customization.
• Screen Border Control: Keeps widgets within screen boundaries.
• Snapping: Hold Shift to snap widgets to an imaginary grid.
• Multi-Mod Support: Built for compatibility across mods.
• Easy Integration: Simple setup for quick implementation into your projects.
• Comprehensive Wiki: A detailed guide and reference for all features of DynamicHUD, available at https://tanishisherewith.gitbook.io/dynamic-hud.

Disclaimer

DynamicHUD provides tools for developers but does not add HUD elements by itself.

Users looking for in-game HUD elements should refer to mods that use DynamicHUD.

Fabric only — no plans for Forge support.

Installation for Users

To ensure mods that depend on DynamicHUD work correctly, follow these steps to add DynamicHUD to your Minecraft installation:

0. Make sure you have Fabric and Fabric-API installed.
1. Download the dynamichud-<version>.jar file from the official release page.
2. Navigate to your Minecraft directory. The default path is usually:
   • Windows: %APPDATA%\.minecraft
   • macOS: ~/Library/Application Support/minecraft
   • Linux: ~/.minecraft
3. Locate the mods folder within your Minecraft directory. If it doesn't exist, create it.
4. Place the downloaded DynamicHUD .jar file into the mods folder.
5. Run Minecraft with the Fabric loader. DynamicHUD will now be loaded, and any mods with DynamicHUD as a dependency can function properly.

Enjoy the enhanced HUD experience provided by mods utilizing DynamicHUD!

Getting Started For Developers

Visit our wiki for more detailed information about the library!

To integrate DynamicHUD into your mod, add it as a dependency in your build.gradle file:

allprojects {
	repositories {
		maven { url 'https://jitpack.io' }
	}
	maven {
		name 'Xander Maven'
		url 'https://maven.isxander.dev/releases'
	}
}

dependencies {
	// Dynamic HUD
	modImplementation 'com.github.V-Fast:DynamicHUD:<Version>'
}

Old archived wiki

https://tanishisherewith.gitbook.io/archived-legacy-dynamichud/

Contributing

Contributions are welcome! If you’re interested in improving DynamicHUD or adding new features, please review our contributing guidelines.

License

DynamicHUD is released under the MIT License. Feel free to use and modify it in your mods, with proper attribution back to this repository.

Support

Need assistance or have suggestions? Join our Discord community or submit an issue on our GitHub repository.

Showcase