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/STORYLINE  |  37 ++++++++++++---------
 doc/TODO       |  15 +++++----
 doc/world.html | 100 +++++++++++++++++++++++++++++++++++++++++++++++++++------
 3 files changed, 121 insertions(+), 31 deletions(-)

(limited to 'doc')

diff --git a/doc/STORYLINE b/doc/STORYLINE
index 7bc30e0..1006650 100644
--- a/doc/STORYLINE
+++ b/doc/STORYLINE
@@ -39,15 +39,18 @@
 	- Lindblade system
 		planet Lindblade
 
-	- Burtonian system
+	- Burton system
 		planet Burton
 		Trent outpost
 
 	- Dover system
 
-	CENTRAL PROTECTORATE (protected by the Ordinators)
+	PROTECTORATE (protected by the Ordinators)
 
-	- Central Protectorate
+	The seat of the Council and the capital of the central planets.
+	Location of the Allied Intelligence Network headquarters.
+
+	- Protectorate
 		planet Corona
 
 	INDEPENDENT COLONIES (protected by the Colonial Militia)
@@ -69,7 +72,7 @@
 	- Antwerp system
 		starbase Helianthos (guards the border)
 		Buccaneer's Den pirate base
-		planet Hoboken?
+		planet Antwerp?
 
 	BORDERWORLDS (not claimed by any lawfull faction)
 
@@ -109,8 +112,8 @@
 	Since the war, the term 'Borderworlds' is used to indicate
 	systems destroyed during the war, while the term 'colonies'
 	is generally used as abreviation for the 'Independent Colonies'. 
-	The Central Protectorate and the systems controlled by The Great Houses
-	are called to 'The Protectorate' or, more informal, 'the central planets'.
+	The Protectorate and the systems controlled by The Great Houses
+	are usually referred to as 'the central planets'.
 
   ------------------------------------------------------------------
 	TIMELINE
@@ -125,13 +128,13 @@
 	from the House Lindblade historical records
 
 
-Reach for the Stars
+Reaching for the Stars
 
-	Since the beginning of time history of mankind had been written
-	in blood and fire. While many modern historians state the Exodus 
-	as the the turning point in human civilization it certainly did
-	not precipitate an era of peace. Wars for resources and territory 
-	would be commonplace for millenia to come.
+	History of mankind is a tale mostly written in blood and fire. Although
+	there are few written accounts of the events before the Exodus, it wouldn't
+	be hard to imagine why the Homeworld would have been abandoned in the first 
+	place: wars for power, territory and resources would be commonplace 
+	for almost five millenia to come.
 
 The Year of War
 	
@@ -271,6 +274,10 @@ What really happed to the Osirion
 
 What really happed after the death of the Tsu-Khan Emperor
 
+Tsu-Khan Empress and the War Generals
+
+The Empress' niece
+
   ------------------------------------------------------------------
 	PROJECT::OSIRION
 	STORY
@@ -428,10 +435,10 @@ III. The suit
 	By now it was almost 3 am and I was almost certain I was going to regret this nightwandering
 	episode when my alarm clock would obnoxiously announce the next morning. Almost, because
 	by now I had learned that no regrets and focus on the task at hand was usually the wiser
-	course of action. Obivously, that action was sleep.
+	course of action. Right now, the task was finding some sleep.
 
 	I turned around, walked to the elevator at the end of the corridor and pressed the button.
 	After a few seconds the doors opened with a joyfull chime and I stepped inside. "Level 6".
 	The elevator seemed to consider my request when the doors finaly closed and it started
-	moving upward. Casually I leaned against the back wall, my right hand trying to catch the
-	yawn escaping my mouth.                                    
+	moving upward. I leaned casually against the back wall, my right hand trying to catch the
+	yawn escaping my mouth. 
diff --git a/doc/TODO b/doc/TODO
index 985868c..56823b8 100644
--- a/doc/TODO
+++ b/doc/TODO
@@ -13,12 +13,13 @@ general:
 	explosion events
 	sound events
 	world sounds
-	eject/beam cargo
 	weapons
 	ship improvements (radars, shield, armor)
 	
-trading:
-	no-buy items (amount 0)
+inventory:
+	no-buy items (amount 0) (ok)
+	eject cargo
+	beam cargo
 
 filesystem:
 	write a filesystem based on streams
@@ -42,7 +43,7 @@ network:
 	zone/system chat
 	group/clan chat (requires groups)
 	rcon authentication, rcon command, servers must be able to disable rcon
-	RSA based authentication (player id)
+	player authentication (player id)
 
 	send clients only updates from the current zone/server-side distance check
 	fix lag/client interpolation
@@ -66,7 +67,7 @@ render:
 ui:
 	fix modelview 'can't load' spam -> clear modelname (or tradewindow) (ok)	
 	modelview control axis, default orientation tilted
-	check modelview lighting (-> it uses current zone lighting)
+	modelview lighting (-> it uses current zone lighting)
 
 sound:
 	entity/event positional sounds
@@ -74,10 +75,12 @@ sound:
 
 game:
 	entity health/shield/armor
+	'give ship' destroys inventory
+	implement 'give cargo'
 
 data:
 	update starsystem roadmap
-	rename skies (lindblade1, lindblade2, ...)
+	rename skies (lindblade1, lindblade2, ...) 
 	
 win32 port:
 
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