Usage

Creating a HudManager

The HudManager is the central component for managing HUDs. You typically create one instance per server.

Kotlin

import net.hudkit.api.HudManager
import net.hudkit.api.StudioOptions
import net.hudkit.api.RenderOptions

val hudManager = HudManager(
    studioOptions = StudioOptions.online("your-api-key"),
    renderOptions = RenderOptions.default()
)

Java

import net.hudkit.api.HudManager;
import net.hudkit.api.StudioOptions;
import net.hudkit.api.RenderOptions;

HudManager hudManager = new HudManager(
    StudioOptions.online("your-api-key"),
    RenderOptions.defaults()
);

Loading the HUD Definition

Load your HUD definition from Hudkit Studio and process it:

Kotlin

val definition = hudManager.loadDefinition().process()
hudManager.definition = definition

Java

ProcessedHudDefinition definition = hudManager.loadDefinition().process();
hudManager.setDefinition(definition);

Uploading the Resource Pack

HUDs require a resource pack for custom textures and fonts. Upload it to Hudkit’s servers:

Kotlin

hudManager.uploadResourcepack(definition.resourcepack)

Java

hudManager.uploadResourcepack(definition.getResourcepack());

Showing the HUD to Players

When a player joins, send the resource pack and show the hud:

Kotlin

hudManager.showHud(player)
hudManager.sendResourcepack(player)

Java

hudManager.showHud(player);
hudManager.sendResourcepack(player);

Removing HUDs

When a player leaves, remove their HUD to clean up resources:

Kotlin

hudManager.removeHud(player)

Java

hudManager.removeHud(player);

Complete Example

Here’s a complete example using Minestom:

Kotlin

import net.hudkit.api.HudManager
import net.hudkit.api.StudioOptions
import net.hudkit.api.RenderOptions
import net.minestom.server.MinecraftServer
import net.minestom.server.event.player.PlayerDisconnectEvent
import net.minestom.server.event.player.PlayerSpawnEvent

fun main() {
    val server = MinecraftServer.init()

    // Create HudManager
    val hudManager = HudManager(
        studioOptions = StudioOptions.online("your-api-key"),
        renderOptions = RenderOptions.default()
    )

    // Load and process definition
    val definition = hudManager.loadDefinition().process()
    hudManager.definition = definition

    // Upload resource pack
    hudManager.uploadResourcepack(definition.resourcepack)

    val eventHandler = MinecraftServer.getGlobalEventHandler()

    // Show HUD when player spawns
    eventHandler.addListener(PlayerSpawnEvent::class.java) { event ->
        hudManager.showHud(event.player)
        hudManager.sendResourcepack(event.player)
    }

    // Remove HUD when player disconnects
    eventHandler.addListener(PlayerDisconnectEvent::class.java) { event ->
        hudManager.removeHud(event.player)
    }

    server.start("0.0.0.0", 25565)
}

Java

import net.hudkit.api.HudManager;
import net.hudkit.api.StudioOptions;
import net.hudkit.api.RenderOptions;
import net.minestom.server.MinecraftServer;
import net.minestom.server.event.player.PlayerDisconnectEvent;
import net.minestom.server.event.player.PlayerSpawnEvent;

public class Main {
    public static void main(String[] args) {
        MinecraftServer server = MinecraftServer.init();

        // Create HudManager
        HudManager hudManager = new HudManager(
            StudioOptions.online("your-api-key"),
            RenderOptions.defaults()
        );

        // Load and process definition
        ProcessedHudDefinition definition = hudManager.loadDefinition().process();
        hudManager.setDefinition(definition);

        // Upload resource pack
        hudManager.uploadResourcepack(definition.getResourcepack());

        GlobalEventHandler eventHandler = MinecraftServer.getGlobalEventHandler();

        // Show HUD when player spawns
        eventHandler.addListener(PlayerSpawnEvent.class, event -> {
            hudManager.showHud(event.getPlayer());
            hudManager.sendResourcepack(event.getPlayer());
        });

        // Remove HUD when player disconnects
        eventHandler.addListener(PlayerDisconnectEvent.class, event -> {
            hudManager.removeHud(event.getPlayer());
        });

        server.start("0.0.0.0", 25565);
    }
}

Reloading the HUD

To reload the HUD definition at runtime (e.g., after changes in Studio):

Kotlin

fun reloadHud() {
    // Load new definition
    val definition = hudManager.loadDefinition().process()
    hudManager.definition = definition

    // Upload new resource pack
    hudManager.uploadResourcepack(definition.resourcepack)

    // Send new resource pack to all online players
    MinecraftServer.getConnectionManager().onlinePlayers.forEach { player ->
        hudManager.sendResourcepack(player)
    }
}

Java

public void reloadHud() {
    // Load new definition
    ProcessedHudDefinition definition = hudManager.loadDefinition().process();
    hudManager.setDefinition(definition);

    // Upload new resource pack
    hudManager.uploadResourcepack(definition.getResourcepack());

    // Send new resource pack to all online players
    for (Player player : MinecraftServer.getConnectionManager().getOnlinePlayers()) {
        hudManager.sendResourcepack(player);
    }
}

Studio Options

Studio provides an API key, which is not considured private. It allows a client to fetch basic information about the HUD, such as the layout and project name. It is very safe, and often encouraged to hardcode an API key to your code. It’s more like an identifier than an API key.

Different ways to configure Studio connectivity:

Kotlin

// Connect with your API key.
StudioOptions.online("your-api-key")

// Use our example HUD
StudioOptions.demo()

// Local/Self-hosted: Custom Studio instance
StudioOptions.local("https://your-studio.example.com", "your-api-key")

// No Studio connection
StudioOptions.offline()

Java

// Connect with your API key
StudioOptions.online("your-api-key");

// Use our example HUD
StudioOptions.demo();

// Local/Self-hosted: Custom Studio instance
StudioOptions.local("https://your-studio.example.com", "your-api-key");

// No Studio connection
StudioOptions.offline();