changeset 26:db207c3ed161

Added description of the map directory structure committer: Jeff <jeffpc@batlh.(none)> 1121712111 -0400
author Jeff <jeffpc@batlh.(none)>
date Mon, 18 Jul 2005 18:41:51 -0400
parents dde511571317
children 8ad7abaf91e4
files docs/Maps.txt
diffstat 1 files changed, 61 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/Maps.txt	Mon Jul 18 18:41:51 2005 -0400
@@ -0,0 +1,61 @@
+Map pack description:
+=====================
+
+By default, maps are located in maps/, but this can be changed in the config
+file. In this file, we'll assume that the config file contains the default
+settings.
+
+Here is a sample directory structure we'll work with:
+
+maps/
+ |-- map1/
+ |    |-- map.info
+ |    |-- map.png
+ |    `-- navaid.info
+ |-- map2/
+ |    |-- map.info
+ |    |-- map.png
+ |    `-- navaid.info
+ `-- default/
+      |-- map.info
+      |-- map.png
+      `-- navaid.info
+
+As you can see, the maps/ contains directories, one per map. Each of the map
+directories contains the three basic files:
+ * map.info	= information about the map
+ * map.png	= the map "background" image
+ * navaid.info	= navigation aids information
+Let's look at each of these files individually.
+
+map.info:
+=========
+
+There are 5 lines (separated by "\n") they contain the following information:
+* number (decimal) of degrees to be added to the longitude. Internally, the
+  center of the image is (0,0), but to allow different geographic locations
+  this number is simply added whenever we want to display the true longitude
+* number (decimal) of degrees to be added to the latitude. Internally, the
+  center of the image is (0,0), but to allow different geographic locations
+  this number is simply added whenever we want to display the true latitude
+* number (decimal) of meters per pixel
+* tower offset from the left edge of the background image (pixels)
+* tower offset from the top edge of the background image (pixels)
+
+map.png:
+========
+
+A standard, non-transparent 1024x768 PNG image to be used as the map itself.
+
+navaid.info:
+============
+
+Contains an unlimited number of navigation aiding beacons. Each beacon takes
+up one line (separated by "\n"). Each line can be split by spaces into six
+parts:
+* beacon offset from the left edge (pixels)
+* beacon offset from the top edge (pixels)
+* beacon frequency (MHz)
+* beacon name (string)
+* beacon range (meters)
+