Minecraft Data Pack Advancement

Configuration file defining an advancement for a data pack for Minecraft

Type object
File match **/data/*/advancements/*.json
Schema URL https://catalog.lintel.tools/schemas/schemastore/minecraft-data-pack-advancement/latest.json
Source https://www.schemastore.org/minecraft-advancement.json

Validate with Lintel

npx @lintel/lintel check
Type: object

A data pack advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

Properties

display object

Display options for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

8 nested properties
icon object

Icon options for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

2 nested properties
item string

An item identifier for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

minLength=1
nbt string

A named binary tag of an item for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

minLength=1
title string | boolean | number | array | object
14 nested properties
extra jsonTextComponent[]

A list of additional raw JSON text components to be displayed after this one.

color string

The color to render the content in.

Any of: enum enum, variant
font string

The resource location of the font for this component in the resource pack within assets//font.

Default: "minecraft:default"
bold boolean

Whether to render the content in bold.

italic boolean

Whether to render the content in italics. Note that text that is italicized by default, such as custom item names, can be unitalicized by setting this to false.

underlined boolean

Whether to underline the content.

strikethrough boolean

Whether to strikethrough the content.

obfuscated boolean

Whether to render the content obfuscated.

insertion string

When the text is shift-clicked by a player, this string is inserted in their chat input. It does not overwrite any existing text the player was writing. This only works in chat messages.

clickEvent object

Allows for events to occur when the player clicks on text. Only work in chat messages and written books, unless specified otherwise.

2 nested properties
action string

The action to perform when clicked.

Values: "open_url" "open_file" "run_command" "suggest_command" "change_page" "copy_to_clipboard"
value string

The URL, file path, chat, command or book page used by the specified action.

hoverEvent object

Allows for a tooltip to be displayed when the player hovers their mouse over text.

3 nested properties
action string

The type of tooltip to show.

Values: "show_text" "show_item" "show_entity"
value string

The formatting and type of this tag varies depending on the action.

contents object

The formatting of this tag varies depending on the action.

text string | number | boolean

A string containing plain text to display directly. Can also be a number or boolean that is displayed directly.

translate string

A translation identifier, corresponding to the identifiers found in loaded language files. Displayed as the corresponding text in the player's selected language. If no corresponding translation can be found, the identifier itself is used as the translated text.

with jsonTextComponent[]

A list of raw JSON text components to be inserted into slots in the translation text.

frame string

A frame type for the icon for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

Default: "task"
Values: "challenge" "goal" "task"
background path

A background directory for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

description string | boolean | number | array | object
14 nested properties
extra jsonTextComponent[]

A list of additional raw JSON text components to be displayed after this one.

color string

The color to render the content in.

Any of: enum enum, variant
font string

The resource location of the font for this component in the resource pack within assets//font.

Default: "minecraft:default"
bold boolean

Whether to render the content in bold.

italic boolean

Whether to render the content in italics. Note that text that is italicized by default, such as custom item names, can be unitalicized by setting this to false.

underlined boolean

Whether to underline the content.

strikethrough boolean

Whether to strikethrough the content.

obfuscated boolean

Whether to render the content obfuscated.

insertion string

When the text is shift-clicked by a player, this string is inserted in their chat input. It does not overwrite any existing text the player was writing. This only works in chat messages.

clickEvent object

Allows for events to occur when the player clicks on text. Only work in chat messages and written books, unless specified otherwise.

2 nested properties
action string

The action to perform when clicked.

Values: "open_url" "open_file" "run_command" "suggest_command" "change_page" "copy_to_clipboard"
value string

The URL, file path, chat, command or book page used by the specified action.

hoverEvent object

Allows for a tooltip to be displayed when the player hovers their mouse over text.

3 nested properties
action string

The type of tooltip to show.

Values: "show_text" "show_item" "show_entity"
value string

The formatting and type of this tag varies depending on the action.

contents object

The formatting of this tag varies depending on the action.

text string | number | boolean

A string containing plain text to display directly. Can also be a number or boolean that is displayed directly.

translate string

A translation identifier, corresponding to the identifiers found in loaded language files. Displayed as the corresponding text in the player's selected language. If no corresponding translation can be found, the identifier itself is used as the translated text.

with jsonTextComponent[]

A list of raw JSON text components to be inserted into slots in the translation text.

show_toast boolean

Whether or not to show the toast pop up after completing the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

Default: true
annouce_to_chat boolean

Whether or not to announce in the chat when the current advancement has been completed https://minecraft.wiki/w/Advancement/JSON_format#Legend

Default: true
hidden boolean

Whether or not to hide this advancement and all its children from the advancement screen until the current advancement have been completed https://minecraft.wiki/w/Advancement/JSON_format#Legend

Default: false
parent path

A parent directory for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

criteria Record<string, object>

Required criteria have to be met for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

requirements string[][]

Requirements for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

uniqueItems=true
rewards object

Rewards for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

4 nested properties
recipes string[]

Recipes to unlock for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

uniqueItems=true
loot string[]

Loot tables to give to the player for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

uniqueItems=true
experience integer

An experience amount for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

min=0
function string

A function to run for the current advancement https://minecraft.wiki/w/Advancement/JSON_format#Legend

minLength=1

Definitions

jsonTextComponent string | boolean | number | array | object
extra jsonTextComponent[]

A list of additional raw JSON text components to be displayed after this one.

color string

The color to render the content in.

Any of: enum enum, variant
font string

The resource location of the font for this component in the resource pack within assets//font.

Default: "minecraft:default"
bold boolean

Whether to render the content in bold.

italic boolean

Whether to render the content in italics. Note that text that is italicized by default, such as custom item names, can be unitalicized by setting this to false.

underlined boolean

Whether to underline the content.

strikethrough boolean

Whether to strikethrough the content.

obfuscated boolean

Whether to render the content obfuscated.

insertion string

When the text is shift-clicked by a player, this string is inserted in their chat input. It does not overwrite any existing text the player was writing. This only works in chat messages.

clickEvent object

Allows for events to occur when the player clicks on text. Only work in chat messages and written books, unless specified otherwise.

2 nested properties
action string

The action to perform when clicked.

Values: "open_url" "open_file" "run_command" "suggest_command" "change_page" "copy_to_clipboard"
value string

The URL, file path, chat, command or book page used by the specified action.

hoverEvent object

Allows for a tooltip to be displayed when the player hovers their mouse over text.

3 nested properties
action string

The type of tooltip to show.

Values: "show_text" "show_item" "show_entity"
value string

The formatting and type of this tag varies depending on the action.

contents object

The formatting of this tag varies depending on the action.

text string | number | boolean

A string containing plain text to display directly. Can also be a number or boolean that is displayed directly.

translate string

A translation identifier, corresponding to the identifiers found in loaded language files. Displayed as the corresponding text in the player's selected language. If no corresponding translation can be found, the identifier itself is used as the translated text.

with jsonTextComponent[]

A list of raw JSON text components to be inserted into slots in the translation text.