/docs/wiki/packaging.html

This commit is contained in:
veclavtalica 2025-02-16 01:31:42 +03:00
parent 18a76649b9
commit cee344c7c1
2 changed files with 45 additions and 0 deletions

View File

@ -13,6 +13,8 @@
</tr>
<tr><td>T2.</strong> <a href="#input-system">Input System</a></td>
</tr>
<tr><td>T3.</strong> <a href="#packaging">Packaging</a></td>
</tr>
</table>
<p style="margin-bottom:0"><a name="about-townengine"></a>T1. </strong><a href="about-townengine.html">About Townengine</strong></a></p>
<blockquote style="margin-top:0">
@ -24,6 +26,10 @@
<p style="margin:0">T2.1 <a href="input-system.html#design">Design</a></p>
<p style="margin:0">T2.2 <a href="input-system.html#api">API</a></p>
</blockquote>
<p style="margin-bottom:0"><a name="packaging"></a>T3. </strong><a href="packaging.html">Packaging</strong></a></p>
<blockquote style="margin-top:0">
<p style="margin:0">T3.1 <a href="packaging.html#overview">Overview</a></p>
</blockquote>
<p style="margin-bottom:0"><a name="making-2dot5d-shooters"></a>G1. </strong><a href="making-2dot5d-shooters.html">Making 2.5D Shooters</strong></a></p>
<blockquote style="margin-top:0">
</blockquote>

39
docs/wiki/packaging.html Normal file
View File

@ -0,0 +1,39 @@
<!doctype html>
<html>
<head>
<title>Townengine Wiki : Packaging</title>
<link rel="stylesheet" href="style.css">
</head>
<body>
<h1 style="margin-bottom:0in">T3. Packaging<span style="float:right">{twn}</span></h1>
<a href="index.html">Go back
<p><a name="overview"></a><strong>T3.1 </strong><strong>Overview</strong>
<blockquote>
<p>Assets are distributed by packs, which can come in either archived or, for development purposes, folder form.
{twn} games are sandboxes and operate only on supplied content.
<p>Archives are limited to zip format, with .btw file extension.
<p>One pack by the name of 'data' is always assumed to be present alongside executable,
whether in folder /data/ or /data.btw archive, where precedence is taking over for /data/ folder variant.
<p>Root /data/ could be used to point to other packs in its /packs/data.toml file.
It results in a union filesystem, where directory structures are overlaid on top of each other.
<p>Packs which are loaded first have precedence over later ones, preserving their contents.
For example, if /assets/foo exists in root /data/, and another /assets/foo is found elsewhere,
only the root /data/ version will be available.
<pre>
# Example of data.toml file
# `deps` array of tables is loaded sequentially, where dependencies of dependencies are processed first before continuing.
[[deps]]
source = "../../common-data" # where does it come from
name = "common-data" # should be a globally unique identifier</pre>
<p>Compilation utility might later be available to combine packs for easier distribution.
</blockquote>
</body>
</html>