|
| 1 | +<h1>CLIENT BIOMES DOCUMENTATION </br>Version: 1.21.40.3</h1> |
| 2 | +<h2><p id="Index">Index</p></h2> |
| 3 | +<table border="1"> |
| 4 | +<tr> <th><a href="#Overview">Overview</a></th> </tr> |
| 5 | +<tr> <th><a href="#JSON Format">JSON Format</a></th> </tr> |
| 6 | +<tr> <th><a href="#Schema">Schema</a></th> </tr> |
| 7 | +<tr> <td> <a href="#Client Biome Components"> Client Biome Components</a> </tr> </td> |
| 8 | +<tr> <td> <a href="#Client Biome Definition"> Client Biome Definition</a> </tr> </td> |
| 9 | +<tr> <td> <a href="#Client Biome Description"> Client Biome Description</a> </tr> </td> |
| 10 | +<tr> <td> <a href="#Client Biome JSON File"> Client Biome JSON File</a> </tr> </td> |
| 11 | +<tr> <td> <a href="#minecraft:fog_appearance"> minecraft:fog_appearance</a> </tr> </td> |
| 12 | +<tr> <td> <a href="#minecraft:sky_color"> minecraft:sky_color</a> </tr> </td> |
| 13 | +<tr> <td> <a href="#minecraft:water_appearance"> minecraft:water_appearance</a> </tr> </td> |
| 14 | +</table> |
| 15 | +<a href="#Index">Back to top</a> |
| 16 | +<h1><p id="Overview">Overview</p></h1> |
| 17 | + |
| 18 | +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> |
| 19 | + |
| 20 | +<h1><p id="JSON Format">JSON Format</p></h1> |
| 21 | + |
| 22 | +<h2></h2> |
| 23 | +Here is a sample client_biome file.<br / ><textarea readonly="true" cols="50" rows="21"> |
| 24 | +{ |
| 25 | + "format_version": "1.21.40", |
| 26 | + "minecraft:client_biome": { |
| 27 | + "description": { |
| 28 | + "identifier": "the_end" |
| 29 | + }, |
| 30 | + "components": { |
| 31 | + "minecraft:sky_color": { |
| 32 | + "sky_color": "#000000" |
| 33 | + }, |
| 34 | + "minecraft:fog_appearance": { |
| 35 | + "fog_identifier": "minecraft:fog_the_end" |
| 36 | + }, |
| 37 | + "minecraft:water_appearance": { |
| 38 | + "surface_color": "#62529e" |
| 39 | + } |
| 40 | + } |
| 41 | + } |
| 42 | +} |
| 43 | + |
| 44 | +</textarea> </br> |
| 45 | +<a href="#Index">Back to top</a><br><br> |
| 46 | + |
| 47 | +<h1><p id="Schema">Schema</p></h1> |
| 48 | + |
| 49 | +<h1><p id="Client Biome Components">Client Biome Components</p></h1> |
| 50 | + |
| 51 | +Any components that this Client Biome uses</br><h2></h2> |
| 52 | + |
| 53 | +<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;"> |
| 54 | +<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> |
| 55 | +<tr> |
| 56 | +<td style="border-style:solid; border-width:3; padding:7px">minecraft:fog_appearance</td> |
| 57 | +<td style="border-style:solid; border-width:3; padding:7px">Object</td> |
| 58 | +<td style="border-style:solid; border-width:3; padding:7px">Optional</td> |
| 59 | +<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> |
| 60 | +</tr> |
| 61 | +<tr> |
| 62 | +<td style="border-style:solid; border-width:3; padding:7px">minecraft:sky_color</td> |
| 63 | +<td style="border-style:solid; border-width:3; padding:7px">Object</td> |
| 64 | +<td style="border-style:solid; border-width:3; padding:7px">Optional</td> |
| 65 | +<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> |
| 66 | +</tr> |
| 67 | +<tr> |
| 68 | +<td style="border-style:solid; border-width:3; padding:7px">minecraft:water_appearance</td> |
| 69 | +<td style="border-style:solid; border-width:3; padding:7px">Object</td> |
| 70 | +<td style="border-style:solid; border-width:3; padding:7px">Optional</td> |
| 71 | +<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> |
| 72 | +</tr> |
| 73 | +</table> |
| 74 | +<a href="#Index">Back to top</a><br><br> |
| 75 | + |
| 76 | +<h1><p id="Client Biome Definition">Client Biome Definition</p></h1> |
| 77 | + |
| 78 | +Contains a description and components to define a Client Biome.</br><h2></h2> |
| 79 | + |
| 80 | +<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;"> |
| 81 | +<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> |
| 82 | +<tr> |
| 83 | +<td style="border-style:solid; border-width:3; padding:7px">components</td> |
| 84 | +<td style="border-style:solid; border-width:3; padding:7px">Object of type Client Biome Components</td> |
| 85 | +<td style="border-style:solid; border-width:3; padding:7px">Required</td> |
| 86 | +<td style="border-style:solid; border-width:3; padding:7px">Components for this Client Biome.</br></td> |
| 87 | +</tr> |
| 88 | +<tr> |
| 89 | +<td style="border-style:solid; border-width:3; padding:7px">description</td> |
| 90 | +<td style="border-style:solid; border-width:3; padding:7px">Object of type Client Biome Description</td> |
| 91 | +<td style="border-style:solid; border-width:3; padding:7px">Required</td> |
| 92 | +<td style="border-style:solid; border-width:3; padding:7px">Non-component settings, including the Client Biome name.</br></td> |
| 93 | +</tr> |
| 94 | +</table> |
| 95 | +<a href="#Index">Back to top</a><br><br> |
| 96 | + |
| 97 | +<h1><p id="Client Biome Description">Client Biome Description</p></h1> |
| 98 | + |
| 99 | +Contains non-component settings for a Client Biome.</br><h2></h2> |
| 100 | + |
| 101 | +<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;"> |
| 102 | +<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> |
| 103 | +<tr> |
| 104 | +<td style="border-style:solid; border-width:3; padding:7px">identifier</td> |
| 105 | +<td style="border-style:solid; border-width:3; padding:7px">String</td> |
| 106 | +<td style="border-style:solid; border-width:3; padding:7px">Required</td> |
| 107 | +<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> |
| 108 | +</tr> |
| 109 | +</table> |
| 110 | +<a href="#Index">Back to top</a><br><br> |
| 111 | + |
| 112 | +<h1><p id="Client Biome JSON File">Client Biome JSON File</p></h1> |
| 113 | + |
| 114 | +Contains a format version and a Client Biome definition</br><h2></h2> |
| 115 | + |
| 116 | +<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;"> |
| 117 | +<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> |
| 118 | +<tr> |
| 119 | +<td style="border-style:solid; border-width:3; padding:7px">format_version</td> |
| 120 | +<td style="border-style:solid; border-width:3; padding:7px">String</td> |
| 121 | +<td style="border-style:solid; border-width:3; padding:7px">Required</td> |
| 122 | +<td style="border-style:solid; border-width:3; padding:7px">Version of the JSON schema used by this file</br></td> |
| 123 | +</tr> |
| 124 | +<tr> |
| 125 | +<td style="border-style:solid; border-width:3; padding:7px">minecraft:client_biome</td> |
| 126 | +<td style="border-style:solid; border-width:3; padding:7px">Object of type Client Biome Definition</td> |
| 127 | +<td style="border-style:solid; border-width:3; padding:7px">Required</td> |
| 128 | +<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> |
| 129 | +</tr> |
| 130 | +</table> |
| 131 | +<a href="#Index">Back to top</a><br><br> |
| 132 | + |
| 133 | +<h1><p id="minecraft:fog_appearance">minecraft:fog_appearance</p></h1> |
| 134 | + |
| 135 | +Set the fog settings used during rendering. Biomes without this component will have default fog settings.</br><h2></h2> |
| 136 | + |
| 137 | +<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;"> |
| 138 | +<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> |
| 139 | +<tr> |
| 140 | +<td style="border-style:solid; border-width:3; padding:7px">fog_identifier</td> |
| 141 | +<td style="border-style:solid; border-width:3; padding:7px">String</td> |
| 142 | +<td style="border-style:solid; border-width:3; padding:7px">Required</td> |
| 143 | +<td style="border-style:solid; border-width:3; padding:7px">Identifier of fog definition to use</br></td> |
| 144 | +</tr> |
| 145 | +</table> |
| 146 | +<a href="#Index">Back to top</a><br><br> |
| 147 | + |
| 148 | +<h1><p id="minecraft:sky_color">minecraft:sky_color</p></h1> |
| 149 | + |
| 150 | +Set the sky color used during rendering. Biomes without this component will have default sky color behavior.</br><h2></h2> |
| 151 | + |
| 152 | +<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;"> |
| 153 | +<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> |
| 154 | +<tr> |
| 155 | +<td style="border-style:solid; border-width:3; padding:7px">sky_color</td> |
| 156 | +<td style="border-style:solid; border-width:3; padding:7px">Object of type Color255RGB</td> |
| 157 | +<td style="border-style:solid; border-width:3; padding:7px">Required</td> |
| 158 | +<td style="border-style:solid; border-width:3; padding:7px">RGB color of the sky</br></td> |
| 159 | +</tr> |
| 160 | +</table> |
| 161 | +<a href="#Index">Back to top</a><br><br> |
| 162 | + |
| 163 | +<h1><p id="minecraft:water_appearance">minecraft:water_appearance</p></h1> |
| 164 | + |
| 165 | +Set the water surface color used during rendering. Biomes without this component will have default water surface color behavior.</br><h2></h2> |
| 166 | + |
| 167 | +<table border="1" style="width:100%; border-style:solid; border-collapse:collapse; border-width:3;"> |
| 168 | +<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> |
| 169 | +<tr> |
| 170 | +<td style="border-style:solid; border-width:3; padding:7px">surface_color</td> |
| 171 | +<td style="border-style:solid; border-width:3; padding:7px">Object of type Color255RGB</td> |
| 172 | +<td style="border-style:solid; border-width:3; padding:7px">Required</td> |
| 173 | +<td style="border-style:solid; border-width:3; padding:7px">RGB color of the water surface</br></td> |
| 174 | +</tr> |
| 175 | +</table> |
| 176 | +<a href="#Index">Back to top</a><br><br> |
| 177 | + |
| 178 | +<br><br> |
| 179 | + |
0 commit comments