Hologram API

A simple API for supporting in-world text rendering on the client side. This mod was created to simplify the creation process of Better Damage Indicator. Feel free to use this mod for your projects if it suits your needs.

For developers

Setup

Download a version of the mod that is suitable for your version. Add this to dependencies

modApi files("<your file path>")

<your file path> should be replaced to where your downloaded mod is.

Note: use double \\ instead of \ in your path to avoid formatting. Example:

modApi files("C:\\Users\\UserName\\Documents\\hologram_api-fabric-1.0.0 1.21.1.jar")

Example Usage

Component component = Component.literal("Hello World!").withStyle(ChatFormatting.GREEN); //create a minecraft component 
Hologram hologram = HologramAPI.create(comp, 0,80,0).lifetime(40).shadow(true).scale(2).renderDistance(20); //creating the hologram
hologram.onUpdate(h -> { //setting the animation (updates 20 times a second)
  h.y += 0.05f; //example animation to rise one block up every tick.
});

This creates a hologram with text "Hello World!" at coordinates 0, 80 ,0. It lasts for a total of 40 seconds and has a scale of 2. Additionally, it will only render when the player is within 20 blocks of radius.