Minecraft:Brigadier

Template:Exclusive Template:Infobox program Brigadier is a Minecraft:command parser and dispatcher, designed and developed for Template:El,<ref>Template:Link</ref> mainly maintained by Minecraft:Dinnerbone.<ref>Template:Link</ref> It is the first library used by Java Edition that Minecraft:Mojang has released under an open-source license.<ref>Template:Tweet</ref>

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.<ref>Template:Link</ref>
• Modify/fork command source in command contexts
  • Template:Cmd may modify the command source to be multiple when multiple entities are selected
• Active inspection on command parsing<ref>Template:Link</ref>
• Listing all possible commands from current command node<ref>Template:Link</ref>
• Handle command result real-time on execution success/failure
  • Template:Cmd can store the command result to block/entity NBT data or Minecraft:scoreboard
• Recursive command node redirection
  • Template:Cmd 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 Template:Command, Template:Command, and floating-point data types such as Template:Command, making many integer values parsed in the commands inaccessible.

Minecraft argument types

Template:Disclaimer 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.

Argument types

Class name	Description	Example
Commands.literal	A fixed keyword that must be typed exactly.	/datapack list
StringArgumentType.greedyString	Will match the longest possible string of letters (only works at the very end of a command).	/say all of this will be in the greedy string
StringArgumentType.word	Will match the longest string of letters without spaces.	/tag @s add oneword
StringArgumentType.string	Will match the longest string of letters without spaces, unless surrounded by quotation marks. Similar to greedyString, but can have more arguments afterwards.	/datapack enable "multiple words" last
BoolArgumentType.bool	Can only be true or false.	/gamerule keepInventory true
IntegerArgumentType.integer	A Java int. Must be a whole number. This argument can optionally have a minimum value, or a minimum and maximum value.	/scoreboard players set @s objective 100
LongArgumentType.longArg	A Java long. Must be a whole number. Similar to int, but can store much larger numbers. This argument can optionally have a minimum value, or a minimum and maximum value.	Not used in any commands
FloatArgumentType.floatArg	A Java float (6 digits of precision). Can have decimals. This argument can optionally have a minimum value, or a minimum and maximum value.	/playsound minecraft:ambient.cave master @s ~ ~ ~ 1.23456
DoubleArgumentType.doubleArg	A Java double (15 digits of precision). Can have decimals. This argument can optionally have a minimum value, or a minimum and maximum value.	/attribute @s minecraft:generic.movement_speed base set 12.345678912345

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

History

Version history

Version	Date	Changes
1.0.15	September 26, 2018<ref>Template:Cite</ref>	Initial release
1.0.17	February 19, 2019<ref>Template:Cite</ref>	Allow single quotes in strings Added long argument Implement calculation of suggestions for any text position No longer depend on Guava
1.0.18	July 16, 2021<ref>Template:Cite</ref>	Performance optimizations

Gallery

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

See also

• Minecraft:DataFixerUpper: Another open-source library used for updating Template:El's saves across data versions.