Add .wak documentation

Author: tgjones

README.md

@@ -0,0 +1,8 @@
+# SAGE Docs
+
+A place where we gather knowledge around the SAGE engine, created by EA games. Feel free to contribute.
+
+## File Formats
+
+* [.big](file-formats/big/) - archive format, used as the container for most files in SAGE games
+* [.wak](file-formats/wak/) - wave definition file, used in C&C Generals to store the location and type of ocean and pond waves

ReadMe.md

@@ -1,8 +1,12 @@
-# Description:
+# BIG
+
+## Description
+
 Big files are an archive format, that was used in many game titles created by EA Studios
 
-# Specification:
-## Header
+## Specification
+
+### Header
 
 The header has a fixed size of 16 bytes, following the table below:
 
@@ -18,7 +22,7 @@ The header has a fixed size of 16 bytes, following the table below:
 * NUM_ENTRIES: Number of files that were packed into this archive
 * OFFSET_FIRST: The offset inside the file to the first entry
 
-## List of entries
+### List of entries
 
 After the header the follows a list with NUM_ENTRIES elements, each entry looks the following:
 

Big-Archive.md renamed to file-formats/big/README.md

@@ -0,0 +1,49 @@
+# WAK
+
+## Description
+
+`.wak` files were used in C&C Generals and Zero Hour to store ocean and pond wave definitions. In later SAGE games, this data became part of the `.map` format.
+
+Not all maps have accompanying `.wak` files, but those that require wave movement do.
+
+## Specification
+
+### File Structure
+
+The file has a variable number of entries. The number of entries is stored at the end of the file.
+
+| Offset | Bytes | Type         | Name        |
+|--------|-------|--------------|-------------|
+| 0      | N     | WAVE_ENTRY[] | ENTRIES     |
+| N      | 4     | UINT         | NUM_ENTRIES |
+
+* WAVE_ENTRY: See below for wave entry structure
+* NUM_ENTRIES: Number of entries
+
+### Wave Entry
+
+Each WAVE_ENTRY looks like the following:
+
+| Offset | Bytes | Type  | Name      |
+|--------|-------|-------|-----------|
+| 0      | 4     | UINT  | START_X   |
+| 4      | 4     | UINT  | START_Y   |
+| 8      | 4     | UINT  | END_X     |
+| 12     | 4     | UINT  | END_Y     |
+| 16     | 4     | UINT  | WAVE_TYPE |
+
+* START_X and START_Y: Specify the start position of the wave
+* END_X and END_Y: Specify the end position of the wave
+* WAVE_TYPE: Type of the wave. See WAVE_TYPE enumeration below.
+
+### Enumerations
+
+#### Wave Type
+
+| Value | Name               |
+|-------|--------------------|
+| 0     | POND               |
+| 1     | OCEAN              |
+| 2     | CLOSE_OCEAN        |
+| 3     | CLOSE_OCEAN_DOUBLE |
+| 4     | RADIAL             |