Skip to main content

​
Maven Central

BetterHud API is available on Maven Central for easy integration into your projects. Maven Central Version

​
Bukkit/Spigot/Paper

Maven Central Version For Bukkit-based servers, you’ll need both the standard API and the Bukkit-specific API.

​
Gradle (Kotlin DSL)

repositories {
    mavenCentral()
}

dependencies {
    compileOnly("io.github.toxicity188:BetterHud-standard-api:VERSION")
    compileOnly("io.github.toxicity188:BetterHud-bukkit-api:VERSION")
    compileOnly("io.github.toxicity188:BetterCommand:VERSION")
}

​
Gradle (Groovy)

repositories {
    mavenCentral()
}

dependencies {
    compileOnly 'io.github.toxicity188:BetterHud-standard-api:VERSION'
    compileOnly 'io.github.toxicity188:BetterHud-bukkit-api:VERSION'
    compileOnly 'io.github.toxicity188:BetterCommand:VERSION'
}

​
Maven

<repositories>
    <repository>
        <id>central</id>
        <url>https://repo.maven.apache.org/maven2</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>io.github.toxicity188</groupId>
        <artifactId>BetterHud-standard-api</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>io.github.toxicity188</groupId>
        <artifactId>BetterHud-bukkit-api</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>io.github.toxicity188</groupId>
        <artifactId>BetterCommand</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

​
Plugin Dependencies

Add BetterHud as a dependency in your plugin.yml: 
depend: [BetterHud]

​
Example Project

Check out the BetterHud-MMOCore example plugin for a complete implementation.

​
Fabric Server

Maven Central Version For Fabric server mods, use modCompileOnly for the Fabric API.

​
Gradle (Kotlin DSL)

repositories {
    mavenCentral()
}

dependencies {
    compileOnly("io.github.toxicity188:BetterHud-standard-api:VERSION")
    modCompileOnly("io.github.toxicity188:BetterHud-fabric-api:VERSION")
    compileOnly("io.github.toxicity188:BetterCommand:VERSION")
}

​
Gradle (Groovy)

repositories {
    mavenCentral()
}

dependencies {
    compileOnly 'io.github.toxicity188:BetterHud-standard-api:VERSION'
    modCompileOnly 'io.github.toxicity188:BetterHud-fabric-api:VERSION'
    compileOnly 'io.github.toxicity188:BetterCommand:VERSION'
}

​
Maven

<repositories>
    <repository>
        <id>central</id>
        <url>https://repo.maven.apache.org/maven2</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>io.github.toxicity188</groupId>
        <artifactId>BetterHud-standard-api</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>io.github.toxicity188</groupId>
        <artifactId>BetterHud-fabric-api</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>io.github.toxicity188</groupId>
        <artifactId>BetterCommand</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

​
Mod Dependencies

Add BetterHud as a dependency in your fabric.mod.json: 
{
  "depends": {
    "betterhud": "*"
  }
}

​
Example Project

Check out the Fabric example mod for a complete implementation.

​
Velocity Proxy

Maven Central Version For Velocity proxy plugins:

​
Gradle (Kotlin DSL)

repositories {
    mavenCentral()
}

dependencies {
    compileOnly("io.github.toxicity188:BetterHud-standard-api:VERSION")
    compileOnly("io.github.toxicity188:BetterHud-velocity-api:VERSION")
    compileOnly("io.github.toxicity188:BetterCommand:VERSION")
}

​
Gradle (Groovy)

repositories {
    mavenCentral()
}

dependencies {
    compileOnly 'io.github.toxicity188:BetterHud-standard-api:VERSION'
    compileOnly 'io.github.toxicity188:BetterHud-velocity-api:VERSION'
    compileOnly 'io.github.toxicity188:BetterCommand:VERSION'
}

​
Maven

<repositories>
    <repository>
        <id>central</id>
        <url>https://repo.maven.apache.org/maven2</url>
    </repository>
</repositories>

<dependencies>
    <dependency>
        <groupId>io.github.toxicity188</groupId>
        <artifactId>BetterHud-standard-api</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>io.github.toxicity188</groupId>
        <artifactId>BetterHud-velocity-api</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
    <dependency>
        <groupId>io.github.toxicity188</groupId>
        <artifactId>BetterCommand</artifactId>
        <version>VERSION</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

​
Jitpack (Alternative)

You can also use Jitpack to get the latest development versions: 
repositories {
    mavenCentral()
    maven("https://jitpack.io")
}

dependencies {
    compileOnly("net.kyori:adventure-api:VERSION")
    compileOnly("com.github.toxicity188:BetterHud:VERSION")
    compileOnly("com.github.toxicity188:BetterCommand:VERSION")
}
When using Jitpack, you’ll need to include the Adventure API dependency manually.

​
Version Selection

Replace VERSION with the desired version number. Check the Maven Central badges above for the latest version.
It’s recommended to use Maven Central for stable releases and Jitpack only for development versions or specific commits.

​
Package Structure

After installation, you can import BetterHud classes: 
import kr.toxicity.hud.api.BetterHud;
import kr.toxicity.hud.api.BetterHudAPI;
import kr.toxicity.hud.api.manager.*;
import kr.toxicity.hud.api.plugin.*;

​
Next Steps

API Overview

Learn about the API architecture and core concepts

Managers

Explore the different manager interfaces

Build docs developers (and LLMs) love

Get started for freeTalk to us