From 75906b43ecb9a04fdab365bd8b1a00fbdbc66918 Mon Sep 17 00:00:00 2001
From: Stijn Buys <ingar@osirion.org>
Date: Sun, 3 Oct 2010 19:57:17 +0000
Subject: ui updates, removed impulse and jumpgte g_devel conditions, jumpdrive
 crash bugfix

---
 doc/world.html | 100 +++++++++++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 90 insertions(+), 10 deletions(-)

(limited to 'doc/world.html')

diff --git a/doc/world.html b/doc/world.html
index 5792c83..e94c063 100644
--- a/doc/world.html
+++ b/doc/world.html
@@ -29,6 +29,7 @@
 	<i>.osirion</i> in your home directory.	On windows, your personal osirion directory
 	is <i>My Documents\My Games\Osirion</i>.
 </p>
+<!-- =============================================================== -->
 <h2>
 	File structure
 </h2>
@@ -51,6 +52,14 @@ texture=planets/seymour
 radius=68
 </pre>
 
+<h2>
+	Textures
+</h2>
+<p>
+	The engine supports textures in the TGA, PNG and JPG file formats, where required.
+	The filename extension should be lowercase and in 24bit RGB or 32bit RGBA format.
+</p>
+
 <h2>
 	World
 </h2>
@@ -79,7 +88,7 @@ radius=68
 zone=ghant
 zone=brogha
 </pre>
-
+<!-- =============================================================== -->
 <h2>
 	Zones
 </h2>
@@ -413,26 +422,97 @@ color=1.0 1.0 0.9
 radius=96
 </pre>
 
-<h2>
-	Ships
-</h2>
 <p>
-	TODO Definition of the shopping list.
+	Consult the <a href="http://en.wikipedia.org/wiki/Stellar_classification">wikipedia article on stellar classification</a>
+	and <a href="http://en.wikipedia.org/wiki/File:Morgan-Keenan_spectral_classification.png">this image</a>.
 </p>
+
+<h3>
+	[ship]
+</h3>
+<p>
+	Some planets and stations have ship dealers where players can buy a new ship. [station] and [planet]
+	sections can be followed by one or more [ship] sections to add ship models to the ship dealers inventory.
+</p>
+<pre>
+; station definition
+[station]
+label=alexendria
+.
+. more station definitions
+.
+
+	; the Micron Vector is sold here
+	[ship]
+	label=vector
+
+	; the P.O.D. is sold here
+	[ship]
+	label=pod
+</pre>
+<p>
+	Indenting the [ship] sections like in the example above is not required,
+	but it improves readability. The <i>label</i> key is mandatory and referes to
+	a ship type as defined in ships.ini.
+</p>
+<h3>
+	[cargo]
+</h3>
+<p>
+	Cargo trade is defined similar to ship dealers. [station] and [planet] sections can be followed 
+	by one or more [cargo] section to add specific items to the trader's inventory. The <i>label</i>
+	key is mandatory and referes to a cargo type as defined in cargo.ini. 
+	The <i>price</i> and <i>amount</i> keys> can be used to set the most important trading parameters.
+</p>
+<table>
+	<tr>
+		<td class="wide"><i>price =</i></td>
+		<td class="narrow"><strong>[float]</strong></td>
+		<td>price this type of cargo is bought and sold at</td>
+	</tr>
+	<tr>
+		<td class="wide"><i>amount =</i></td>
+		<td class="narrow"><strong>[float]</strong></td>
+		<td>initial amount of available cargo. The default is -1 and means unlimited. 
+		   0 means this type of cargo can only be sold here.</td>
+	</tr>
+</table>
+
+<pre>
+; station definition
+[station]
+label=alexendria
+.
+. more station definitions
+.
+	; this station buys and sells crates at 25 credits per unit
+	[cargo]
+	label=crates
+	price=25
+
+	; this station buys niobium at 200 credits per unit
+	[cargo]
+	label=niobium
+	price=200
+	amount=0
+</pre>
+<!-- =============================================================== -->
 <h2>
-    Entity menus
+	Ships
 </h2>
+	
 <p>
-	TODO
+	The list of a available ship types is read from the file <i>ships.ini</i>.
 </p>
+<!-- =============================================================== -->
 <h2>
-	Textures
+	Cargo
 </h2>
 <p>
-	The engine supports textures in the TGA, PNG and JPG file formats. The filename extension
-	should be lowercase and the texture should be in 24bit RGB or 32bit RGBA format.
+	The list of available cargo types is read from the file <i>cargo.ini</i>.
 </p>
 
+<!-- =============================================================== -->
 <h2 class="navigate">
 	<a href="index.html">back</a>
 </h2>
-- 
cgit v1.2.3