Skip to main content

JSON schemas

Use a schema URL or an installed schema file to enable editor completion and validation for project configuration and generated metadata.

Select a version​

All 0.x releases and prerelease versions use /beta/ URLs. Beta schemas follow current source checkouts and can change as the tools evolve.

Versioned snapshots cover stable releases with major version 1 or higher, including 1.0.0, 1.1.0 and 2.0.0. Their URLs use the owning package's exact version:

https://bedrock-core.drav.dev/schemas/<package>/<version>/<file>

For example, published Builder releases 1.0.0 and 2.0.0 supply separate /schemas/builder/1.0.0/config.schema.json and /schemas/builder/2.0.0/config.schema.json snapshots. Snapshots use the published package archive and retain its exact schema bytes. An unreleased source version does not create a snapshot. Documentation deployment makes published snapshots available on the site.

Use the installed file when a beta project needs the schema matching its installed package exactly.

Beta schema URLs​

SchemaApplies to
Builder projectThe complete config.json
Authored pack manifestmanifest.json, inheritance and addon metadata
Manifest stageManifest-stage settings
Generator stageGenerator-stage settings
Guides stageGuides-stage settings
i18n stagei18n-stage settings
UI compiler stageUI-compiler-stage settings
Bundler stageBundler-stage settings
UI test metadataGenerated bedrock-core/test-metadata.json
BDS runner optionsbds-runner.json runner options and scalar overrides

The Builder project schema references its stage schemas from the same URL directory. The schema index lists available URLs, stable snapshots and a SHA-256 digest for each schema file.

Reference a project schema​

Only one schema reference is needed in config.json. Add it at the root; the project schema automatically includes every built-in stage's settings:

config.json (fragment)
{
"$schema": "https://bedrock-core.drav.dev/schemas/builder/beta/config.schema.json"
}

Keep the required project fields alongside this fragment. The installed-file equivalent is ./node_modules/@bedrock-core/builder/schemas/config.schema.json, relative to config.json.

Associate generated metadata or standalone settings​

Use an editor association for files that are generated or whose schema does not allow an extra $schema property:

.vscode/settings.json
{
"json.schemas": [
{
"fileMatch": ["**/ui-settings.json"],
"url": "https://bedrock-core.drav.dev/schemas/builder/beta/ui-compiler.schema.json"
},
{
"fileMatch": ["**/bedrock-core/test-metadata.json"],
"url": "https://bedrock-core.drav.dev/schemas/ui-compiler/beta/test-metadata.schema.json"
}
]
}

BDS server properties​

The starter uses the hosted BDS schema to check runner options before selecting a Minecraft server. Run bc-bds fetch to generate .bds/schema/bds-runner.json with the selected server's own property documentation and types. Reference that local file when configuring server-specific values.

Next steps​