From b3e7862290bb78b1555765131687b6d20fb11fde Mon Sep 17 00:00:00 2001 From: Stijn Buys Date: Tue, 29 Jul 2008 00:05:08 +0000 Subject: documentation updates --- doc/assets.html | 29 ++++++++++++++------- doc/world.html | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++--- 2 files changed, 95 insertions(+), 12 deletions(-) (limited to 'doc') diff --git a/doc/assets.html b/doc/assets.html index 6306968..3aca42d 100644 --- a/doc/assets.html +++ b/doc/assets.html @@ -75,37 +75,48 @@ /base/sounds/engines loop00.wav - nathanshadow
- - http://freesound.iua.upf.edu/samplesViewSingle.php?id=22454 + nathanshadow /base/sounds/engines loop01.wav - nathanshadow
- - http://freesound.iua.upf.edu/samplesViewSingle.php?id=22455 + nathanshadow /base/sounds/engines loop02.wav - nathanshadow
- - http://freesound.iua.upf.edu/samplesViewSingle.php?id=22456 + nathanshadow /base/textures/env sky.tga + + The Tycho Catalog Skymap
+ NASA/Goddard Space Flight Center Scientific Visualization Studio + + + + /base/textures/env + sky12.tga + + Thorn + + + + /base/textures/env + sky17.tga Thorn +

+

Files by nathanshadow are distributed under the terms of the diff --git a/doc/world.html b/doc/world.html index 4ae6bba..a8d9790 100644 --- a/doc/world.html +++ b/doc/world.html @@ -32,7 +32,7 @@ File structure

- A world description files uses the windows ini-file syntax. These files contain one or more sections. + World description files use the windows ini-file syntax. These files contain one or more sections. Every section starts with a section name enclosed in square brackets and contains a list of value=key pairs to describe the properties for the current section. Lines starting with a semicolon are considered comments and are ignored. @@ -50,9 +50,73 @@ texture=planets/iceworld

world.ini

+

- The world.ini file describes the objects in the game world and their basic properties. - In the context of the engine, an object is called an entity. + The world.ini file contains a list of zone labels. A zone is a seperate compartment in the gameworld, + like a solar system or a remote sector in space. It contains a single world section containting multiple + zone keys. +

+ [world] +

+ + + + + + + +
zone =[string]the in-game label of a zone
+

+ Note: a label can only contain lowercase letters, numbers and underscores. Any other character is deleted. + This applies to any in-game label in any .ini-file. + +

+; a world.ini example with two zones
+[world]
+zone=solarsystem
+zone=remotesector
+
+

+ zones/label.ini +

+

+ Each zone has its own zone description file. The actual name of the file depends on the zone label. + If your world.ini contains the line zone=remotesector, the content of the zone with + the label remotesector would be described in the file ini/zones/remotesector.ini. +

+ The .ini-file containts a list of objects populating that zone, and the basic properties of those + objects. In the context of the engine, such an object is called an entity. +

+ [zone] +

+ +

+ Every zone description file has a zone section describing a few of its basic properties: + + + + + + + + + + + + + + + + +
name =[string]the in-game name of the entity
sky =[string]name of the sky texture in textures/env directory
default =[bool]mark this zone as the default zone for the game, only one zone can have this key set to yes, can be omitted elsewhere
+

+; remotesector.ini
+; zone description file for the Remote Sector
+[sector]
+name=Remote Sector
+sky=sky_texture
+default=no
+

[entity]

@@ -199,6 +263,14 @@ color=222 192 145

A planet is spherical entity with a texture. and a default radius of 32. The planet globe will be rendered with lighting enabled. + + + + + + +
texture =[string]name of the planet texture in textures directory
+ 

 ; The iceworld, a very dark and cold place
 [planet]
-- 
cgit v1.2.3