Misc. documentation updates.

5 files changed, 73 insertions, 34 deletions

diff --git a/developer/GAMEPLAY b/developer/GAMEPLAY
index f1f3cfd..dc8f6ee 100644
--- a/developer/GAMEPLAY
+++ b/developer/GAMEPLAY
@@ -14,8 +14,8 @@ Overview
 	Project::OSiRiON is a multiplayer space game with persistent player
 	statistics. By trading goods, obtained through lawful purchase or 
 	otherwise, a player can earn the necessary credits to buy bigger
-	guns and faster ships, and explore the univers in search for better
-	trade deals.
+	guns and faster ships, and explore the universe in the search
+	for better deals.
 
 	A single player mode with a compelling story is a secondary objective
 	but the storyline serves as background for the multiplayer universe.
@@ -199,12 +199,11 @@ Cargo
 
 Missions
 
-	I'd do anything for money, except working.
-
 	- Search and Destroy
 	- Transport / Delivery
 	- Courier missions
 
-Fleets & Wingmen (scondary goal)
+Fleets & Wingmen (secondary goal)
 
 	About owning multiple ships and adding strategy elements.
+
diff --git a/developer/ROADMAP b/developer/ROADMAP
index 9cafc43..ed69556 100644
--- a/developer/ROADMAP
+++ b/developer/ROADMAP
@@ -161,7 +161,8 @@
 
 	factions
 	allegiance
-
+	computer-controlled opponents
+	
   ------------------------------------------------------------------
 
   version 0.7.0 - Missions
diff --git a/developer/STORYLINE b/developer/STORYLINE
index bd33282..add817f 100644
--- a/developer/STORYLINE
+++ b/developer/STORYLINE
@@ -12,7 +12,7 @@
 
 
   ------------------------------------------------------------------
-	FACTIONS and PLACES
+	PLACES and FACTIONS
 
 
 	HOUSE LINDBLADE (protected by the Lindblade military)
@@ -31,13 +31,13 @@
 	- Praetoria system
 		planet Praetoria
 
-	PROTECTORATE (protected by the Ordinators)
+	COUNCIL CAPITAL (protected by the Ordinators)
 
 	The seat of the Council and the capital of the central planets.
 	Location of the Allied Intelligence Network headquarters.
 
-	- Protectorate
-		planet Corona
+	- Council Capital
+		planet Corona /find a better name/
 
 	INDEPENDENT COLONIES (protected by the Colonial Militia)
 
@@ -58,12 +58,12 @@
 	- Antwerp system
 		starbase Helianthos (guards the border)
 		Buccaneer's Den pirate base
-		planet Antwerp?
 
 	NEUTRAL SYSTEMS
 	
 	- Finnmark (Joint Miners Association headquarters)
 		planet Finnmark
+		mining operations
 
 	- East End
 		Ensor station
@@ -98,6 +98,11 @@
 	- Kiana system
 		Kiana Prime
 
+	DERELICTS
+
+		The Kadriant
+
+
 	Note on names:
 
 	Before the war, the systems controlled by the Great Houses were
@@ -324,16 +329,16 @@ I. Business
 	the local bartender was kind enough to offer me a job in his modest establishment.
 	He probably did it more out of sympathy then anything else, but as it turned
 	out, I'm great at doing the dishes and I always enjoyed	our conversations. 
-	That is, until last week, when I met Mister Brent.
+	That is, until last week, when I ran into Mister Brent.
 	
-	I never really got to know him very well but he must have remembered me from high
-	school. I was sitting at the bar when he suddenly tapped my shoulder. My memories
-	of him were vague. As he sat down, I ordered him a drink. We had some chit-chat,
+	Ages ago, we used to work in the same building and he must have recognized me.
+	I was sitting at the bar when he suddenly tapped on my shoulder. My memories
+	of him were vague, but as he sat down, I ordered him a drink. We had some chit-chat,
 	shared a few memories of distant times, but it didn't take hime very long to come
 	to the point.
 	
-	Brent was the business type. "The rising star of the Regula mining operations,
-	overseeing all shipments of niobium ore in the Ghant system", to quote his words.
+	Mister Brent was the business type. "The rising star of the Regula mining operations,
+	overseeing all shipments of niobium in the Ghant system", to quote his words.
 	His phrases like "A smart man could make a fortune" sounded rather hollow to me,
 	but he did have a point. 500 runs to Regula to pay the loan for the ship.
 	Another 1500 more to get myself a ship big enough to hold a small cabin with all the
@@ -346,7 +351,7 @@ I. Business
 	exchanged for Micron Corporation's latest Vector model. It's a small ship: 
 	the cockpit, a living compartment with a sleeping corner and a cargo hold 
 	just big enough to hold a few metric tons of whatever the owner had in mind.
-	All it misses is a pair of blasters to shoot the mosquitos from the windshield.
+	All it missed was a pair of blasters to shoot the mosquitos from the windshield.
 	
 	That would have added another 50 runs to the price.
 	
@@ -447,15 +452,25 @@ III. The suit
 	A wise man once said: "Curiosity is mankind's greatest gift. But it is
 	also mankind's greatest curse."	I didn't have to take him for his word: 
 	I've been in situations before were I wasn't supposed to belong,
-	and me intuition told me that ship was probably something I didn't want to know about.
+	and me intuition told me that particular ship was something I didn't want to know about.
 
 	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
+	by now I had also learned that no regrets and focus on the task at hand was usually the wiser
 	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. I leaned casually against the back wall, my right hand trying to catch the
-	yawn escaping my mouth. 
+	moving upward. I leaned casually against the back wall while my right hand was trying to catch
+	the yawn escaping my mouth. 
+
+Temporary notes:
+
+	III about getting stunned in the cargo bay 
+
+	 IV about waking up on Starbase Helianthos
+
+	  V about Linblade and 'they've hidden it'
+
+	 VI about the Kadriant
diff --git a/developer/TODO b/developer/TODO
index 078f51c..2e0ba91 100644
--- a/developer/TODO
+++ b/developer/TODO
@@ -32,10 +32,10 @@ model:
 	(ok) support 'angles' key on the 'misc_model' map class
 
 core:
-	replace EntityControlable::afterburner() with control_flags,
-	replace impulse command with a control flag,
-	add AutoLevel amd AutoPilot control flags,
-	remove EntityControlable::movement()
+	add EntityControlable::control_flags() to group on/off controls (Impulse, AutoPilot?)
+		- afterburner is a -1/0/1 control and can't be added
+		- replace the impulse command with a control flag
+		- think about AutoLevel
 
 	fix dedicated server not showing chat messages (bug to be verified)
 	fix game.ini load/save sequence
@@ -43,7 +43,8 @@ core:
 	pause game loop when there are no players
 
 	(ok) optimize KeepAlive sweep performance
-	
+	(ok) remove EntityControlable::movement(), render dust based on control->speed()
+
 network:
 	protocol description (incomplete)
 	zone chat
@@ -75,18 +76,20 @@ client:
 	fix camera frustum clip (size issue, postponed)
 
 	(ok) have the trade menu show depleted shop items with their sell value
+	(ok) testmodel functionality	
 
 render:
+	disable texturing and lighting while drawing normals
 	fix skybox envmapping -> cube map
 	star light strenght
 	general globe texture stretching, coordinates seem to be off
-	
+
 	(ok) have r_loadmodels load particle scripts and flare textures
 
 	(unfixable) globe texture distortion at the poles
 
 ui:
-	modelview lighting (-> it uses current zone lighting)
+	
 	unify event handlers, expand Event class and make derived event classes	
 	listview scrolling
 	
@@ -95,6 +98,7 @@ ui:
 	until the button is released
 
 	(ok) slider mouse dragging
+	(ok) correct modelview lighting
 	
 sound:
 	entity/event positional sounds
@@ -115,6 +119,9 @@ game:
 	(ok) remove warning color from 'dock out of range' messages
 	(ok) when the goto command is used to target another player, appear above him, instead of in front of him.
 
+singleplayer:
+	think about a single player format and potential required core features
+
 documentation:
 	update starsystem roadmap
 	add starsystem roadmap to the user documentation
diff --git a/doc/models.html b/doc/models.html
index 5b51ba2..5a0e270 100644
--- a/doc/models.html
+++ b/doc/models.html
@@ -16,9 +16,9 @@
 <div class="text">
 <p>
 	The engine supports two kind of models: The first one are
-	Quake 3 style .map files with custom entities. The second
-	one are .ase models. Textures are supported, but no advanced features
-	like normal mapping.
+	Quake 3 style .map files with custom entities, the second
+	one are .ase models. Textures are supported, but no advanced 
+	features like normal maps.
 </p>
 <p>
 	The .map format allows for a quick and easy way to create usable
@@ -69,7 +69,7 @@
 </div>
 <div class="text">
 <p>
-	All the models for the game were created with GtkRadiant 1.5 and NetRadiant,
+	The .map models for the game were created with NetRadiant,
 	in theory any editor capable of exporting Quake 3 .map files could
 	be used. Support for files which can be used with NetRadiant or GtkRadiant 1.5
 	are included in the data distribution. Refer to the file INSTALL on where 
@@ -78,7 +78,7 @@
 <p></p>
 	You can also use the NetRadiant distribution from
 	<a href="http://ingar.satgnu.net/gtkradiant">http://ingar.satgnu.net/gtkradiant</a>.
-	Note that it does not include the Osirion support files by default.
+	Note that it does not include the Project::OSiRiON support files by default.
 <p></p>
 	This document will not explain how to use the editor. Consult google
 	for numerous tutorials on this subject. All basic brush editing
@@ -224,6 +224,8 @@ glass
 	For .ase models, the material name inside the .ase file is interpreted as an osirion material.
 	If you'd use a material called  <i>common/entity</i>, those model faces will rendered using
 	the object's primary in-game color, regardless of the actual material settings in the .ase file.
+	Note that it is the actual <i>ase material name</i> that is used, not the name of the diffuse texture
+	used by that material.
 </p>
 </div>
 
@@ -421,6 +423,21 @@ textures/ship/plating_entity
 </p>
 </div>
 
+<!-- =============================================================== -->
+<div class="title" id="commands">
+	Useful commands
+</div>
+<div class="text">
+<p>
+	The client has a built-in model viewer, you can view any model
+	by executing the <span class="fixed">testmodel<span> command:
+</p>
+<pre class="code">
+testmodel maps/colonial/alexandria
+</pre>
+
+</div>
+
 </body>
 </html>