README.md

Welcome to BetterHud!

SpigotMC | Hangar | Modrinth | Github

Multiplatform server-side HUD implementation of Minecraft

This project implements a server-side HUD.

• Supports auto-generating resource pack.
• Supports display image(include png sequence), text, head.
• Supports animation.

Platform

• Bukkit(including Folia) 1.18.2-1.21.4
• Velocity 3.3-3.4
• Fabric server 1.21.4

Library

• kotlin stdlib: Implements better functional programming.
• adventure: Implements multi-platform component.
• bstats: Implements metrics.
• exp4j: Implements equation.
• negative space font: Implements space font in minecraft legacy version.
• snakeyaml: Implements yaml parser.
• gson: Implements json parser/writer.
• better command: Implements multi-platform supporting command.

Dependency

• Bukkit: No
• Velocity: No
• Fabric server: Fabric API

Build

Requires Java 17, 21 Eclipse Adoptium.

• Build all available jar: ./gradlew build
• Build Bukkit plugin: ./gradlew pluginJar
• Build Velocity plugin: ./gradlew velocityJar
• Build Fabric server side mod: ./gradlew fabricJar
• Build source code jar: ./gradlew sourceJar
• Build dokka-based docs jar: ./gradlew dokkaJar

API

Get from maven central

repositories {
    mavenCentral()
}

dependencies {
    compileOnly("net.kyori:adventure-api:VERSION") //Adventure api
    compileOnly("io.github.toxicity188:BetterHud-standard-api:VERSION") //Standard api
    compileOnly("io.github.toxicity188:BetterHud-bukkit-api:VERSION") //Platform api
    compileOnly("io.github.toxicity188:BetterCommand:VERSION") //BetterCommand library
}

Get from Jitpack

repositories {
    mavenCentral()
    maven("https://jitpack.io")
}

dependencies {
    compileOnly("net.kyori:adventure-api:VERSION") //Adventure api
    compileOnly("com.github.toxicity188:BetterHud:VERSION") //BetterHud
    compileOnly("com.github.toxicity188:BetterCommand:VERSION") //BetterCommand library
}

Use BetterHud with Skript

Go to download Skript

command /pointadd:
    trigger:
        #compass marker add
        point add location at 0, 0, 0 in world "world" named "test1" to player
        point add location at 10, 0, 0 in world "world" named "test2" with icon "other" to player

command /pointremove:
    trigger:
        #compass marker remove
        point remove "test1" to player
        point remove "test2" to player

command /popup:
    trigger:
        #show popup with custom event
        set {_o::rand} to random integer between 1 to 100
        show popup "test_popup" to player with variable of {_o::*}