Merge pull request #254 from randovania/feature/docs-tests

Basic documentation improvements for tests

README.md

@@ -1,6 +1,8 @@
 # Mercury Engine Data Structures
 Construct type definitions for Mercury Engine
 
+## Format Support
+
 | Format    | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) | Purpose     |
 |-----------|----------------------|-----------------------|--------------|---------------|-------------|
 | BAPD      | Missing              | Missing               | ✓      | ✓       | Audio Preset (positional audio data) |
@@ -19,13 +21,13 @@ Construct type definitions for Mercury Engine
 | BFSTM     | Missing              | Missing               | ✗      | ✗       | Common Switch audio format |
 | BGSNDS    | Missing              | Missing               | ✓      | ✓       | BackGround Sounds (?) |
 | BLDEF     | Missing              | Missing               | ✓      | ✓       | Actor Lighting Definition |
-| BLSND     | ✓              | ✓               | ✓      | ✓       | Sounds (?) |	
+| BLSND     | ✓              | ✓               | ✓      | ✓       | Sounds (?) |
 | BLUT      | Missing              | Missing               | ✓      | ✓       | LookUp Table (used for ADAM animation) |
 | BMBLS     | Missing              | Missing               | ✓      | ✓       | Blend Space |
 | BMDEFS    | ✓              | ✓               | ✓      | ✓       | Music Track Definitions & Properties	|
 | BMMAP     | Missing              | Missing               | ✓      | ✓       | MiniMap |
 | BMMDEF    | Missing              | Missing               | ✓      | ✓       | MiniMap Definitions (?) |
-| BMSAD     | ✓              | ✓               | ✓      | ✓       | Actor Definitions	| 
+| BMSAD     | ✓              | ✓               | ✓      | ✓       | Actor Definitions	|
 | BMSAS     | Missing              | Missing               | ✓      | ✓       | Action Sets |
 | BMSAT     | ✗              | ✗               | ✓      | ✓       | Animation Tree |
 | BMSBK     | ✓              | ✓               | Missing      | Missing       | Blocks, per Scenario |
@@ -44,7 +46,7 @@ Construct type definitions for Mercury Engine
 | BMSNAV    | ✓              | ✓               | ✓      | ✓       | Navigation Meshes	|
 | BMSND     | ✗              | ✗               | Missing      | Missing       | Sound (?)   |
 | BMSSA     | ✗              | ✗               | Missing      | Missing       | SSA (?)			|
-| BMSSD     | ✓              | ✓               | ✓      | ✓       | Scene Data (scene blocks, objects, msr lighting) |	
+| BMSSD     | ✓              | ✓               | ✓      | ✓       | Scene Data (scene blocks, objects, msr lighting) |
 | BMSSH     | Missing              | Missing               | ✓      | ✓       | GUI Shape |
 | BMSSK     | Missing              | Missing               | ✓      | ✓       | GUI Skin |
 | BMSSS     | Missing              | Missing               | ✓      | ✓       | GUI SpriteSheet |
@@ -62,7 +64,7 @@ Construct type definitions for Mercury Engine
 | BRSA      | Missing              | Missing               | ✓      | ✓       | SubArea Setups |
 | BRSPD     | Missing              | Missing               | ✓      | ✓       | Shot Audio Presets |
 | BSHDAT    | ✗              | ✗               | ✗      | ✗       | Shader Data	|
-| BSMAT     | Missing              | Missing               | ✓      | ✓       | Mesh Material |	
+| BSMAT     | Missing              | Missing               | ✓      | ✓       | Mesh Material |
 | BTUNDA    | Missing              | Missing               | ✓      | ✓       | Tunable Data |
 | BUCT      | ✓              | ✓               | ✓      | ✓       | Font Glyph Data (?) |
 | INI       | Missing              | Missing               | ✓      | ✓       | Standard INI |
@@ -93,3 +95,23 @@ Metroid Dread uses the following annotations in text to change color:
 | {c5} | Blue        |              |
 | {c6} | UI Active   | (Light blue) |
 | {c7} | UI Inactive | (Dim blue)   |
+
+
+## Tests
+
+For running the full test suite, the following environment variables must be set.
+
+| Variable           | Purpose                                        |
+|--------------------|------------------------------------------------|
+| SAMUS_RETURNS_PATH | Path to a Samus Returns extracted RomFS        |
+| DREAD_1_0_0_PATH   | Path to a Metroid Dread v1.0.0 extracted RomFS |
+| DREAD_2_1_0_PATH   | Path to a Metroid Dread v2.1.0 extracted RomFS |
+
+If any of these variables are not set, the associated tests are skipped.
+
+### Running
+
+```bash
+export SAMUS_RETURNS_PATH=D:/RomFS/Samus Returns
+python -m pytest
+```