The Fabric platform provides Blade command framework support for Fabric mods with native Brigadier integration.
Requirements
- Java 21 or higher
- Fabric Loader
- Minecraft 1.20.6+
Installation
When using Blade with Fabric, 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 for jar-in-jar.
Gradle (Groovy)
Gradle (Kotlin)
dependencies {
// Include all required Blade modules as jar-in-jar
include(modImplementation('io.github.vaperion.blade:fabric:VERSION'))
include(modImplementation('io.github.vaperion.blade:brigadier:VERSION'))
include(modImplementation('io.github.vaperion.blade:core:VERSION'))
}
dependencies {
// Include all required Blade modules as jar-in-jar
include(modImplementation("io.github.vaperion.blade:fabric:VERSION")!!)
include(modImplementation("io.github.vaperion.blade:brigadier:VERSION")!!)
include(modImplementation("io.github.vaperion.blade:core:VERSION")!!)
}
VERSION with the latest version available on Maven Central.
Setup
Initialize Blade in your mod’s initialization using BladeFabricPlatform:
public class MyFabricMod implements ModInitializer {
@Override
public void onInitialize() {
ModContainer mod = FabricLoader.getInstance()
.getModContainer("mymod")
.orElseThrow();
Blade.forPlatform(new BladeFabricPlatform(mod))
.config(cfg -> {
cfg.commandQualifier("mymod"); // Optional, defaults to mod name
cfg.defaultPermissionMessage(Text.literal("No permission!")
.styled(style -> style.withColor(Formatting.RED)));
})
.bind(binder -> {
// Optional: Register custom argument providers
binder.bind(ServerPlayerEntity.class, new MyCustomPlayerProvider());
})
.build()
// Register all commands in a package (including sub-packages):
.registerPackage(MyFabricMod.class, "com.example.commands")
// or register them individually:
.register(ExampleCommand.class)
;
}
}
Features
Brigadier Integration
The Fabric platform automatically integrates with Minecraft’s native Brigadier command system, providing:
- Native client-side tab completion
- Command syntax validation
- Real-time command suggestions
- Full Brigadier command tree support
Permissions API
Blade uses Lucko’s Fabric Permissions API for permission checks on Fabric.Plugins such as LuckPerms provide support for this API, enabling advanced permission management on Fabric servers. Hooked into Lucko's Fabric Permissions API for permission handling.
Lucko's Fabric Permissions API not found, falling back to vanilla permission handling.
Built-in Argument Types
The Fabric platform includes a built-in argument provider for:
ServerPlayerEntity - Online player lookup
Minecraft Text Components
Fabric uses Minecraft’s native Text system for messages:
cfg.defaultPermissionMessage(
Text.literal("You don't have permission!")
.styled(style -> style.withColor(Formatting.RED))
);
Example Command
public class TeleportCommand {
@Command("tp")
@Description("Teleport to a player")
@Permission("mymod.teleport")
public void teleport(
@Sender ServerPlayerEntity sender,
@Name("target") ServerPlayerEntity target
) {
sender.teleport(
target.getServerWorld(),
target.getX(),
target.getY(),
target.getZ(),
target.getYaw(),
target.getPitch()
);
sender.sendMessage(
Text.literal("Teleported to " + target.getName().getString())
.styled(style -> style.withColor(Formatting.GREEN))
);
}
}
Why Jar-in-Jar?
Fabric uses jar-in-jar to bundle dependencies directly into your mod file. This ensures that Blade is available at runtime without requiring users to manually download it.
Required Modules
- fabric: The Fabric-specific platform implementation
- brigadier: Brigadier integration layer
- core: Core Blade framework
Next Steps