changeset 27:8ad7abaf91e4

Added description of the Plane files committer: Jeff <jeffpc@batlh.(none)> 1121712958 -0400
author Jeff <jeffpc@batlh.(none)>
date Mon, 18 Jul 2005 18:55:58 -0400
parents db207c3ed161
children 6854dc3a8273
files docs/Planes.txt
diffstat 1 files changed, 20 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/Planes.txt	Mon Jul 18 18:55:58 2005 -0400
@@ -0,0 +1,20 @@
+Plane Description Format:
+=========================
+
+By default, the airplane description files are in planes/ directory, but that
+can be changed by editing the config file. We'll assume that the config file
+contains the default values.
+
+The planes/ directory contains the description files directly. For example,
+planes/B747.info is a file with the Boeing 747 specs.
+
+Each line contains label-value pair, these are the labels supported as of now:
+* FullName	= The long name for the plane, eg. "Boeing 747-400" (string)
+* Name		= The 3-4 letter abbreviation, eg. "B747" (string)
+* Heavy		= Is this plane considered "heavy"? (yes/no)
+* Jet		= Is it a jet? (yes/no)
+* StallSpeed	= Stall speed of this aircraft (number)
+* ClimbNormal	= Normal rate of climb (number)
+* MaxAltitude	= Maximum altitude for this aircraft (number)
+
+Note: There must be a ": " after each label, and the label names are case sensitive.