Brigadier

Brigadier
Author(s)	Mojang Studios
Written in	Java
Latest release	1.0.18
License	MIT License
Source code	brigadier

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

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

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.
• 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
• Listing all possible commands from current command node
• 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.

Since 1.15, whenever the chat cursor is positioned at the start of a node after a whitespace character, command suggestion will say "Incorrect argument for command at position <position number>" instead of displaying the command suggestions, especially the command arguments that requires numbers or strings before parsing and the trailing spaces beyond the command argument list.

History

October 25, 2014					Dinnerbone mentions Brigadier in the comments on MC-10880.
July 27, 2017					Dinnerbone discloses a non-obfuscated command parser library called "brigadier".
Java Edition
1.13 {{Extension DPL}}<ul><li>[[Fish|Fish]]<br/>{{About|the type of mob|the action|Fishing}} '''Fish''' are aquatic creatures that are found in [[river]] and [[ocean]] biomes. == Mobs == There are four categories of fish mobs in ''Minecraft'': *{{EntityLink|Cod}} *{{EntityLink|Salmon}} *{{EntityLink|Pufferfish}} *{{EntityLink|Tropical Fish}} - many color and pattern varieties In addition, there are other fish-like mobs that have different characteristics from fish: {{EntityLink|Axolotl}}, {{EntityLink|Guardian}}, and {{EntityLink|Elder Guardian}}. ==Obtaining and transporting== A live fish can be captured by using a [[water bucket]] on a fish, to obtain a [[bucket of fish]], which is the only way to obtain the live mob in item form. Using the bucket of fish on a water source block transfers the fish from the bucket to the body of water. A water bucket may also be used on [[axolotl]]s in this manner. ==Items== Fish exist in several different item forms. Upon death, fish drop their item form equivalent (cooked if on fire), with a chance to drop a [[bone]]{{only|bedrock}} or [[bone meal]].{{only|java}} ;Non-living *{{ItemLink|Raw Cod}} *{{ItemLink|Cooked Cod}} *{{ItemLink|Raw Salmon}} *{{ItemLink|Cooked Salmon}} *{{ItemLink|Pufferfish|link=Pufferfish (item)}} *{{ItemLink|Tropical Fish|link=Tropical Fish (item)}} ;Living *{{ItemLink|Bucket of Cod}} *{{ItemLink|Bucket of Salmon}} *{{ItemLink|Bucket of Pufferfish}} *{{ItemLink|Bucket of Tropical Fish}} == Spawning == Various fish can be found in different [[ocean]] [[biomes]], but only [[salmon]] appear in rivers. Fish can also spawn in player-created bodies of water, as long as they are within a river or ocean biome. {| class="wikitable sortable" style="text-align:left" data-description="Fish biomes" !'''Fish''' ! style="text-align:left" |{{BiomeLink|Warm Ocean}} ! style="text-align:left" |{{BiomeLink|Lukewarm Ocean}}<br>{{BiomeLink|Deep Lukewarm Ocean}} ! style="text-align:left" |{{BiomeLink|Ocean}}<br>{{BiomeLink|Deep Ocean}} ! style="text-align:left" |{{BiomeLink|Cold Ocean}}<br>{{BiomeLink|Deep Cold Ocean}} ! style="text-align:left" |{{BiomeLink|Frozen Ocean}}<br>{{BiomeLink|Deep Frozen Ocean}} ! style="text-align:left" |{{BiomeLink|River}}<br>{{BiomeLink|Frozen River}} |- ! rowspan=2 style="text-align:left" |{{EntityLink|Cod}} | rowspan=2 {{tc|no}} | rowspan=2 {{tc|yes}} | rowspan=2 {{tc|yes}} | rowspan=2 {{tc|yes}} | {{tc|no|No{{only|je|short=1}}}} | rowspan=2 {{tc|no}} |- | {{tc|yes|Yes{{only|be|short=1}}}} |- ! rowspan=2 style="text-align:left" |{{EntityLink|Salmon}} | rowspan=2 {{tc|no}} | {{tc|no|No{{only|je|short=1}}}} | {{tc|no|No{{only|je|short=1}}}} | rowspan=2 {{tc|yes}} | rowspan=2 {{tc|yes}} | rowspan=2 {{tc|yes}} |- | {{tc|yes|Yes{{only|be|short=1}}}} | {{tc|yes|Yes{{only|be|short=1}}}} |- ! rowspan=2 style="text-align:left" |{{EntityLink|Pufferfish}} | rowspan=2 {{tc|yes}} | {{tc|yes|Yes{{only|je|short=1}}}} | rowspan=2 {{tc|no}} | rowspan=2 {{tc|no}} | rowspan=2 {{tc|no}} | rowspan=2 {{tc|no}} |- | {{tc|no|No{{only|be|short=1}}}} |- ! style="text-align:left" |{{EntityLink|Tropical Fish}}<ref group="note">Also spawns in {{BiomeLink|Lush Caves}} at any Y-level.</ref> | {{tc|yes}} | {{tc|yes}} | {{tc|no}} | {{tc|no}} | {{tc|no}} | {{tc|no}} |- ! style="text-align:left" |{{EntityLink|Squid}} | {{tc|yes}} | {{tc|yes}} | {{tc|yes}} | {{tc|yes}} | {{tc|yes}} | {{tc|yes}} |- ! rowspan=2 style="text-align:left" |{{EntityLink|Dolphin}} | rowspan=2 {{tc|yes}} | rowspan=2 {{tc|yes}} | rowspan=2 {{tc|yes}} | {{tc|no|No{{only|je|short=1}}}} | rowspan=2 {{tc|no}} | rowspan=2 {{tc|no}} |- | {{tc|yes|Yes{{only|be|short=1}}}} |} {{notelist}} In ''Java Edition'', fish can spawn inside a water block at Y-level 50 to 63 (from 13 blocks below sea level up to inside the block one above it), that also has water above and below it. The spawn block and the block below can be any kind of water, such as a source block, falling water, bubble column, kelp, or even a waterlogged block (as long as the fish can be placed at the bottom center of the spawn block without colliding with anything solid). The block above must be pure water, such as a source block, falling water, or flowing water of any depth. Particularly, the block above cannot also be a bubble column, so fish no longer spawn inside bubble elevators.<ref>{{cite bug|MC|244683|Tropical fish spawn in bubble columns (fixed in 22w07a)}}</ref> ''Bedrock Edition'' does permit fish to spawn in bubble columns.<ref>{{cite bug|MCPE|73967|Squids, Dolphins, and fish not spawning in bubble columns (fixed in 1.16.20)}}</ref> Fish can spawn between 24 and 64 block spherical range away from the player.{{only|java}} === Despawning === As of [[1.16]], fish can despawn at range of 40 blocks or more from the player, and will instantly despawn more than 64 blocks away, except when spawned using a [[bucket of fish]]. {{Items}} {{Entities}} [[cs:Ryba]] [[de:Fisch (Begriffsklärung)]] [[es:Pez]] [[fr:Poisson]] [[it:Pesce]] [[ja:魚]] [[ko:물고기]] [[nl:Vis]] [[pl:Ryba (ujednoznacznienie)]] [[pt:Peixe]] [[ru:Рыба]] [[th:ปลา (แก้ความกำกวม)]] [[uk:Риба]] [[zh:鱼]]</li><li>[[A Very Fine Item|A Very Fine Item]]<br/>{{Joke feature}} {{Item | image = A Very Fine Item.png | renewable = No | stackable = Yes (64) }} '''A very fine item''' was a joke item from [[Java Edition 20w14∞]], found only in the {{code|isolation}} dimension. == Appearance == The texture of a very fine item resembles the side face of a grass block with the words "Home Sweet Home" written on it. Unlike most items, its texture is 64x64 pixels, rather than the usual 16x16. == Obtaining == === Dimension === A very fine item can only be obtained from an item frame in the {{Code|isolation}} dimension. There is a maximum of 1 fine item that can be found legitimately in any world. === Cheats/Creative mode === This item can't be found in the creative inventory, but it can be middle-click duplicated in creative mode or given with the {{Code|code=give <target> minecraft:fine_item <amount>}} command. == Usage == This item cannot be placed or used in any way other than a trophy. It can still be inserted and/or rotated inside of an item frame. == Data values == === ID === {{ID table |showforms=y |generatetranslationkeys=java |displayname=A Very Fine Item |spritetype=item |nameid=fine_item |form=item |foot=1}} == History == {{History|java}} {{History||20w14∞|[[File:A Very Fine Item.png|32px]] Added a very fine item.}} {{History|foot}} == Gallery == <gallery> File:isolation biome.png|The Easter Egg dimension that the item spawns in. </gallery> == References == {{reflist}} {{Items}} {{Jokes}} [[Category:Non-renewable resources]] [[Category:Joke items]] [[es:A Very Fine Item]] [[pt:Um item muito bom]]</li></ul>		17w45a			Commands are now handled with Brigadier.
					Minecraft introduces Brigadier as a dependency.
September 26, 2018					Brigadier is open sourced under the MIT License.
1.14 {{Extension DPL}}<ul><li>[[:Category:Dyes|Category:Dyes]]<br/>These are items that can be used to dye sheep, wool blocks, or combined to make other dyes. [[Category:Items]] [[es:Categoría:Tintes]] [[fr:Catégorie:Teinture]] [[hu:Kategória:Festékek]] [[zh:Category:染料]]</li><li>[[Beetroot Seeds|Beetroot Seeds]]<br/>{{Block | group = Age 0 | 1-1 = Beetroots Age 0.png | 1-2 = Beetroots Age 0 BE.png | group2 = Age 1 | 2-1 = Beetroots Age 1.png | 2-2 = Beetroots Age 1 BE.png | group3 = Age 2 | 3-1 = Beetroots Age 2.png | 3-2 = Beetroots Age 2 BE.png | group4 = Age 3 | 4-1 = Beetroots Age 3.png | 4-2 = Beetroots Age 3 BE.png |image=Beetroot Seeds JE2 BE2.png |transparent=Yes |light=No |tool=Any |renewable=Yes |stackable=Yes (64) |flammable=No |lavasusceptible=No }} '''Beetroot seeds''' are items that can be used to plant beetroot crops. '''Beetroot crops''' are planted in [[farmland]] and used to grow [[beetroot]] and beetroot seeds. == Obtaining == === Natural generation === [[Village]] farms have a chance of growing beetroot. The exact chance depends on the village: {| class="wikitable" ! Village style !! Chance |- | {{EnvSprite|desert-village}} Desert || 20% |- | {{EnvSprite|plains-village}} Plains || 5% |} === Breaking === Harvesting fully-grown beetroot yields from 1 to 4 seeds per crop harvested ({{frac|2|5|7}} seeds per crop harvested on average). The [[Fortune]] enchantment can be used to improve the drop rate. === Chest loot === {{LootChestItem|beetroot-seeds}} === Trading === Beetroot seeds are sold by [[wandering trader]]s for one [[emerald]]. == Usage == === Farming === Beetroot seeds can be placed on [[farmland]]. After being placed, it goes through four stages of growth. When fully grown it can be broken to produce beetroot seeds and beetroots. <!-- Java Edition only? -->While beetroot crops have only four growth stages compared to eight for [[wheat]], [[carrot]]s, and [[potato]]es, each growth tick has a {{frac|1|3}} chance of not advancing the growth stage and therefore beetroot grows slightly faster than other crops. Crops grow faster if the farmland they are planted in is [[Farmland#Hydration|hydrated]]. One application of [[bonemeal]] has a 75% chance of advancing growth by one stage. This is less effective than for other crops: an average of {{frac|5|1|3}} are needed to fully grow beetroot compared to {{frac|2|2|7}} for other crops. === Breeding === Like other [[seeds]], beetroot seeds can be used to [[breed]] [[chicken]]s, lead chickens around, and make baby chickens grow up faster by 10% of the remaining time. === Taming === Like other seeds, beetroot seeds can be used to tame [[parrot]]s. === Composting === Placing beetroot seeds into a [[composter]] has a 30% chance of raising the compost level by 1. === Trading === [[Wandering trader]]s may offer to sell beetroot seeds for one emerald. == Sounds == {{Edition|Java}}: {{Sound table/Block/Crop/JE}} {{Edition|Bedrock}}: {{Sound table/Block/Wood/BE}} == Data values == === ID === {{edition|java}}: {{ID table |edition=java |showblocktags=y |showforms=y |generatetranslationkeys=y |displayname=Beetroots |spritetype=block |nameid=beetroots |blocktags=bee_growables, crops |form=block}} {{ID table |displayname=Beetroot Seeds |spritetype=item |nameid=beetroot_seeds |form=item |foot=1}} {{edition|bedrock}}: {{ID table |edition=bedrock |shownumericids=y |showforms=y |generatetranslationkeys=y |displayname=Beetroots |spritetype=block |nameid=beetroot |id=244 |form=block |itemform=item.beetroot}} {{ID table |displayname=Beetroot Seeds |spritetype=item |nameid=beetroot_seeds |id=295 |form=item |foot=1}} === Block states === {{see also|Block states}} {{/BS}} == Advancements == {{load advancements|A Seedy Place}} == History == {{History|java}} {{History||1.9|snap=15w31a|[[File:Beetroot Seeds JE1 BE1.png|32px]] Added beetroot seeds. |[[File:Beetroots Age 0 JE1.png|32px]] [[File:Beetroots Age 1 JE1.png|32px]] [[File:Beetroots Age 2 JE1.png|32px]] [[File:Beetroots Age 3 JE1.png|32px]] Added beetroot crops. |Beetroot seeds can be found in [[end city]] [[chest]]s. |Beetroot plants naturally generate in [[village]] farms. |[[Villager]]s are able to harvest beetroot crops, but they are not yet able to pick up the seeds and plant them.}} {{History|||snap=15w38a|The [[drop]] chances have been greatly improved from the average {{frac|4|5}} per beetroot crop harvested to 2. |Villagers are now able to pick up and plant beetroot seeds.}} {{History|||snap=15w44a|Beetroots now generate in [[dungeon]] and [[mineshaft]] chests.}} {{History||1.11|snap=16w39a|Beetroot seeds are now found in the new [[woodland mansion]] chests.}} {{History||1.12|snap=17w18b|Placing a beetroot seeds in farmland now gives the player the "A Seedy Place" [[advancement]].{{verify}}}} {{History||1.13|snap=17w47a|Prior to [[1.13/Flattening|''The Flattening'']], this item's numeral ID was 458 and block's numeral ID was 244.}} {{History||1.14|snap=18w43a|[[File:Beetroot Seeds JE2 BE2.png|32px]] The texture of beetroot seeds has been changed. |[[File:Beetroots Age 0 JE2.png|32px]] [[File:Beetroots Age 1 JE2.png|32px]] [[File:Beetroots Age 2 JE2.png|32px]] [[File:Beetroots Age 3 JE2.png|32px]] The textures of beetroot crops have been changed.}} {{History|||snap=18w49a|Beetroot seeds can now be found in chests in [[snowy tundra]] village houses.}} {{History|||snap=19w03a|Placing beetroot seeds into the new [[composter]] has a 10% chance of raising the compost level by 1.}} {{History|||snap=19w05a|Beetroot seeds now have a 30% chance of increasing the compost level in a composter. |Added [[Wandering Trader|wandering trader]]s, which sell beetroot seeds.}} {{History||1.15|snap=19w34a|[[Bee]]s can now pollinate beetroot crops.}} {{History||1.17|snap=21w13a|[[File:Beetroots Age 0 JE3.png|32px]] [[File:Beetroots Age 1 JE3.png|32px]] [[File:Beetroots Age 2 JE3.png|32px]] [[File:Beetroots Age 3 JE3.png|32px]] The "crop" template model has changed such that pixels appear in the same physical positions on opposite sides of texture planes, changing the beetroot crop's appearance in the process.<ref>{{bug|MC-199242|||Fixed}}</ref>}} {{History||1.18|snap=Pre-release 5|[[File:Beetroot Seeds JE3.png|32px]] The texture of beetroot seeds has been changed.}} {{History||1.20|snap=23w12a|Beetroot seeds can now be found in [[suspicious gravel]] and [[suspicious sand]] in [[trail ruins]].}} {{History|||snap=23w16a|Beetroot seeds no longer generates in [[suspicious sand]] in [[trail ruins]].|Due to the split of the archaeological loot tables for the suspicious gravel within the [[trail ruins]]; beetroot seeds now are in the common loot.}} {{History|pocket alpha}} {{History||November 14, 2013|link=https://twitter.com/jbernhardsson/status/400902957782147072|[[Johan Bernhardsson]] previewed an image of beetroot seeds.}} {{History||v0.8.0|snap=build 2|[[File:Beetroot Seeds JE1 BE1.png|32px]] Added Beetroots seeds. |[[File:Beetroots Age 0 JE1 BE1.png|32px]] [[File:Beetroots Age 1 JE1 BE1.png|32px]] [[File:Beetroots Age 2 JE1 BE1.png|32px]] [[File:Beetroots Age 3 JE1 BE1.png|32px]]{{verify|Correct models?}} Added Beetroots crops.}} {{History|||snap=build 3|Beetroots seeds now have a chance of dropping when tilling [[grass block]]s.}} {{History||v0.11.0|snap=build 1|"Beetroots seeds" have been renamed to "Beetroot Seeds" and the capitalization has now also been fixed.<ref>{{bug|MCPE-7953|||Fixed}}</ref>}} {{History||v0.12.1|snap=build 1|Beetroot seeds no longer have a chance of dropping when tilling [[grass block]]s.}} {{History||v0.14.0|snap=build 1|Beetroot seeds can now be found in [[minecart with chest]]s inside of [[mineshaft]]s.}} {{History||v0.16.2|Beetroot seeds can now be found in [[chest]]s inside the large house in [[ice plains]] and [[cold taiga]] [[village]]s.}} {{History|pocket}} {{History||1.0.0|snap=alpha 0.17.0.1|Beetroot seeds can now be found in the [[chest]]s of [[dungeon]]s and [[end city|end cities]].}} {{History||1.1.0|snap=alpha 1.1.0.0|Beetroot seeds can now be found in [[woodland mansion]] chests.}} {{History|bedrock}} {{History||1.2.0|snap=beta 1.2.0.2|Beetroot seeds can now be found inside [[bonus chest]]s. |Beetroot seeds can now be used to tame [[parrot]]s.}} {{History||1.10.0|snap=beta 1.10.0.3|[[File:Beetroot Seeds JE2 BE2.png|32px]] The texture of beetroot seeds has been changed. |[[File:Beetroots Age 0 JE2.png|32px]] [[File:Beetroots Age 1 JE2.png|32px]] [[File:Beetroots Age 2 JE2.png|32px]] [[File:Beetroots Age 3 JE2.png|32px]]{{verify|Correct models?}} The textures of beetroot crops have been changed. |Beetroot seeds are now [[trading|sold]] by the new [[wandering trader]]s.}} {{History||1.11.0|snap=beta 1.11.0.1|Beetroot seeds can now be used to fill the [[composter]]. |Beetroot seeds can now be found in [[snowy tundra]] [[village]] house [[chest]]s.}} {{History||1.14.0|snap=beta 1.14.0.1|[[Bee]]s can now pollinate beetroot crops.}} {{History||?|[[File:Beetroots Age 0 BE.png|32px]] [[File:Beetroots Age 1 BE.png|32px]] [[File:Beetroots Age 2 BE.png|32px]] [[File:Beetroots Age 3 BE.png|32px]] Potato crop planes use a mapping that results in very unnatural mirroring when viewed from certain angles, such as northwest.<ref>{{bug|MCPE-146936}}</ref>}} {{History|console}} {{History||xbox=TU43|xbone=CU33|ps=1.36|wiiu=Patch 13|[[File:Beetroot Seeds JE1 BE1.png|32px]] Added beetroot seeds. |[[File:Beetroots Age 0 JE1 BE1.png|32px]] [[File:Beetroots Age 1 JE1 BE1.png|32px]] [[File:Beetroots Age 2 JE1 BE1.png|32px]] [[File:Beetroots Age 3 JE1 BE1.png|32px]]{{verify|Correct models?}} Added beetroot crops.}} {{History||xbox=none|xbone=none|ps=1.90|wiiu=none|switch=none|[[File:Beetroot Seeds JE2 BE2.png|32px]] The texture of beetroot seeds has been changed. |[[File:Beetroots Age 0 JE2.png|32px]] [[File:Beetroots Age 1 JE2.png|32px]] [[File:Beetroots Age 2 JE2.png|32px]] [[File:Beetroots Age 3 JE2.png|32px]]{{verify|Correct models?}} The textures of beetroot crops have been changed.}} {{History|New 3DS}} {{History||0.1.0|[[File:Beetroot Seeds JE1 BE1.png|32px]] Added beetroot seeds. |[[File:Beetroots Age 0 JE1 BE1.png|32px]] [[File:Beetroots Age 1 JE1 BE1.png|32px]] [[File:Beetroots Age 2 JE1 BE1.png|32px]] [[File:Beetroots Age 3 JE1 BE1.png|32px]]{{verify|Correct models?}} Added beetroot crops.}} {{History|foot}} == Issues == {{issue list}} == Gallery == <gallery> Beetrootstwitpic.png|The first image released of beetroot seeds. Village Wheat Beetroot Farm.png|Beetroots generated in a [[village]]. File:Beetroot farm.png|A beetroot garden. </gallery> == References == <references /> {{Blocks|vegetation}} {{Items}} [[Category:Plants]] [[Category:Food]] [[Category:Generated structure blocks]] [[Category:Non-solid blocks]] [[cs:Semínka červené řepy]] [[es:Semillas de remolacha]] [[fr:Graines de betterave]] [[it:Semi di barbabietola]] [[ja:ビートルートの種]] [[ko:비트 씨앗]] [[nl:Bietenzaden]] [[pl:Nasiona buraka]] [[pt:Sementes de beterraba]] [[ru:Семена свёклы]] [[th:เมล็ดบีตรูท]] [[zh:甜菜种子]]</li></ul>		19w08a			Now allows single quotes for strings in commands.

Version history

Version	Date	Changes
1.0.15	September 26, 2018	Initial release
1.0.17	February 19, 2019	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	Peformance optimizations

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)