Skip to content

Latest commit

 

History

History
95 lines (72 loc) · 4.69 KB

README.md

File metadata and controls

95 lines (72 loc) · 4.69 KB
Raw

DynamicHUD for Minecraft Fabric

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.

It may be ported back upto 1.16 fabric on demand.

Examples

Demo

May vary from version to version

Developed stage

View Showcase video [Watch on youtube](https://youtu.be/nQ-oiHyhrm8)

Mid stage (1.2.0)

View Demo video [!Mid stage demo video](https://github.com/V-Fast/DynamicHUD/assets/120117618/2abfcdf5-d786-4e58-acae-aefe51b77b4a)

Early stages

View Demo video
DynamicHUD.mini.showcase.1.mp4

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 versatile context menu featuring boolean, slider, runnable, color options, and list/enum selections for comprehensive widget customization.
  • Screen Border Control: Widgets are confined within the screen boundaries to prevent off-screen drift.
  • Snapping: Widgets automatically snap to a grid corner in a imaginary grid pattern on the screen when the shift key is pressed.
  • Multi-Mod Support: Designed for compatibility and easy integration across various 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 is a library for Minecraft Fabric designed to provide developers with the tools to create customizable HUD elements. It does not add widgets or any functionality on its own. Interaction with DynamicHUD's internals and utilization of its features can only be done through mods that implement this library. Users looking for in-game HUD elements should refer to mods that use DynamicHUD.

This mod / library is fabric only and has no future plans to be ported to forge.

Installation for Users

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

  1. Make sure you have Fabric and Fabric-API installed.
  2. Download the dynamichud-<version>.jar file from the official modrinth or release page.
  3. Navigate to your Minecraft directory. The default path is usually:
    • Windows: %APPDATA%\.minecraft
    • macOS: ~/Library/Application Support/minecraft
    • Linux: ~/.minecraft
  4. Locate the mods folder within your Minecraft directory. If it doesn't exist, create it.
  5. Place the downloaded DynamicHUD .jar file into the mods folder.
  6. 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>'
}

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.