mirror of
https://github.com/Mojang/bedrock-samples.git
synced 2024-11-23 12:26:14 +00:00
180 lines
10 KiB
HTML
180 lines
10 KiB
HTML
<h1>CLIENT BIOMES DOCUMENTATION </br>Version: 1.21.40.3</h1>
|
|
<h2><p id="Index">Index</p></h2>
|
|
<table border="1">
|
|
<tr> <th><a href="#Overview">Overview</a></th> </tr>
|
|
<tr> <th><a href="#JSON Format">JSON Format</a></th> </tr>
|
|
<tr> <th><a href="#Schema">Schema</a></th> </tr>
|
|
<tr> <td> <a href="#Client Biome Components"> Client Biome Components</a> </tr> </td>
|
|
<tr> <td> <a href="#Client Biome Definition"> Client Biome Definition</a> </tr> </td>
|
|
<tr> <td> <a href="#Client Biome Description"> Client Biome Description</a> </tr> </td>
|
|
<tr> <td> <a href="#Client Biome JSON File"> Client Biome JSON File</a> </tr> </td>
|
|
<tr> <td> <a href="#minecraft:fog_appearance"> minecraft:fog_appearance</a> </tr> </td>
|
|
<tr> <td> <a href="#minecraft:sky_color"> minecraft:sky_color</a> </tr> </td>
|
|
<tr> <td> <a href="#minecraft:water_appearance"> minecraft:water_appearance</a> </tr> </td>
|
|
</table>
|
|
<a href="#Index">Back to top</a>
|
|
<h1><p id="Overview">Overview</p></h1>
|
|
|
|
Minecraft client_biome files define client-side settings for biomes in resource packs.</br>This is the new preferred location for per-biome settings that used to be in biomes_client.json.</br>(As of base game version 1.21.40, biomes_client.json is no longer loaded from built-in Vanilla resource packs. That file will still be loaded for other content regardless of version, and worlds using older base game versions will also still use it.)</br>These files are not part of the 'Custom Biomes' experiment and do not cause biome definitions to exist on their own, but they can be used to customize client-side settings of custom biomes.</br><a href="#Index">Back to top</a><br><br>
|
|
|
|
<h1><p id="JSON Format">JSON Format</p></h1>
|
|
|
|
<h2></h2>
|
|
Here is a sample client_biome file.<br / ><textarea readonly="true" cols="50" rows="21">
|
|
{
|
|
"format_version": "1.21.40",
|
|
"minecraft:client_biome": {
|
|
"description": {
|
|
"identifier": "the_end"
|
|
},
|
|
"components": {
|
|
"minecraft:sky_color": {
|
|
"sky_color": "#000000"
|
|
},
|
|
"minecraft:fog_appearance": {
|
|
"fog_identifier": "minecraft:fog_the_end"
|
|
},
|
|
"minecraft:water_appearance": {
|
|
"surface_color": "#62529e"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
</textarea> </br>
|
|
<a href="#Index">Back to top</a><br><br>
|
|
|
|
<h1><p id="Schema">Schema</p></h1>
|
|
|
|
<h1><p id="Client Biome Components">Client Biome Components</p></h1>
|
|
|
|
Any components that this Client Biome uses</br><h2></h2>
|
|
|
|
<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;">
|
|
<tr> <th style="border-style:solid; border-width:3;">Name</th> <th style="border-style:solid; border-width:3;">Type</th> <th style="border-style:solid; border-width:3;">Required?</th> <th style="border-style:solid; border-width:3;">Description</th> </tr>
|
|
<tr>
|
|
<td style="border-style:solid; border-width:3; padding:7px">minecraft:fog_appearance</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Object</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Optional</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Set the fog settings used during rendering. Biomes without this component will have default fog settings.</br></td>
|
|
</tr>
|
|
<tr>
|
|
<td style="border-style:solid; border-width:3; padding:7px">minecraft:sky_color</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Object</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Optional</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Set the sky color used during rendering. Biomes without this component will have default sky color behavior.</br></td>
|
|
</tr>
|
|
<tr>
|
|
<td style="border-style:solid; border-width:3; padding:7px">minecraft:water_appearance</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Object</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Optional</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Set the water surface color used during rendering. Biomes without this component will have default water surface color behavior.</br></td>
|
|
</tr>
|
|
</table>
|
|
<a href="#Index">Back to top</a><br><br>
|
|
|
|
<h1><p id="Client Biome Definition">Client Biome Definition</p></h1>
|
|
|
|
Contains a description and components to define a Client Biome.</br><h2></h2>
|
|
|
|
<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;">
|
|
<tr> <th style="border-style:solid; border-width:3;">Name</th> <th style="border-style:solid; border-width:3;">Type</th> <th style="border-style:solid; border-width:3;">Required?</th> <th style="border-style:solid; border-width:3;">Description</th> </tr>
|
|
<tr>
|
|
<td style="border-style:solid; border-width:3; padding:7px">components</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Object of type Client Biome Components</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Required</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Components for this Client Biome.</br></td>
|
|
</tr>
|
|
<tr>
|
|
<td style="border-style:solid; border-width:3; padding:7px">description</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Object of type Client Biome Description</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Required</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Non-component settings, including the Client Biome name.</br></td>
|
|
</tr>
|
|
</table>
|
|
<a href="#Index">Back to top</a><br><br>
|
|
|
|
<h1><p id="Client Biome Description">Client Biome Description</p></h1>
|
|
|
|
Contains non-component settings for a Client Biome.</br><h2></h2>
|
|
|
|
<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;">
|
|
<tr> <th style="border-style:solid; border-width:3;">Name</th> <th style="border-style:solid; border-width:3;">Type</th> <th style="border-style:solid; border-width:3;">Required?</th> <th style="border-style:solid; border-width:3;">Description</th> </tr>
|
|
<tr>
|
|
<td style="border-style:solid; border-width:3; padding:7px">identifier</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">String</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Required</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">The name of the Client Biome, used by other features like the '/locate biome' command. Must match the name of a Biome defined by the game or a behavior pack.</br></td>
|
|
</tr>
|
|
</table>
|
|
<a href="#Index">Back to top</a><br><br>
|
|
|
|
<h1><p id="Client Biome JSON File">Client Biome JSON File</p></h1>
|
|
|
|
Contains a format version and a Client Biome definition</br><h2></h2>
|
|
|
|
<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;">
|
|
<tr> <th style="border-style:solid; border-width:3;">Name</th> <th style="border-style:solid; border-width:3;">Type</th> <th style="border-style:solid; border-width:3;">Required?</th> <th style="border-style:solid; border-width:3;">Description</th> </tr>
|
|
<tr>
|
|
<td style="border-style:solid; border-width:3; padding:7px">format_version</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">String</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Required</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Version of the JSON schema used by this file</br></td>
|
|
</tr>
|
|
<tr>
|
|
<td style="border-style:solid; border-width:3; padding:7px">minecraft:client_biome</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Object of type Client Biome Definition</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Required</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">A single Client Biome definition, containing rendering or sound settings related to a Biome defined by the game or a behavior pack</br></td>
|
|
</tr>
|
|
</table>
|
|
<a href="#Index">Back to top</a><br><br>
|
|
|
|
<h1><p id="minecraft:fog_appearance">minecraft:fog_appearance</p></h1>
|
|
|
|
Set the fog settings used during rendering. Biomes without this component will have default fog settings.</br><h2></h2>
|
|
|
|
<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;">
|
|
<tr> <th style="border-style:solid; border-width:3;">Name</th> <th style="border-style:solid; border-width:3;">Type</th> <th style="border-style:solid; border-width:3;">Required?</th> <th style="border-style:solid; border-width:3;">Description</th> </tr>
|
|
<tr>
|
|
<td style="border-style:solid; border-width:3; padding:7px">fog_identifier</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">String</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Required</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Identifier of fog definition to use</br></td>
|
|
</tr>
|
|
</table>
|
|
<a href="#Index">Back to top</a><br><br>
|
|
|
|
<h1><p id="minecraft:sky_color">minecraft:sky_color</p></h1>
|
|
|
|
Set the sky color used during rendering. Biomes without this component will have default sky color behavior.</br><h2></h2>
|
|
|
|
<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;">
|
|
<tr> <th style="border-style:solid; border-width:3;">Name</th> <th style="border-style:solid; border-width:3;">Type</th> <th style="border-style:solid; border-width:3;">Required?</th> <th style="border-style:solid; border-width:3;">Description</th> </tr>
|
|
<tr>
|
|
<td style="border-style:solid; border-width:3; padding:7px">sky_color</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Object of type Color255RGB</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Required</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">RGB color of the sky</br></td>
|
|
</tr>
|
|
</table>
|
|
<a href="#Index">Back to top</a><br><br>
|
|
|
|
<h1><p id="minecraft:water_appearance">minecraft:water_appearance</p></h1>
|
|
|
|
Set the water surface color used during rendering. Biomes without this component will have default water surface color behavior.</br><h2></h2>
|
|
|
|
<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;">
|
|
<tr> <th style="border-style:solid; border-width:3;">Name</th> <th style="border-style:solid; border-width:3;">Type</th> <th style="border-style:solid; border-width:3;">Required?</th> <th style="border-style:solid; border-width:3;">Description</th> </tr>
|
|
<tr>
|
|
<td style="border-style:solid; border-width:3; padding:7px">surface_color</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Object of type Color255RGB</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">Required</td>
|
|
<td style="border-style:solid; border-width:3; padding:7px">RGB color of the water surface</br></td>
|
|
</tr>
|
|
</table>
|
|
<a href="#Index">Back to top</a><br><br>
|
|
|
|
<br><br>
|
|
|