Mercurial > atc

annotate docs/Maps.txt @ 57:35999e551d7a server tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Call state's update method 2 times per second
author Josef "Jeff" Sipek <jeffpc@josefsipek.net>
date Sun, 03 Jun 2007 01:25:28 -0400
parents 05245904f997
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
1 Map pack description:
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
2 =====================
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
3
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
4 By default, maps are located in maps/, but this can be changed in the config
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
5 file. In this file, we'll assume that the config file contains the default
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
6 settings.
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
7
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
8 Here is a sample directory structure we'll work with:
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
9
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
10 maps/
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
11 |-- map1/
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
12 | |-- map.info
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
13 | |-- map.png
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
14 | `-- navaid.info
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
15 |-- map2/
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
16 | |-- map.info
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
17 | |-- map.png
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
18 | `-- navaid.info
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
19 `-- default/
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
20 |-- map.info
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
21 |-- map.png
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
22 `-- navaid.info
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
23
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
24 As you can see, the maps/ contains directories, one per map. Each of the map
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
25 directories contains the three basic files:
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
26 * map.info = information about the map
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
27 * map.png = the map "background" image
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
28 * navaid.info = navigation aids information
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
29 Let's look at each of these files individually.
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
30
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
31 map.info:
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
32 =========
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
33
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
34 There are 5 lines (separated by "\n") they contain the following information:
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
35 * number (decimal) of degrees to be added to the longitude. Internally, the
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
36 center of the image is (0,0), but to allow different geographic locations
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
37 this number is simply added whenever we want to display the true longitude
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
38 * number (decimal) of degrees to be added to the latitude. Internally, the
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
39 center of the image is (0,0), but to allow different geographic locations
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
40 this number is simply added whenever we want to display the true latitude
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
41 * number (decimal) of meters per pixel
42
05245904f997 Slight change in map specs
Josef "Jeff" Sipek <jeffpc@optonline.net>
parents: 26
diff changeset
42 * ATC offset from the center of the background image, left is negative, right
05245904f997 Slight change in map specs
Josef "Jeff" Sipek <jeffpc@optonline.net>
parents: 26
diff changeset
43 is positive (pixels)
05245904f997 Slight change in map specs
Josef "Jeff" Sipek <jeffpc@optonline.net>
parents: 26
diff changeset
44 * ATC offset from the center of the background image, down is negative, up is
05245904f997 Slight change in map specs
Josef "Jeff" Sipek <jeffpc@optonline.net>
parents: 26
diff changeset
45 positive (pixels)
26
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
46
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
47 map.png:
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
48 ========
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
49
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
50 A standard, non-transparent 1024x768 PNG image to be used as the map itself.
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
51
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
52 navaid.info:
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
53 ============
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
54
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
55 Contains an unlimited number of navigation aiding beacons. Each beacon takes
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
56 up one line (separated by "\n"). Each line can be split by spaces into six
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
57 parts:
42
05245904f997 Slight change in map specs
Josef "Jeff" Sipek <jeffpc@optonline.net>
parents: 26
diff changeset
58 * beacon offset from the center, left is negative, right is positive (pixels)
05245904f997 Slight change in map specs
Josef "Jeff" Sipek <jeffpc@optonline.net>
parents: 26
diff changeset
59 * beacon offset from the center, down is negative, up is positive (pixels)
26
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
60 * beacon frequency (MHz)
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
61 * beacon name (string)
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
62 * beacon range (meters)
db207c3ed161 Added description of the map directory structure
Jeff <jeffpc@batlh.(none)>
parents:
diff changeset
63