Skip to content

Latest commit

 

History

History
executable file
·
51 lines (37 loc) · 1.81 KB

introduction.mdx

File metadata and controls

executable file
·
51 lines (37 loc) · 1.81 KB
slug description
/dev/command-api/basics/introduction
A guide to Paper's Brigadier command API.

Introduction to Brigadier Commands

Paper's command system is built on top of Minecraft's Brigadier command system. This system provides a powerful and flexible way to define commands and arguments. It offers many advantages above the previously widely used Bukkit command system:

  • Less parsing or error checking required by the developer for arguments.
  • Better user experience with client error checking.
  • Integration with reload events, allowing the definition of commands usable in datapacks.
  • Easier creation of subcommands.

:::danger[Experimental]

Paper's command system is still experimental and may change in the future.

:::

:::info

To see a comparison between the new Brigadier system and the old Bukkit system, click here.

:::

Guide

The following sites are worth-while to look through first when learning about Brigadier:

For a reference of more advanced arguments, you should look here:

:::danger[Future pages]

The following pages will be added to the documentation in the future:

  • Custom Arguments
  • Tutorial: Creating Utility Commands
  • The Command Dispatcher
  • Forks and Redirects
  • Tutorial: Extending the vanilla execute command

:::

Additional support

For support regarding the command API, you can always ask in our Discord Server in the #paper-dev channel!