Skip to content

Commit 5414c3b

Browse files
CopilotDaanV2
Copilot
and
DaanV2
authored
docs: add missing error documentation files and improve incomplete existing docs (#26)
* Initial plan * docs: add missing error documentation files and improve existing incomplete docs - Create behaviorpack/entity/components/deprecated.md - Create behaviorpack/biome/components/deprecated.md - Create behaviorpack/biome/components/climate/particles.md - Create behaviorpack/biome/components/pre_1.17_component.md - Create behaviorpack/biome/components/replace_biomes/multiple_dimensions.md - Create behaviorpack/functions/missing.md - Create resourcepack/entities/missing.md - Create minecraft/commands/syntax.md (general command syntax page) - Create minecraft/commands/obsolete.md (general obsolete command page) - Improve general/string/invalid.md with description, examples, and fix guidance - Improve general/integer/invalid.md with description, examples, and fix guidance - Improve general/integer/minimum.md with description, examples, and fix guidance - Improve general/integer/maximum.md with description, examples, and fix guidance - Improve general/float/invalid.md with description, examples, and fix guidance - Improve general/boolean/invalid.md with description, examples, and fix guidance - Improve behaviorpack/entity/event/missing.md with trigger details and examples - Improve behaviorpack/entity/aliases.md with deprecation context and fix guidance - Improve behaviorpack/entity/permutations.md with migration example to entity properties - Improve behaviorpack/mcfunction/empty.md with trigger source and fix guidance - Improve minecraft/format_version.md with version format docs and examples - Improve minecraft/selector/invalid.md with detailed trigger explanation - Improve minecraft/mode/invalid.md with description and example - Improve debugger/internal/exception.md with actionable fix steps - Improve molang/optimization/constant-folding.md with examples and hints - Improve behaviorpack/block/components/deprecated.md with deprecation table - Update README.md with full index, naming convention docs, severity table, and quick reference Agent-Logs-Url: https://github.com/Blockception/Minecraft-Error-Codes/sessions/891ec4e6-be95-46af-bbeb-2fb52f889ee2 Co-authored-by: DaanV2 <2393905+DaanV2@users.noreply.github.com> * docs: fix review comments - snake_case property and biome example correction Agent-Logs-Url: https://github.com/Blockception/Minecraft-Error-Codes/sessions/891ec4e6-be95-46af-bbeb-2fb52f889ee2 Co-authored-by: DaanV2 <2393905+DaanV2@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: DaanV2 <2393905+DaanV2@users.noreply.github.com>
1 parent 0768ef1 commit 5414c3b

File tree

26 files changed

+1480
-31
lines changed

26 files changed

+1480
-31
lines changed

‎README.md‎

Lines changed: 99 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,104 @@
11
# Minecraft-Error-Codes
2-
The pages for errors codes that can be generated by a diagnoser and referenced
2+
3+
Documentation for error codes generated by the [Blockception Minecraft Bedrock Language Server](https://github.com/Blockception/minecraft-bedrock-language-server). When you click on an error code in your IDE, you are directed to the corresponding page in this repository.
4+
5+
## How Error Code URLs Work
6+
7+
String error codes use dots as separators and map directly to file paths in this repository:
8+
9+
```
10+
behaviorpack.entity.event.missing
11+
→ behaviorpack/entity/event/missing.md
12+
```
13+
14+
Numeric error codes link to the [codes/main.md](./codes/main.md) page with a fragment anchor.
15+
16+
## Error Code Naming Convention
17+
18+
Error codes follow the pattern `<category>.<subcategory>.<type>.<detail>`:
19+
20+
- **category** — The top-level area: `behaviorpack`, `resourcepack`, `minecraft`, `general`, `json`, `molang`, `project`, `debugger`
21+
- **subcategory** — The specific pack section or feature area (e.g., `entity`, `block`, `mcfunction`)
22+
- **type** — The kind of issue (e.g., `missing`, `invalid`, `deprecated`)
23+
- **detail** — Optional further specificity (e.g., `components`, `event`)
24+
25+
## Severity Levels
26+
27+
| Severity | Description |
28+
|---|---|
29+
| **error** | The content is invalid and will not work correctly in Minecraft |
30+
| **warning** | The content uses deprecated or discouraged features that may stop working |
31+
| **info** | Informational notice about the content |
32+
| **hint** | A suggestion for improvement (e.g., performance optimizations) |
333

434
## Categories
5-
- [behaviorpack](./behaviorpack/README.md)
6-
- [codes](./codes/README.md)
7-
- [debugger](./debugger/README.md)
8-
- [diagnostics](./diagnostics/README.md)
9-
- [general](./general/README.md)
10-
- [json](./json/README.md)
11-
- [minecraft](./minecraft/README.md)
12-
- [molang](./molang/README.md)
13-
- [project](./project/README.md)
14-
- [resourcepack](./resourcepack/README.md)
35+
36+
- [behaviorpack](./behaviorpack/README.md) — Behavior pack errors (entities, blocks, functions, biomes, etc.)
37+
- [codes](./codes/main.md) — Numeric diagnostic codes
38+
- [debugger](./debugger/) — Internal language server diagnostic errors
39+
- [diagnostics](./diagnostics/) — Diagnostic component errors
40+
- [general](./general/) — General value type errors (strings, integers, floats, booleans)
41+
- [json](./json/) — JSON parsing and structure errors
42+
- [minecraft](./minecraft/) — Minecraft-specific errors (selectors, commands, modes, format versions)
43+
- [molang](./molang/) — Molang expression errors and optimizations
44+
- [project](./project/) — Project configuration errors
45+
- [resourcepack](./resourcepack/README.md) — Resource pack errors (animations, entities, sounds, textures, etc.)
46+
47+
## Common Error Codes Quick Reference
48+
49+
### General
50+
| Code | Description |
51+
|---|---|
52+
| [`general.string.invalid`](./general/string/invalid.md) | Invalid Minecraft string (e.g., unquoted spaces) |
53+
| [`general.integer.invalid`](./general/integer/invalid.md) | Value is not a valid integer |
54+
| [`general.integer.minimum`](./general/integer/minimum.md) | Integer below the minimum allowed value |
55+
| [`general.integer.maximum`](./general/integer/maximum.md) | Integer above the maximum allowed value |
56+
| [`general.float.invalid`](./general/float/invalid.md) | Value is not a valid float |
57+
| [`general.boolean.invalid`](./general/boolean/invalid.md) | Value is not a valid boolean |
58+
59+
### JSON
60+
| Code | Description |
61+
|---|---|
62+
| [`json.invalid`](./json/invalid.md) | Invalid JSON structure or syntax |
63+
64+
### Minecraft
65+
| Code | Description |
66+
|---|---|
67+
| [`minecraft.format_version`](./minecraft/format_version.md) | Format version is missing, invalid, or outdated |
68+
| [`minecraft.selector.invalid`](./minecraft/selector/invalid.md) | Invalid target selector |
69+
| [`minecraft.commands.<cmd>.syntax`](./minecraft/commands/syntax.md) | Command syntax error |
70+
| [`minecraft.commands.<cmd>.obsolete`](./minecraft/commands/obsolete.md) | Obsolete command syntax |
71+
72+
### Behavior Pack
73+
| Code | Description |
74+
|---|---|
75+
| [`behaviorpack.mcfunction.empty`](./behaviorpack/mcfunction/empty.md) | Empty mcfunction file |
76+
| [`behaviorpack.functions.missing`](./behaviorpack/functions/missing.md) | Cannot find function definition |
77+
| [`behaviorpack.entities.missing`](./behaviorpack/entities/missing.md) | Cannot find entity definition |
78+
| [`behaviorpack.entity.event.missing`](./behaviorpack/entity/event/missing.md) | Entity event not defined |
79+
| [`behaviorpack.entity.permutations`](./behaviorpack/entity/permutations.md) | Deprecated entity permutations |
80+
| [`behaviorpack.entity.aliases`](./behaviorpack/entity/aliases.md) | Deprecated entity aliases |
81+
| [`behaviorpack.entity.components.deprecated`](./behaviorpack/entity/components/deprecated.md) | Deprecated entity component |
82+
| [`behaviorpack.block.components.deprecated`](./behaviorpack/block/components/deprecated.md) | Deprecated block component |
83+
| [`behaviorpack.biome.components.deprecated`](./behaviorpack/biome/components/deprecated.md) | Deprecated biome component |
84+
85+
### Resource Pack
86+
| Code | Description |
87+
|---|---|
88+
| [`resourcepack.animation.missing`](./resourcepack/animation/missing.md) | Cannot find animation definition |
89+
| [`resourcepack.entities.missing`](./resourcepack/entities/missing.md) | Cannot find resource pack entity definition |
90+
91+
### Molang
92+
| Code | Description |
93+
|---|---|
94+
| [`molang.optimization.constant-folding`](./molang/optimization/constant-folding.md) | Constant expression can be pre-calculated |
95+
96+
### Internal
97+
| Code | Description |
98+
|---|---|
99+
| [`debugger.internal.exception`](./debugger/internal/exception.md) | Internal language server exception |
100+
| [`project.settings`](./project/settings.md) | Project configuration issue |
15101

16102
## Documents
17-
- [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md)
18-
- [CONTRIBUTING](CONTRIBUTING.md)
103+
- [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md)
104+
- [CONTRIBUTING](CONTRIBUTING.md)

‎behaviorpack/biome/components/climate/particles.md‎

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# Biome - Climate - Particles
2+
3+
`behaviorpack.biome.components.climate.particles`
4+
5+
**Severity:** warning
6+
7+
## Description
8+
9+
The particle capability inside the `minecraft:climate` biome component has been moved to `client_biome.json` files. Defining particles in the server-side biome definition no longer has any effect.
10+
11+
## What triggers this error
12+
13+
This warning is triggered when the language server detects a `particles` property inside the `minecraft:climate` component of a behavior pack biome definition. Since Minecraft moved ambient particle effects to client-side biome definitions, this server-side property is no longer processed.
14+
15+
## Example
16+
17+
The following biome definition uses the deprecated climate particles property:
18+
19+
```jsonc
20+
{
21+
"format_version": "1.13.0",
22+
"minecraft:biome": {
23+
"description": {
24+
"identifier": "example:my_biome"
25+
},
26+
"components": {
27+
"minecraft:climate": {
28+
"temperature": 0.8,
29+
"downfall": 0.4,
30+
"particles": [
31+
{
32+
"id": "minecraft:ambient_block_chance",
33+
"chance": 0.01
34+
}
35+
]
36+
}
37+
}
38+
}
39+
}
40+
```
41+
42+
## How to fix
43+
44+
Move the particle definition to the client-side `client_biome.json` file. Create or update the corresponding file in your resource pack:
45+
46+
```jsonc
47+
// resource_pack/biomes_client/example:my_biome.json
48+
{
49+
"format_version": "1.21.0",
50+
"minecraft:client_biome": {
51+
"description": {
52+
"identifier": "example:my_biome"
53+
},
54+
"components": {
55+
"minecraft:ambient_particles": {
56+
"particle": {
57+
"id": "minecraft:ambient_block_chance",
58+
"chance": 0.01
59+
}
60+
}
61+
}
62+
}
63+
}
64+
```
65+
66+
Remove the `particles` property from the `minecraft:climate` component in your behavior pack biome file.
67+
68+
## Related errors
69+
70+
- [behaviorpack.biome.components.deprecated](../deprecated.md)
71+
- [behaviorpack.biome.components.pre_1.17_component](../pre_1.17_component.md)

‎behaviorpack/biome/components/deprecated.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
# Biome - Components - Deprecated
2+
3+
`behaviorpack.biome.components.deprecated`
4+
5+
**Severity:** warning
6+
7+
## Description
8+
9+
A deprecated biome component is being used in this biome definition. These components have been removed or replaced in newer versions of Minecraft Bedrock and may not work correctly.
10+
11+
## What triggers this error
12+
13+
This error is triggered when the language server detects a known deprecated biome component. Known deprecated components include:
14+
15+
- `minecraft:surface_parameters` — replaced by `minecraft:surface_builder`
16+
- `minecraft:frozen_ocean_surface` — replaced by `minecraft:surface_builder`
17+
- `minecraft:mesa_surface` — replaced by `minecraft:surface_builder`
18+
- `minecraft:overworld_generation_rules` — superseded by newer world generation APIs
19+
- `minecraft:climate` (partially deprecated features)
20+
21+
## Example
22+
23+
The following biome definition uses a deprecated surface component:
24+
25+
```jsonc
26+
{
27+
"format_version": "1.13.0",
28+
"minecraft:biome": {
29+
"description": {
30+
"identifier": "example:my_biome"
31+
},
32+
"components": {
33+
"minecraft:surface_parameters": {
34+
"top_material": "minecraft:grass",
35+
"mid_material": "minecraft:dirt",
36+
"sea_floor_material": "minecraft:gravel",
37+
"foundation_material": "minecraft:stone",
38+
"sea_material": "minecraft:water"
39+
}
40+
}
41+
}
42+
}
43+
```
44+
45+
## How to fix
46+
47+
Replace deprecated surface parameter components with `minecraft:surface_builder`:
48+
49+
```jsonc
50+
{
51+
"format_version": "1.21.0",
52+
"minecraft:biome": {
53+
"description": {
54+
"identifier": "example:my_biome"
55+
},
56+
"components": {
57+
"minecraft:surface_builder": {
58+
"identifier": "minecraft:default_surface_builder",
59+
"top_material": "minecraft:grass",
60+
"mid_material": "minecraft:dirt",
61+
"sea_floor_material": "minecraft:gravel",
62+
"foundation_material": "minecraft:stone",
63+
"sea_material": "minecraft:water"
64+
}
65+
}
66+
}
67+
}
68+
```
69+
70+
Refer to the [Minecraft Bedrock biome documentation](https://learn.microsoft.com/en-us/minecraft/creator/reference/content/biomereference/) for the current list of supported biome components.
71+
72+
## Related errors
73+
74+
- [behaviorpack.biome.components.climate.particles](climate/particles.md)
75+
- [behaviorpack.biome.components.pre_1.17_component](pre_1.17_component.md)
76+
- [behaviorpack.biome.components.replace_biomes.multiple_dimensions](replace_biomes/multiple_dimensions.md)
77+
- [behaviorpack.block.components.deprecated](../../block/components/deprecated.md)

‎behaviorpack/biome/components/pre_1.17_component.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Biome - Pre 1.17 Component
2+
3+
`behaviorpack.biome.components.pre_1.17_component`
4+
5+
**Severity:** warning
6+
7+
## Description
8+
9+
This biome definition uses a component that predates the Caves and Cliffs update (1.17). These pre-1.17 biome components do not work with custom biomes created using behavior packs and will be silently ignored.
10+
11+
## What triggers this error
12+
13+
This warning is triggered when the language server detects biome components that were part of the legacy biome system used before the Caves and Cliffs update. These components were designed for the old world generation pipeline and are incompatible with the custom biome API available to content creators.
14+
15+
Examples of affected components include older overworld generation components that relied on the pre-1.17 world generation system.
16+
17+
## Example
18+
19+
The following biome definition uses a legacy component that is incompatible with custom biomes:
20+
21+
```jsonc
22+
{
23+
"format_version": "1.13.0",
24+
"minecraft:biome": {
25+
"description": {
26+
"identifier": "example:my_biome"
27+
},
28+
"components": {
29+
"minecraft:overworld_generation_rules": {
30+
"hills_transformation": "jungle_hills",
31+
"shore_transformation": "beach",
32+
"generate_for_climates": [
33+
["cold", 1]
34+
]
35+
}
36+
}
37+
}
38+
}
39+
```
40+
41+
## How to fix
42+
43+
Remove or replace the pre-1.17 component with a modern equivalent. For world generation, refer to the current Minecraft Bedrock [custom biomes documentation](https://learn.microsoft.com/en-us/minecraft/creator/documents/custombiomes) to understand which components are supported for add-on biomes.
44+
45+
Note that not all biome features available to vanilla Minecraft biomes can be replicated through the custom biome API. Some features are restricted to built-in biomes only.
46+
47+
## Related errors
48+
49+
- [behaviorpack.biome.components.deprecated](deprecated.md)
50+
- [behaviorpack.biome.components.replace_biomes.multiple_dimensions](replace_biomes/multiple_dimensions.md)

0 commit comments

Comments
 (0)