HomeJavaModsCommandAPI
CommandAPI
ModsJava

CommandAPI

by JorelAli · on Modrinth

Which build do you need?

This mod ships a separate file for every mod loader and every version of the game. Pick both, then download — the wrong build installs fine and then does nothing in the game.

Mod loader

Minecraft version

⬇ Download for 1.21.7–26.2 · Folia⬇ Download for 1.21.7–26.2 · Paper⬇ Download for 1.21.6–26.2 · Spigot⬇ Download for 1.21.6–26.2 · Velocity⬇ Download for 1.21.7–1.21.8 · Bukkit
I don't know my version or loader
Open the Minecraft launcher and look at the profile you play on — it names both, like fabric-loader-1.21.4. The version also shows in the bottom-right corner of the game's main menu.
No loader in the profile name? Then it's plain Minecraft, and these mods won't run — you need Fabric or NeoForge installed first.
CommandAPI — screenshot 1CommandAPI — screenshot 2CommandAPI — screenshot 3

A Bukkit/Spigot API to use the command UI introduced in Minecraft 1.13

Everything you'll ever need can be found on the GitHub page

What is the CommandAPI?

The CommandAPI provides full support for the new command UI which was implemented in Minecraft's 1.13 update.

Example of the CommandAPI in use

Wanna stay up to date? We've got a Discord server!

Brief overview of features

Argument type casting

Instead of checking if an argument is an integer after they run the command like this:

onCommand(CommandSender sender, Command command, String label, String[] args) {
    try {
        int i = Integer.parseInt(args[0]);
        // Do something with this number
    catch (NumberFormatException e) {
        // Do something with the fact this isn't a number...
    }
}

You can rest assured that the CommandAPI has inferred whatever type you want and can jump straight to this:

new CommandAPICommand("mycommand")
    .withArguments(new IntegerArgument("myint"))
    .executes((sender, args) -> {
        int i = (int) args.get("myint");
        // Do something with this number
    })
    .register();

The CommandAPI offers over 40 different arguments to tailor to your needs! Automatic casting to Enchantments, EntityTypes, Locations, ItemStacks, PotionEffects and many more!

CommandSender type checks

Never again will you have to check if your sender is a player! The CommandAPI provides automatic command sender checks for all sorts of command senders:

new CommandAPICommand("mycommand")
    .withArguments(arguments)
    .executesPlayer((player, args) -> {
        player.sendMessage("Hi " + player.getDisplayName());
    })
    .register();

Documentation

The latest documentation can be found here. Trust me, you've never, ever seen documentation this good before.

Built-in plugin converter

Bummed that your plugin's commands can't be used with the /execute command and don't know how to write code? The CommandAPI has you covered! With its built-in plugin command conversion system, you can make any plugin command compatible with Minecraft's /execute command and datapacks!

Still not convinced?

Here's what else it can do:

Need I say more?

Quick facts

Install steps are the general flow for this file type — How to install Minecraft Java mods & modpacks walks through it step by step.

Verified by MCModsHub

These come from our own check of the pack file, not from the source page.

Explore more