Wuzzy/libpov_2025
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document JSON usage in manual

Browse Source
This commit is contained in:
Wuzzy 2024-11-30 17:46:29 +01:00
parent c34a0db9ab
commit 1d537fba84
1 changed files with 28 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
manual.html
View File

@ -146,6 +146,34 @@
<h2>Credits / License</h2>
<p>LiBPoV is <b>free software</b>. See the <a href="./license.html">License</a> page for details.</p>
<h2>Appendix</h2>
<h3>JSON format</h3>
<p>LiBPoV uses a JSON format to import and export the biome points. This section explains the format used by LiBPoV.</p>
<p>The JSON used by LiBPoV is an array of objects. Each object represents a biome. Each of these objects must contain the following fields:</p>
<ul>
<li><code>name</code>: Biome name (string). Same name as in Lua</li>
<li><code>heat_point</code>: Heat point (number). Same name as in Lua</li>
<li><code>humidity_point</code>: Humidity point (number). Same name as in Lua</li>
</ul>
<p>Additionally, the object may optionally specify any of the following fields to specify the minimum and maximum world coordinates of the biome:</p>
<ul>
<li><code>x_min</code>: Minimum X position of biome (number). Corresponds to <code>min_pos.x</code> in Lua</li>
<li><code>x_max</code>: Maximum X position of biome (number). Corresponds to <code>max_pos.x</code> in Lua</li>
<li><code>y_min</code>: Minimum Y position of biome (number). Corresponds to <code>min_pos.y</code> or <code>y_min</code> in Lua</li>
<li><code>y_max</code>: Maximum Y position of biome (number). Corresponds to <code>max_pos.y</code> or <code>y_max</code> in Lua</li>
<li><code>z_min</code>: Minimum Z position of biome (number). Corresponds to <code>min_pos.z</code> in Lua</li>
<li><code>z_max</code>: Maximum Z position of biome (number). Corresponds to <code>max_pos.z</code> in Lua</li>
</ul>
<p>If unspecified, these optional fields default to -31000 (minimum) and 31000 (maximum).</li>
<p>For general information about JSON, see <a href="https://www.json.org/" title="Introducing JSON">www.json.org</a>.</p>
</div>
</body>
</html>