fixed index. Added table headers.
authorecalot <ecalot>
Mon, 30 Apr 2007 16:28:28 +0000 (16:28 +0000)
committerecalot <ecalot>
Mon, 30 Apr 2007 16:28:28 +0000 (16:28 +0000)
FP/doc/FormatSpecifications
FP/doc/FormatSpecifications.tex

index 7013420fe4f9f0a8c51dbf10a43d15b8e6127bbb..f1b58a4ff674bbe7c7af6390943b271db1ffc120 100644 (file)
@@ -7,43 +7,43 @@ Table of Contents
 ~~~~~ ~~ ~~~~~~~~
 1. Preamble ............................................................ 49
 2. Introduction ........................................................ 58
-3. DAT v1.0 Format Specifications ...................................... 90
-3.1. General file specs, index and checksums ........................... 93
-3.2. Images ........................................................... 185
-3.2.1 Headers ......................................................... 189
-3.2.2 Algorithms ...................................................... 214
-3.2.2.1 Run length encoding (RLE) ..................................... 230
-3.2.2.2 LZ variant (LZG) .............................................. 242
-3.3. Palettes ......................................................... 300
-3.4. Levels ........................................................... 307
-3.4.1 Unknown blocks .................................................. 338
-3.4.2 Room mapping .................................................... 356
-3.4.2.1 Wall drawing algorithm ........................................ 492
-3.4.3 Room linking .................................................... 560
-3.4.4 Guard handling .................................................. 576
-3.4.5 Starting Position ............................................... 624
-3.4.6 Door events ..................................................... 638
-3.5. Digital Waves .................................................... 682
-3.6. Midi music ....................................................... 699
-3.7. Internal PC Speaker .............................................. 702
-3.8. Binary files ..................................................... 707
-4. DAT v2.0 Format Specifications ..................................... 714
-4.1. General file specs, index and checksums .......................... 717
-4.1.1 The master index ................................................ 744
-4.1.2 The slave indexes ............................................... 790
-4.2. Levels ........................................................... 810
-4.2.1 Room mapping .................................................... 833
-4.2.2 Door events ..................................................... 926
-4.2.3 Guard handling .................................................. 947
-4.2.3.1 Static guards ................................................. 960
-4.2.3.2 Dynamic guards ............................................... 1007
-5. PLV v1.0 Format Specifications .................................... 1040
-5.1. User data ....................................................... 1067
-5.2. Allowed Date format ............................................. 1097
-6. The SAV v1.0 format ............................................... 1111
-7. The HOF v1.0 format ............................................... 1157
-8. Credits ........................................................... 1180
-9. License ........................................................... 1201
+3. DAT v1.0 Format Specifications ...................................... 91
+3.1. General file specs, index and checksums ........................... 94
+3.2. Images ........................................................... 186
+3.2.1 Headers ......................................................... 190
+3.2.2 Algorithms ...................................................... 215
+3.2.2.1 Run length encoding (RLE) ..................................... 231
+3.2.2.2 LZ variant (LZG) .............................................. 243
+3.3. Palettes ......................................................... 301
+3.4. Levels ........................................................... 384
+3.4.1 Unknown blocks .................................................. 415
+3.4.2 Room mapping .................................................... 433
+3.4.2.1 Wall drawing algorithm ........................................ 569
+3.4.3 Room linking .................................................... 637
+3.4.4 Guard handling .................................................. 653
+3.4.5 Starting Position ............................................... 701
+3.4.6 Door events ..................................................... 715
+3.5. Digital Waves .................................................... 759
+3.6. Midi music ....................................................... 776
+3.7. Internal PC Speaker .............................................. 779
+3.8. Binary files ..................................................... 784
+4. DAT v2.0 Format Specifications ..................................... 791
+4.1. General file specs, index and checksums .......................... 794
+4.1.1 The master index ................................................ 821
+4.1.2 The slave indexes ............................................... 870
+4.2. Levels ........................................................... 904
+4.2.1 Room mapping .................................................... 926
+4.2.2 Door events .................................................... 1019
+4.2.3 Guard handling ................................................. 1040
+4.2.3.1 Static guards ................................................ 1053
+4.2.3.2 Dynamic guards ............................................... 1100
+5. PLV v1.0 Format Specifications .................................... 1133
+5.1. User data ....................................................... 1160
+5.2. Allowed Date format ............................................. 1190
+6. The SAV v1.0 format ............................................... 1204
+7. The HOF v1.0 format ............................................... 1250
+8. Credits ........................................................... 1273
+9. License ........................................................... 1294
 
 
 1. Preamble
@@ -362,8 +362,10 @@ Table of Contents
  
  So for example if the entry 1 is 00101000 (0x28) in mode CGA2, the pattern
  will be a checkerboard of black and green like the following:
-  00 01  -  black  green
-  01 00  -  green  black
+
+  Bin       Dec     Colour
+  00 01  -  0 1  -  black  green
+  01 00  -  1 0  -  green  black
 
  The ega_patterns block stores 16 records of two bytes each, this time
  separated in two parts. So we have again, four parts per record in the
@@ -374,8 +376,10 @@ Table of Contents
  
  For example, with 00101111 11110010 (0x2ff2) you can create the following
  pattern:
-  0010 1111  -  brown  white
-  1111 0010  -  white  brown
+
+  Bin           Dec       Colour
+  0010 1111  -  2  15  -  brown  white
+  1111 0010  -  15 2   -  white  brown
 
 3.4. Levels
  This table has a summary of the blocks to be used in this section,
index 7013420fe4f9f0a8c51dbf10a43d15b8e6127bbb..f1b58a4ff674bbe7c7af6390943b271db1ffc120 100644 (file)
@@ -7,43 +7,43 @@ Table of Contents
 ~~~~~ ~~ ~~~~~~~~
 1. Preamble ............................................................ 49
 2. Introduction ........................................................ 58
-3. DAT v1.0 Format Specifications ...................................... 90
-3.1. General file specs, index and checksums ........................... 93
-3.2. Images ........................................................... 185
-3.2.1 Headers ......................................................... 189
-3.2.2 Algorithms ...................................................... 214
-3.2.2.1 Run length encoding (RLE) ..................................... 230
-3.2.2.2 LZ variant (LZG) .............................................. 242
-3.3. Palettes ......................................................... 300
-3.4. Levels ........................................................... 307
-3.4.1 Unknown blocks .................................................. 338
-3.4.2 Room mapping .................................................... 356
-3.4.2.1 Wall drawing algorithm ........................................ 492
-3.4.3 Room linking .................................................... 560
-3.4.4 Guard handling .................................................. 576
-3.4.5 Starting Position ............................................... 624
-3.4.6 Door events ..................................................... 638
-3.5. Digital Waves .................................................... 682
-3.6. Midi music ....................................................... 699
-3.7. Internal PC Speaker .............................................. 702
-3.8. Binary files ..................................................... 707
-4. DAT v2.0 Format Specifications ..................................... 714
-4.1. General file specs, index and checksums .......................... 717
-4.1.1 The master index ................................................ 744
-4.1.2 The slave indexes ............................................... 790
-4.2. Levels ........................................................... 810
-4.2.1 Room mapping .................................................... 833
-4.2.2 Door events ..................................................... 926
-4.2.3 Guard handling .................................................. 947
-4.2.3.1 Static guards ................................................. 960
-4.2.3.2 Dynamic guards ............................................... 1007
-5. PLV v1.0 Format Specifications .................................... 1040
-5.1. User data ....................................................... 1067
-5.2. Allowed Date format ............................................. 1097
-6. The SAV v1.0 format ............................................... 1111
-7. The HOF v1.0 format ............................................... 1157
-8. Credits ........................................................... 1180
-9. License ........................................................... 1201
+3. DAT v1.0 Format Specifications ...................................... 91
+3.1. General file specs, index and checksums ........................... 94
+3.2. Images ........................................................... 186
+3.2.1 Headers ......................................................... 190
+3.2.2 Algorithms ...................................................... 215
+3.2.2.1 Run length encoding (RLE) ..................................... 231
+3.2.2.2 LZ variant (LZG) .............................................. 243
+3.3. Palettes ......................................................... 301
+3.4. Levels ........................................................... 384
+3.4.1 Unknown blocks .................................................. 415
+3.4.2 Room mapping .................................................... 433
+3.4.2.1 Wall drawing algorithm ........................................ 569
+3.4.3 Room linking .................................................... 637
+3.4.4 Guard handling .................................................. 653
+3.4.5 Starting Position ............................................... 701
+3.4.6 Door events ..................................................... 715
+3.5. Digital Waves .................................................... 759
+3.6. Midi music ....................................................... 776
+3.7. Internal PC Speaker .............................................. 779
+3.8. Binary files ..................................................... 784
+4. DAT v2.0 Format Specifications ..................................... 791
+4.1. General file specs, index and checksums .......................... 794
+4.1.1 The master index ................................................ 821
+4.1.2 The slave indexes ............................................... 870
+4.2. Levels ........................................................... 904
+4.2.1 Room mapping .................................................... 926
+4.2.2 Door events .................................................... 1019
+4.2.3 Guard handling ................................................. 1040
+4.2.3.1 Static guards ................................................ 1053
+4.2.3.2 Dynamic guards ............................................... 1100
+5. PLV v1.0 Format Specifications .................................... 1133
+5.1. User data ....................................................... 1160
+5.2. Allowed Date format ............................................. 1190
+6. The SAV v1.0 format ............................................... 1204
+7. The HOF v1.0 format ............................................... 1250
+8. Credits ........................................................... 1273
+9. License ........................................................... 1294
 
 
 1. Preamble
@@ -362,8 +362,10 @@ Table of Contents
  
  So for example if the entry 1 is 00101000 (0x28) in mode CGA2, the pattern
  will be a checkerboard of black and green like the following:
-  00 01  -  black  green
-  01 00  -  green  black
+
+  Bin       Dec     Colour
+  00 01  -  0 1  -  black  green
+  01 00  -  1 0  -  green  black
 
  The ega_patterns block stores 16 records of two bytes each, this time
  separated in two parts. So we have again, four parts per record in the
@@ -374,8 +376,10 @@ Table of Contents
  
  For example, with 00101111 11110010 (0x2ff2) you can create the following
  pattern:
-  0010 1111  -  brown  white
-  1111 0010  -  white  brown
+
+  Bin           Dec       Colour
+  0010 1111  -  2  15  -  brown  white
+  1111 0010  -  15 2   -  white  brown
 
 3.4. Levels
  This table has a summary of the blocks to be used in this section,