Skip to main content
Blade is published to Maven Central, making it easy to add to your project using Maven or Gradle.

Prerequisites

  • Java 8 or higher (some platforms require Java 17 or 21)
  • Maven or Gradle build tool
  • A supported platform (Bukkit, Paper, Fabric, Velocity, Minestom, or Hytale)
Blade is now published under the group ID io.github.vaperion.blade (changed from com.github.vaperion.blade). Make sure to use the new group ID when adding the dependency.

Choose Your Platform

Blade provides different artifacts for each platform. Select the one that matches your environment:
PlatformArtifactRequirements
BukkitbukkitJava 8+
Paper (Modern)paperMinecraft 1.13+, Java 21+
Paper (Legacy)paper-legacyMinecraft 1.13+, Java 17-21
FabricfabricFabric mod loader
VelocityvelocityVelocity proxy
MinestomminestomMinestom server
HytalehytaleHytale server
Paper Users: The Paper artifact is split into two versions. Use paper for Minecraft 1.20.6+ (Java 21+) and paper-legacy for older versions or Java 17-21. For Minecraft versions below 1.13 or Java below 17, use the bukkit artifact instead.

Installation

Maven

Add Blade as a dependency in your pom.xml:
<dependencies>
    <dependency>
        <groupId>io.github.vaperion.blade</groupId>
        <artifactId>bukkit</artifactId>
        <version>1.0.23</version>
        <scope>provided</scope>
    </dependency>
</dependencies>

Gradle (Groovy DSL)

Add Blade as a dependency in your build.gradle:
dependencies {
    implementation 'io.github.vaperion.blade:bukkit:1.0.23'
}

Gradle (Kotlin DSL)

Add Blade as a dependency in your build.gradle.kts:
dependencies {
    implementation("io.github.vaperion.blade:bukkit:1.0.23")
}
Fabric Users: You must use include(modImplementation(...)) to add Blade as a jar-in-jar dependency. You’ll need to include the fabric, brigadier, and core modules separately, as Fabric Loom doesn’t resolve transitive dependencies automatically.
Fabric Permissions: Blade uses Lucko’s Fabric Permissions API for permission checks on Fabric. Plugins such as LuckPerms provide support for this API.

Verify Installation

After adding the dependency, rebuild your project to verify that Blade is correctly installed:
mvn clean install
If the build succeeds without errors, you’re ready to start using Blade!

Next Steps

Now that you have Blade installed, you can:

Quick Start

Create your first Blade command

Core Concepts

Learn about the fundamental concepts

Build docs developers (and LLMs) love