modcleaner/reference/v1.2.1/topics/config.html
2021-08-16 09:32:18 +00:00

159 lines
3.4 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Cleaner mod for Minetest</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
<link rel="icon" href="https://www.minetest.net/media/icon.svg" type="image/png" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>Cleaner <span style="font-size:12pt;">(v1.2.1)</span></h1>
<img src="../data/cleaner_pencil.png" />
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#JSON_Configurations">JSON Configurations</a></li>
</ul>
<h2>Topics</h2>
<ul class="">
<li><a href="../topics/settings.html">settings</a></li>
<li><a href="../topics/api.html">api</a></li>
<li><a href="../topics/commands.html">commands</a></li>
<li><a href="../topics/tools.html">tools</a></li>
<li><strong>config</strong></li>
</ul>
</div>
<div id="content">
<h1>Topic <code>config</code></h1>
<p>World Path Configuration</p>
<p>
</p>
<h2><a href="#JSON_Configurations">JSON Configurations</a></h2>
<table class="function_list">
<tr>
<td class="name" nowrap><a href="#cleaner.json">cleaner.json</a></td>
<td class="summary">Main configuration file.</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="JSON_Configurations"></a>JSON Configurations</h2>
<dl class="function">
<dt>
<a name = "cleaner.json"></a>
<strong>cleaner.json</strong>
</dt>
<dd>
Main configuration file. </p>
<p> Registering items, entities, etc. for cleaning can be done in <strong><em>cleaner.json</em></strong>
in the world directory (<code>&lt;world_path&gt;/cleaner.json</code>). If it does not exist
it will be created automatically when the server is started.</p>
<p> It is formatted as follows:</p>
<pre><code>{
"entities" :
{
"remove" : []
},
"items" :
{
"replace" : {}
},
"nodes" :
{
"remove" : [],
"replace" : {}
},
"ores" :
{
"remove" : []
}
}
</code></pre>
<p> <code>remove</code> key works for nodes, entities, &amp; ores. <code>replace</code> key works for
nodes &amp; items. Their functions are self-explanatory.
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
</ul>
<h3>Usage:</h3>
<ul>
<pre class="example">Cleaning nodes example:
{
<span class="string">"nodes"</span> :
{
<span class="string">"remove"</span> :
[
<span class="string">"old:node_1"</span>,
<span class="string">"old:node_2"</span>,
],
<span class="string">"replace"</span> :
{
<span class="string">"old:node_3"</span> : <span class="string">"new:node_1"</span>,
<span class="string">"old:node_4"</span> : <span class="string">"new:node_2"</span>,
},
},
}</pre>
</ul>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/AntumDeluge/LDoc/tree/custom">LDoc 1.4.6-antum-dev</a></i>
<i style="float:right;">Last updated 2021-08-16 09:32:18 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>