CommandAPI

<h2 align="center"> <br> <img src="images/cmdapi.svg" alt="CommandAPI logo" width="600"> <br> <br> A Bukkit/Spigot API to use the command UI introduced in Minecraft 1.13 <br> </h2> <div align="center">

<br> <br>

</div>

Support and Project Discussion:

• <img width="20px" src="https://cdn3.iconfinder.com/data/icons/popular-services-brands-vol-2/512/discord-512.png"></img> Discord
• <img width="20px" src="https://static.spigotmc.org/img/spigot.png"></img> Spigot page
• <img width="20px" src="https://i.imgur.com/o104U27.png"></img> Modrinth page
• <img width="20px" src="https://i.imgur.com/QJnHi37.png"></img> Hangar page

Downloads & Documentation:

• <img width="20px" src="https://icon-icons.com/icons2/2348/PNG/512/download_arrow_icon_143023.png"></img> All downloads
• <img width="20px" src="https://icon-icons.com/icons2/2348/PNG/512/books_icon_143050.png"></img> Documentation (includes usage for server owners!)

Other

• <img width="20px" src="https://github.githubassets.com/images/modules/site/icons/funding_platforms/ko_fi.svg"></img> Buy me a coffee

Compatible Minecraft versions:

The list of what version of the CommandAPI you'll need to run on a specific version of Minecraft is as follows:

| Minecraft version | Compatible versions | Latest compatible<br>version | Minimum Java<br>version required<br>to run latest version | |---------------------|-----------------------------|------------------------------|-----------------------------------------------------------| | 1.13.x | v1.0 - 5.12, 8.3.0 - 8.8.0 | 8.8.0 | 16 | | 1.14.1, 1.14.2 | v2.0 - 5.12, 8.3.0 - 8.8.0 | 8.8.0 | 16 | | 1.14.3, 1.14.4 | v2.1 - 5.12, 8.3.0 - 8.8.0 | 8.8.0 | 16 | | 1.15.x | v2.3a - 5.12, 8.3.0 - 9.3.0 | 9.3.0 | 16 | | 1.16.1 | v3.0 - 5.12, 8.3.0 - 9.4.2 | 9.4.2 | 16 | | 1.16.2 | v4.0 - 5.12, 8.3.0 - 9.4.2 | 9.4.2 | 16 | | 1.16.3 | v4.2 - 5.12, 8.3.0 - 9.4.2 | 9.4.2 | 16 | | 1.16.4 | v5.2 - 5.12, 8.3.0 - 9.4.2 | 9.4.2 | 16 | | 1.16.5 | v5.7 - 7.0.0, 8.3.0 - 9.7.0 | 9.7.0 | 16 | | 1.17 | 6.0.x - 9.7.0 | 9.7.0 | 16 | | 1.17.1 | 6.1.x - 9.7.0 | 9.7.0 | 16 | | 1.18, 1.18.1 | 6.5.2 - 9.7.0 | 9.7.0 | 16 | | 1.18.2 | 6.5.4 - 9.7.0 | 9.7.0 | 16 | | 1.19 | 8.3.0 - 9.7.0 | 9.7.0 | 16 | | 1.19.1 | 8.5.0 - 9.7.0 | 9.7.0 | 16 | | 1.19.2 | 8.5.1 - 9.7.0 | 9.7.0 | 16 | | 1.19.3 | 8.7.0 - 9.7.0 | 9.7.0 | 16 | | 1.19.4 | 8.8.0 - 9.7.0 | 9.7.0 | 16 | | 1.20 | 9.0.2 - 12.0.0 | 12.0.0 | 17 | | 1.20.1 | 9.0.3 - 12.0.0 | 12.0.0 | 17 | | 1.20.2 | 9.2.0 - 12.0.0 | 12.0.0 | 17 | | 1.20.3, 1.20.4 | 9.3.0 - 12.0.0 | 12.0.0 | 17 | | 1.20.5, 1.20.6 | 9.4.0 - 12.0.0 | 12.0.0 | 17 | | 1.21 | 9.5.0 - 12.0.0 | 12.0.0 | 17 | | 1.21.1 | 9.5.2 - 12.0.0 | 12.0.0 | 17 | | 1.21.2, 1.21.3 | 9.6.0 - 12.0.0 | 12.0.0 | 17 | | 1.21.4 | 9.7.0 - 12.0.0 | 12.0.0 | 17 | | 1.21.5 | 10.0.0 - 12.0.0 | 12.0.0 | 17 | | 1.21.6 | 10.1.0 - 12.0.0 | 12.0.0 | 17 | | 1.21.7 | 10.1.1 - 12.0.0 | 12.0.0 | 17 | | 1.21.8 | 10.1.2 - 12.0.0 | 12.0.0 | 17 | | 1.21.9, 1.21.10 | 11.0.0 - 12.0.0 | 12.0.0 | 17 | | 1.21.11 | 11.1.0 - 12.0.0 | 12.0.0 | 17 | | 26.1.X | 11.2.0 - 12.0.0 | 12.0.0 | 17 | | 26.2.X | 12.0.0 | 12.0.0 | 17 |

---

Purpose

This project provides an API to help Bukkit/Spigot developers use the Minecraft 1.13 command UI, which includes:

• Better commands - Prevent players from running invalid commands, making it easier for developers - you won't get dodgy input!

  

• Better arguments - Choose from over 50 arguments including location arguments, raw JSON, enchantments, lists, particles... all fully supported with built-in error checking!

  

• Support for proxied command senders - Run your command as other entities using /execute as ... run command

  

• Argument tooltips - Let your users know exactly what their command will do using argument tooltips

  

• Support for the /execute command - Let your command to be executed by the built in /execute command, as well as command blocks!

• 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 need for Brigadier - 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!

Still not convinced? In addition to all of the above, the CommandAPI also provides:

• Built-in command converter - Convert other plugin commands into /execute-compatible ones - no code required!
• Tree-structure command registration - Like Brigadier's code format? We've got you covered