Перейти к содержимому
Mineforgian

CommandAPI

An API to use the command UI introduced in Minecraft 1.13

Загрузки
75K
Подписчики
111
Обновлён
1 апреля 2026 г.
Лицензия
MIT

Опубликован 4 сентября 2022 г.

Исходный кодСообщить об ошибке

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

  • Better commands - Prevent players from running invalid commands, making it easier for developers
  • Better arguments - Automatic argument parsing with built-in validation
  • Support for proxied command senders - Run your command as other entities using /execute as ... run command
  • Support for the /execute command - Let your command to be executed by the built in /execute command
  • Support for Minecraft's functions - Allow your command to be executed from Minecraft's functions and tags
  • No plugin.yml registration - Commands don't need to be registered in the plugin.yml file anymore
  • No other dependencies - You don't need to import Brigadier in your projects to use the CommandAPI
  • No tracking - The CommandAPI doesn't collect any stats about its plugin; what you see is what you get!

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:

  • Parse integers with ranges automatically (force your command to only accept values within a range)
  • Handle integer and floating point locations, as well as relative locations using the ~ symbol
  • Parse raw JSON and convert it straight into a BaseComponent[]
  • Parse online players, with suggestions based on who's online
  • Create custom arguments that parse Strings into custom defined objects
  • Apply permissions to specific arguments - you need permissions to even see the suggested arguments as well as run it
  • Make other plugins that weren't written with the CommandAPI compatible with the /execute command
  • Handle results and successes of commands just like you can with command blocks
  • Set context-aware suggestions based on what the user has already entered into their command prompt

Need I say more?

Ченджлог

11.2.0Релиз1.21.11, 26.1, 26.1.1 · 1 апреля 2026 г.

Minecraft Version Changes

  • Adds support for Minecraft 26.1

Bug Fixes

  • Fixes multiple issues with command registration at bootstrap
11.2.0Релиз1.21.11, 26.1, 26.1.1 · 1 апреля 2026 г.

Minecraft Version Changes

  • Adds support for Minecraft 26.1

Bug Fixes

  • Fixes multiple issues with command registration at bootstrap
11.2.0Релиз1.21.11, 26.1, 26.1.1 · 1 апреля 2026 г.

Minecraft Version Changes

  • Adds support for Minecraft 26.1

Bug Fixes

  • Fixes multiple issues with command registration at bootstrap
11.1.0Релиз1.21.9, 1.21.10, 1.21.11 · 16 декабря 2025 г.

Minecraft Version Changes

  • Adds support for Minecraft 1.21.11

Bug Fixes

  • Fixes replacing a command by calling CommandAPI.unregister() not working under certain circumstances
  • Fixes custom namespaces not working
  • Fixes an issue where registering or unregistering many commands at runtime could time out the server

New Features

  • #642 Adds the enable-networking and the make-networking-exceptions-warning config options. You can read more about them in the documentation.
11.1.0Релиз1.21.9, 1.21.10, 1.21.11 · 16 декабря 2025 г.

Minecraft Version Changes

  • Adds support for Minecraft 1.21.11

Bug Fixes

  • Fixes replacing a command by calling CommandAPI.unregister() not working under certain circumstances
  • Fixes custom namespaces not working
  • Fixes an issue where registering or unregistering many commands at runtime could time out the server

New Features

  • #642 Adds the enable-networking and the make-networking-exceptions-warning config options. You can read more about them in the documentation.
11.1.0Релиз1.21.9, 1.21.10, 1.21.11 · 16 декабря 2025 г.

Minecraft Version Changes

  • Adds support for Minecraft 1.21.11

Bug Fixes

  • Fixes replacing a command by calling CommandAPI.unregister() not working under certain circumstances
  • Fixes custom namespaces not working
  • Fixes an issue where registering or unregistering many commands at runtime could time out the server

New Features

  • #642 Adds the enable-networking and the make-networking-exceptions-warning config options. You can read more about them in the documentation.
11.0.0Релиз1.21.7, 1.21.8, 1.21.9 · 4 октября 2025 г.

Minecraft Version Changes

  • Adds support for Minecraft 1.21.9 and 1.21.10
  • Drops support for Minecraft 1.20.5 and below on Paper

Bug Fixes

  • #631 Fixes unregistered commands reappearing after a minecraft:reload. This comes with some other notable changes around command registrations and unregistrations. You can read about these on the command unregistration page in the documentation.
  • #608 The RecipeArgument no longer throws any exceptions on Spigot
  • #494, #503 Fixes the ConcurrentModificationException from happening when registering/unregistering commands at runtime

Module Changes

  • #414, #517 Splits up the CommandAPI into modules specific for Paper and Spigot:
  • Removes the commandapi-bukkit-shade module and the commandapi-bukkit-shade-mojang-mapped module
  • Adds the commandapi-paper-core and the commandapi-paper-shade modules which are made to work on Paper
  • Adds the commandapi-spigot-core and the commandapi-spigot-shade modules which are made to work on Spigot
  • Adds the commandapi-paper-test-toolkit and the commandapi-spigot-test-toolkit which are replacing commandapi-bukkit-test-toolkit for Paper and Spigot respectively
  • Moves and adds a few Kotlin DSL modules:
    • commandapi-core-kotlin -> commandapi-kotlin-core
    • commandapi-bukkit-kotlin -> commandapi-kotlin-bukkit
    • commandapi-velocity-kotlin -> commandapi-kotlin-velocity
    • Newly added: commandapi-kotlin-paper
    • Newly added: commandapi-kotlin-spigot

New features

  • On Paper it is now possible to register commands at bootstrap

API Changes

  • Changes the CommandAPIBukkitConfig class into an abstract one in favour of the newly added CommandAPIPaperConfig or CommandAPISpigotConfig classes, depending on the modules you use
  • The FloatRangeArgument has been renamed to DoubleRangeArgument and now returns a DoubleRange
  • The PlayerArgument and OfflinePlayerArgument have been replaced by the PlayerProfileArgument which returns a List<PlayerProfile>. The PlayerProfile class changes depending on if you are on Paper or on Spigot. Use the EntitySelectorArgument.OnePlayer if you want a Player object.
  • The AsyncOfflinePlayerArgument has been replaced by the AsyncPlayerProfileArgument
  • The ChatArgument, ChatComponentArgument and ChatColorArgument do no longer have any Adventure prefixes and return different types depending on the platform.
  • The ChatArgument returns a SignedMessage object on Paper. Also resolves #381
  • The BlockStateArgument now returns a BlockState object instead of a BlockData object

Config Changes

  • Replaces the use-latest-nms-version and be-lenient-for-minor-versions config options with a fallback-to-latest-nms config option:
    • When loading the CommandAPI and this config option is set to true it will first check if the current version is supported and chooses that
    • In case the current version isn't a supported version, the CommandAPI will choose the latest nms version available which might or might not work correctly
    • This config option is set to true by default on Paper and false on Spigot
11.0.0Релиз1.21.7, 1.21.8, 1.21.9 · 4 октября 2025 г.

Minecraft Version Changes

  • Adds support for Minecraft 1.21.9 and 1.21.10
  • Drops support for Minecraft 1.20.5 and below on Paper

Bug Fixes

  • #631 Fixes unregistered commands reappearing after a minecraft:reload. This comes with some other notable changes around command registrations and unregistrations. You can read about these on the command unregistration page in the documentation.
  • #608 The RecipeArgument no longer throws any exceptions on Spigot
  • #494, #503 Fixes the ConcurrentModificationException from happening when registering/unregistering commands at runtime

Module Changes

  • #414, #517 Splits up the CommandAPI into modules specific for Paper and Spigot:
  • Removes the commandapi-bukkit-shade module and the commandapi-bukkit-shade-mojang-mapped module
  • Adds the commandapi-paper-core and the commandapi-paper-shade modules which are made to work on Paper
  • Adds the commandapi-spigot-core and the commandapi-spigot-shade modules which are made to work on Spigot
  • Adds the commandapi-paper-test-toolkit and the commandapi-spigot-test-toolkit which are replacing commandapi-bukkit-test-toolkit for Paper and Spigot respectively
  • Moves and adds a few Kotlin DSL modules:
    • commandapi-core-kotlin -> commandapi-kotlin-core
    • commandapi-bukkit-kotlin -> commandapi-kotlin-bukkit
    • commandapi-velocity-kotlin -> commandapi-kotlin-velocity
    • Newly added: commandapi-kotlin-paper
    • Newly added: commandapi-kotlin-spigot

New features

  • On Paper it is now possible to register commands at bootstrap

API Changes

  • Changes the CommandAPIBukkitConfig class into an abstract one in favour of the newly added CommandAPIPaperConfig or CommandAPISpigotConfig classes, depending on the modules you use
  • The FloatRangeArgument has been renamed to DoubleRangeArgument and now returns a DoubleRange
  • The PlayerArgument and OfflinePlayerArgument have been replaced by the PlayerProfileArgument which returns a List<PlayerProfile>. The PlayerProfile class changes depending on if you are on Paper or on Spigot. Use the EntitySelectorArgument.OnePlayer if you want a Player object.
  • The AsyncOfflinePlayerArgument has been replaced by the AsyncPlayerProfileArgument
  • The ChatArgument, ChatComponentArgument and ChatColorArgument do no longer have any Adventure prefixes and return different types depending on the platform.
  • The ChatArgument returns a SignedMessage object on Paper. Also resolves #381
  • The BlockStateArgument now returns a BlockState object instead of a BlockData object

Config Changes

  • Replaces the use-latest-nms-version and be-lenient-for-minor-versions config options with a fallback-to-latest-nms config option:
    • When loading the CommandAPI and this config option is set to true it will first check if the current version is supported and chooses that
    • In case the current version isn't a supported version, the CommandAPI will choose the latest nms version available which might or might not work correctly
    • This config option is set to true by default on Paper and false on Spigot

Комментарии

Загружаем…