manifest.json

The manifest.json file is what identifies a pack to Minecraft. It lives in the root folder of every behavior pack, resource pack, skin pack and world template. This page documents every section of the manifest, including the ones the beginner guide skips: dependencies, capabilities, metadata, subpacks and pack settings.

Structure ​

A manifest is a single JSON object with the following top-level keys.

Format Versions ​

The manifest has its own format_version, separate from the format versions used by other pack files (see Format Versions).

Version Formats ​

Format version 2 accepts either style below. Format version 3 only accepts strings.

"version": [1, 2, 3]   // Array style. Allowed in format_version 1 and 2 only.
"version": "1.2.3"     // SemVer string. Allowed in format_version 2 and required in 3.

Script module dependency versions are always strings, regardless of the manifest format version.

UUIDs ​

A UUID (Universally Unique Identifier) is a 36-character string of hexadecimal digits and dashes, written in the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. Minecraft uses UUIDs to tell packs apart, so every pack and every module needs its own.

Minecraft expects version 4 UUIDs, which are randomly generated. You can create them with:

• uuidgenerator.net
• uuidtools.com
• The UUID Generator extension for VSCode
• Most add-on editors such as bridge. generate them for you.

Rules ​

• Never reuse a UUID. Every pack and every module needs a different one. If two packs share a header UUID the game treats them as the same pack, which causes "Duplicate pack detected" errors or silently replaces one with the other.
• The header UUID and module UUIDs must all be different from each other, even within one manifest.
• Keep the UUID stable across updates. The header UUID is the pack's identity. Changing it makes Minecraft treat the update as a brand new pack, so worlds using the old pack will not receive the update. Bump header.version instead.
• Case does not matter. UUIDs are base 16, so A-F and a-f are equivalent. Lowercase is the convention.

Header ​

The header object describes the pack to the player and to the game.

Modules ​

modules is an array. Each entry declares one kind of content the pack contains. The module type is what makes a pack a behavior pack, resource pack, skin pack or world template.

Module Types ​

A pack may contain more than one module, for example a data module and a script module in the same behavior pack. A pack may not mix behavior and resource content: a data module and a resources module cannot share a manifest.

Dependencies ​

dependencies is an array. Each entry is either a dependency on another pack, identified by UUID, or on a built-in script module, identified by name.

Pack Dependencies ​

The most common use is a behavior pack depending on its resource pack. When the BP is added to a world, the game automatically adds the RP as well, and warns the player if it is missing. The dependency's uuid must match the RP's header.uuid exactly, and version should match the RP's header.version.

"dependencies": [
    {
        "uuid": "66c6e9a8-3093-462a-9c36-dbb052165822", // The RP's header UUID
        "version": "1.0.0"
    }
]

Script Module Dependencies ​

Any behavior pack with a script module must declare the API modules it imports. The version chooses which API surface you get. See Script API Modules for the current list of modules and versions.

"dependencies": [
    {
        "module_name": "@minecraft/server",
        "version": "2.7.0"
    },
    {
        "module_name": "@minecraft/server-ui",
        "version": "2.0.0"
    }
]

Capabilities ​

capabilities is an array of strings. Each one opts the pack into an optional engine feature.

"capabilities": ["pbr"]

Metadata ​

metadata holds information about who made the pack and how. None of it changes how the pack behaves in-game.

"metadata": {
    "authors": ["Your Name"],
    "license": "MIT",
    "url": "https://wiki.bedrock.dev",
    "product_type": "addon",
    "generated_with": {
        "bridge": ["2.7.0"]
    }
}

Subpacks ​

Subpacks let the player choose between different variations of a pack. They were designed for shipping several texture resolutions in one resource pack, so lower-memory devices load smaller textures, but they can hold any resource or behavior pack content.

How Subpacks Work ​

Files in a subpack folder override files in the pack's root when that subpack is selected. For example, if a pack contains both RP/textures/wiki/entities/ghost.png and RP/subpacks/pack_1/textures/wiki/entities/ghost.png, the second image replaces the first while pack_1 is active. Files that only exist in the root are still loaded.

For more on how files override each other, see Overwriting Vanilla Assets.

Creating Subpacks ​

Create a subpacks folder in the root of your BP or RP, then one folder per subpack inside it.

Each subpack folder is laid out exactly like a normal pack.

Subpack Manifest Fields ​

Register each folder in the subpacks array of the manifest.

{
    "format_version": 3,
    "header": {
        "name": "Pack Name",
        "description": "Pack Description",
        "uuid": "2fc2dd6f-86cb-4370-af70-21490a1ae471",
        "version": "1.0.0",
        "min_engine_version": "1.26.40"
    },
    "modules": [
        {
            "type": "resources",
            "uuid": "f6821b4a-1854-44fc-a8a4-0c2847ffda46",
            "version": "1.0.0"
        }
    ],
    "metadata": {
        "authors": ["Your Name"]
    },
    "subpacks": [
        {
            "folder_name": "subpack_1",
            "name": "Low Resolution",
            "memory_tier": 0,
            "memory_performance_tier": 1
        },
        {
            "folder_name": "subpack_2",
            "name": "High Resolution",
            "memory_tier": 12,
            "memory_performance_tier": 3
        }
    ]
}

Memory Tier Alignment ​

Microsoft publishes the following mapping between memory_performance_tier, memory_tier and typical hardware.

Subpack Selection ​

• The default subpack is the one with the highest tier the device qualifies for. If several subpacks share that tier, the last one in the array wins, so avoid giving two subpacks the same tier.
• Players can switch subpacks from the pack's settings. In the resource pack list, select the pack, press the gear icon and move the slider. Players can only move to tiers their device supports.
• Adding a single subpack still produces two slider positions: the subpack and "no subpack". Selecting "no subpack" does not make root files override anything, it simply loads the root alone.

Pack Settings ​

Pack settings add a configurable options screen to a behavior or resource pack. The screen can contain labels, toggles, sliders and dropdowns. Players reach it from the gear icon next to the pack in the world's pack list, or from Settings while in-game.

• Resource pack settings are stored per player. Each player picks their own values, and the pack reads them with Molang.
• Behavior pack settings are stored per world. The world or server owner sets them, and the pack reads them from the Script API.
• Skin packs cannot have settings.

Requirements ​

• Manifest format_version 3. Settings are ignored in format version 2.
• A min_engine_version of at least 1.21.130, which is when the Molang queries were added. The examples on this page use a newer version; any version from 1.21.130 upwards works.
• @minecraft/server for the Script API method. world.getPackSettings() is available in the current stable API.

Setting Types ​

settings is an ordered array. Entries appear on the screen in the order they are listed. Every type has a text field, which accepts a plain string or a localization key.

Label ​

Read-only text. Use it for headings, descriptions or to break the screen into sections.

Toggle ​

A true or false switch.

Slider ​

A number within a range. Integers and decimals are both allowed.

Dropdown ​

A choice between a fixed list of options.

Example ​

{
    "format_version": 3,
    "header": {
        "name": "Pack Name",
        "description": "Pack Description",
        "uuid": "7f3b2c91-5e84-4a16-bd73-91c8e52f604a",
        "version": "1.0.0",
        "min_engine_version": "1.26.40"
    },
    "modules": [
        {
            "type": "resources",
            "uuid": "c6a94725-1f3d-4e82-9b61-54e8f7a203dc",
            "version": "1.0.0"
        }
    ],
    "metadata": {
        "authors": ["Your Name"]
    },
    "settings": [
        {
            "type": "label",
            "text": "Text Settings"
        },
        {
            "type": "toggle",
            "name": "wiki:show_text",
            "text": "Show Text",
            "default": true
        },
        {
            "type": "slider",
            "name": "wiki:text_scale",
            "text": "Text Scale",
            "min": 0.5,
            "max": 2.0,
            "step": 0.1,
            "default": 1.0
        },
        {
            "type": "dropdown",
            "name": "wiki:text",
            "text": "Text Options",
            "options": [
                { "name": "text_1", "text": "This is text 1" },
                { "name": "text_2", "text": "This is text 2" },
                { "name": "text_3", "text": "This is text 3" }
            ],
            "default": "text_2"
        }
    ]
}

Reading Settings in Resource Packs ​

Resource packs read their settings with three Molang queries. They work anywhere Molang does: render controllers, animations, animation controllers, particles and entity definitions.

query.is_pack_setting_enabled('wiki:show_text')      // Toggle. Returns true or false.
query.get_pack_setting('wiki:text_scale')            // Slider. Returns the number.
query.is_pack_setting_selected('wiki:text', 'text_2') // Dropdown. True if that option is selected.

Reading Settings in Behavior Packs ​

Behavior packs read their settings with the Script API. world.getPackSettings() returns an object keyed by setting name. Toggles are booleans, sliders are numbers and dropdowns are the selected option's name string.

import { world } from "@minecraft/server";

const settings = world.getPackSettings();

if (settings["wiki:show_text"] === true) {
    const scale = settings["wiki:text_scale"]; // Number
    const option = settings["wiki:text"]; // "text_1", "text_2" or "text_3"
    world.sendMessage(`Scale ${scale}, option ${option}`);
}

Complete Examples ​

Behavior Pack ​

A behavior pack with data and scripts, depending on its resource pack and on two API modules.

{
    "format_version": 3,
    "header": {
        "name": "pack.name",
        "description": "pack.description",
        "uuid": "ee649bcf-256c-4013-9068-6a802b89d756",
        "version": "1.0.0",
        "min_engine_version": "1.26.40"
    },
    "modules": [
        {
            "type": "data",
            "uuid": "fa6e90c8-c925-460f-8155-c8a60b753caa",
            "version": "1.0.0"
        },
        {
            "type": "script",
            "language": "javascript",
            "entry": "scripts/main.js",
            "uuid": "c05a992e-482a-455f-898c-58bbb4975e47",
            "version": "1.0.0"
        }
    ],
    "dependencies": [
        {
            "uuid": "66c6e9a8-3093-462a-9c36-dbb052165822",
            "version": "1.0.0"
        },
        {
            "module_name": "@minecraft/server",
            "version": "2.7.0"
        },
        {
            "module_name": "@minecraft/server-ui",
            "version": "2.0.0"
        }
    ],
    "metadata": {
        "authors": ["Your Name"],
        "license": "MIT",
        "url": "https://wiki.bedrock.dev",
        "product_type": "addon"
    }
}

Resource Pack ​

A world-scoped resource pack with Vibrant Visuals support.

{
    "format_version": 3,
    "header": {
        "name": "pack.name",
        "description": "pack.description",
        "uuid": "66c6e9a8-3093-462a-9c36-dbb052165822",
        "version": "1.0.0",
        "min_engine_version": "1.26.40",
        "pack_scope": "world"
    },
    "modules": [
        {
            "type": "resources",
            "uuid": "743f6949-53be-44b6-b326-398005028819",
            "version": "1.0.0"
        }
    ],
    "metadata": {
        "authors": ["Your Name"],
        "product_type": "addon"
    },
    "capabilities": ["pbr"]
}

Skin Pack ​

Skin packs do not use min_engine_version, dependencies, capabilities or settings. See Skin Packs for the rest of the pack.

{
    "format_version": 2,
    "header": {
        "name": "My Skin Pack",
        "uuid": "bb9616eb-327c-4a81-9f00-064cae820cd5",
        "version": [1, 0, 0]
    },
    "modules": [
        {
            "type": "skin_pack",
            "uuid": "e4bc71b6-8f9b-4094-9d47-dc3824f8a3dc",
            "version": [1, 0, 0]
        }
    ]
}

World Template ​

{
    "format_version": 2,
    "header": {
        "name": "My World",
        "description": "A world template",
        "uuid": "3d2e1f00-9a8b-4c7d-8e6f-5a4b3c2d1e0f",
        "version": [1, 0, 0],
        "base_game_version": [1, 26, 40],
        "lock_template_options": true,
        "allow_random_seed": false
    },
    "modules": [
        {
            "type": "world_template",
            "uuid": "9f8e7d6c-5b4a-4c3d-9e2f-1a0b9c8d7e6f",
            "version": [1, 0, 0]
        }
    ]
}

Troubleshooting ​

• The pack does not appear in-game. The manifest is not valid JSON, or a required field is missing. Paste it into a JSON validator. In format version 3, also check that metadata.authors is present and every version is a string.
• "Duplicate pack detected". Another installed pack has the same header UUID. Either you copied a manifest without regenerating UUIDs, or you imported an update without raising header.version.
• Scripts do not run. The script module is missing entry, or the @minecraft/server dependency is missing or requests a version the game does not have.
• The resource pack is not applied with the behavior pack. The BP's dependency uuid does not match the RP's header.uuid, or the version does not match.
• Settings screen is empty. The manifest is still format_version 2.