Brigadier

This feature is exclusive to Java Edition.

 

{
    "title": "Brigadier",
    "rows": [
        {
            "field": "(link to File:Mojang Studios logo.svg article, displayed as x20px|link=Mojang Studios) (link to Mojang Studios article, displayed as Mojang Studios)",
            "label": "Author(s)"
        },
        {
            "field": "?",
            "label": "Platform(s)"
        },
        {
            "field": "(link to wikipedia:Java (programming language) article, displayed as Java)",
            "label": "Written in"
        },
        {
            "field": "[https://github.com/Mojang/brigadier/releases/latest 1.0.18]",
            "label": "Latest version"
        },
        {
            "field": "?",
            "label": "Release date"
        },
        {
            "field": "?",
            "label": "Size"
        },
        {
            "field": "MIT License",
            "label": "License"
        },
        {
            "field": "[https://github.com/Mojang/brigadier/ Yes]",
            "label": "<span style=\"white-space:normal\">Source available</span>"
        }
    ],
    "invimages": [],
    "images": []
}

	“	I'm so proud of that name! Brigadier is the name of the command engine that Minecraft uses.	„
		— Dinnerbone on Brigadier[1]

Brigadier is a command parser and dispatcher, designed and developed for Java Edition,^[2] mainly maintained by Dinnerbone.^[3] It is the first library used by Java Edition that Mojang has released under an open-source license.^[4]

Usage

Brigadier is used for parsing and executing string commands.

Features

• Define command nodes with argument or literal branches
  • All the commands available in Java Edition are actually the literal branches available for the root command nodes instead of the actual executed commands.^[5]
• Modify/fork command source in command contexts
  • /execute as <target selector> may modify the command source to be multiple when multiple entities are selected
• Active inspection on command parsing^[6]
• Listing all possible commands from current command node^[7]
• Handle command result real-time on execution success/failure
  • /execute store can store the command result to block/entity NBT data or scoreboard
• Recursive command node redirection
  • /execute run redirects to the root node of the vanilla command dispatcher

Limitations and issues

Brigadier has various numbers of limitations while executing the command, such as the numeric limitations on integer data types such as /effect, /weather, and floating-point data types such as /time, making many integer values parsed in the commands inaccessible.

Minecraft argument types

The contents of this section are not supported by Mojang Studios or the Minecraft Wiki.

More general documentation on brigadier and its use can be found at the github repository, however this is information specifically on the argument types added and used in Minecraft. While basic implementation of commands may vary by mod loader, these argument types are mostly consistent. Your chosen mod loader probably has its own documentation for how to actually register commands using Brigadier.

(See more about Java ints, longs, floats and doubles here)

History

Version history

Gallery

• 
  The /execute command tree, which utilizes an overwhelming amount of the brigadier features.
• 
  The /tag command tree, showing the difference between actual executed commands (red nodes) versus the first literal after the root (the "tag" box)
• 
  The /msg command tree, showing that aliases have been implemented by brigadier's command node redirection functionality (dashed lines)

References

Navigation