Skip to content

Commit

Permalink
Merge pull request #215 from sabre230/sabre230-meds-docs
Browse files Browse the repository at this point in the history 
Update README with more info regarding mercury formats
  • Loading branch information
@henriquegemignani
henriquegemignani committed Sep 8, 2024
2 parents d30c96d + 7cf01f0 commit c7b1d2b
Showing 1 changed file with 70 additions and 70 deletions.
140 changes: 70 additions & 70 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,76 +1,76 @@
# Mercury Engine Data Structures
Construct type definitions for Mercury Engine

| Format | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) |
|-----------|----------------------|-----------------------|--------------|---------------|
| BAPD | Missing | Missing | ✓ | ✓ |
| BCCAM | ✗ | ✗ | ✗ | ✗ |
| BCLGT | ✗ | ✗ | Missing | Missing |
| BCMDL | ✗ | ✗ | ✓ | ✗ |
| BCPTL | ✗ | ✗ | ✗ | ✗ |
| BCSKLA | ✓ | ✓ | ✓ | ✓ |
| BCTEX | ✗ | ✗ | ✓ | ✗ |
| BCURV | Missing | Missing | ✗ | ✗ |
| BCUT | ✗ | ✗ | Missing | Missing |
| BCWAV | ✗ | ✗ | Missing | Missing |
| BFGRP | Missing | Missing | ✗ | ✗ |
| BFONT | ✗ | ✗ | ✗ | ✗ |
| BFSAR | Missing | Missing | ✗ | ✗ |
| BFSTM | Missing | Missing | ✗ | ✗ |
| BGSNDS | Missing | Missing | ✓ | ✓ |
| BLDEF | Missing | Missing | ✓ | ✓ |
| BLSND | ✓ | ✓ | ✓ | ✓ |
| BLUT | Missing | Missing | ✓ | ✓ |
| BMBLS | Missing | Missing | ✓ | ✓ |
| BMDEFS | ✓ | ✓ | ✓ | ✓ |
| BMMAP | Missing | Missing | ✓ | ✓ |
| BMMDEF | Missing | Missing | ✓ | ✓ |
| BMSAD | ✓ | ✓ | ✓ | ✓ |
| BMSAS | Missing | Missing | ✓ | ✓ |
| BMSAT | ✗ | ✗ | ✓ | ✓ |
| BMSBK | ✓ | ✓ | Missing | Missing |
| BMSCC | ✓ | ✓ | ✓ | ✓ |
| BMSCD | ✓ | ✓ | ✓ | ✓ |
| BMSCP | Missing | Missing | ✓ | ✓ |
| BMSCU | ✗ | ✗ | ✓ | ✓ |
| BMSEM | ✓ | ✓ | Missing | Missing |
| BMSES | ✓ | ✓ | Missing | Missing |
| BMSEV | ✗ | ✗ | Missing | Missing |
| BMSLD | ✓ | ✓ | Missing | Missing |
| BMSLGROUP | Missing | Missing | ✓ | ✓ |
| BMSLINK | Missing | Missing | ✓ | ✓ |
| BMSMD | ✓ | ✓ | Missing | Missing |
| BMSMSD | ✓ | ✓ | Missing | Missing |
| BMSNAV | ✓ | ✓ | ✓ | ✓ |
| BMSND | ✗ | ✗ | Missing | Missing |
| BMSSA | ✗ | ✗ | Missing | Missing |
| BMSSD | ✗ | ✗ | ✓ | ✓ |
| BMSSH | Missing | Missing | ✓ | ✓ |
| BMSSK | Missing | Missing | ✓ | ✓ |
| BMSSS | Missing | Missing | ✓ | ✓ |
| BMSSTOC | Missing | Missing | ✗ | ✗ |
| BMTRE | ✗ | ✗ | ✓ | ✓ |
| BMTUN | ✓ | ✓ | Missing | Missing |
| BNVIB | Missing | Missing | ✓ | ✓ |
| BPSI | ✓ | ✓ | ✓ | ✓ |
| BPTDAT | Missing | Missing | ✓ | ✓ |
| BPTDEF | Missing | Missing | ✓ | ✓ |
| BREM | Missing | Missing | ✓ | ✓ |
| BRES | Missing | Missing | ✓ | ✓ |
| BREV | Missing | Missing | ✓ | ✓ |
| BRFLD | Missing | Missing | ✓ | ✓ |
| BRSA | Missing | Missing | ✓ | ✓ |
| BRSPD | Missing | Missing | ✓ | ✓ |
| BSHDAT | ✗ | ✗ | ✗ | ✗ |
| BSMAT | Missing | Missing | ✓ | ✓ |
| BTUNDA | Missing | Missing | ✓ | ✓ |
| BUCT | ✓ | ✓ | ✓ | ✓ |
| INI | Missing | Missing | ✓ | ✓ |
| LC | ✓ | ✓ | ✓ | ✓ |
| PKG | ✓ | ✓ | ✓ | ✓ |
| TOC | ✓ | ✓ | ✓ | ✓ |
| TXT | ✓ | ✓ | ✓ | ✓ |
| WEBM | Missing | Missing | ✗ | ✗ |
| Format | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) | Purpose |
|-----------|----------------------|-----------------------|--------------|---------------|-------------|
| BAPD | Missing | Missing | ✓ | ✓ | Audio Preset (positional audio data) |
| BCCAM | ✗ | ✗ | ✗ | ✗ | Camera Animation (used exclusively for cutscene takes) |
| BCLGT | ✗ | ✗ | Missing | Missing | Lighting (?) |
| BCMDL | ✗ | ✗ | ✓ | ✗ | 3D Models |
| BCPTL | ✗ | ✗ | ✗ | ✗ | Particle Effect |
| BCSKLA | ✓ | ✓ | ✓ | ✓ | Skeleton Animation |
| BCTEX | ✗ | ✗ | ✓ | ✗ | Texture File |
| BCURV | Missing | Missing | ✗ | ✗ | CURV (?) |
| BCUT | ✗ | ✗ | Missing | Missing | Related to cutscene files |
| BCWAV | ✗ | ✗ | Missing | Missing | Cafe/Citra Wave (common AAL audio format) |
| BFGRP | Missing | Missing | ✗ | ✗ | Sound WaveGroup (common AAL audio format) |
| BFONT | ✗ | ✗ | ✗ | ✗ | Font File |
| BFSAR | Missing | Missing | ✗ | ✗ | FSAR (?) |
| BFSTM | Missing | Missing | ✗ | ✗ | Common Switch audio format |
| BGSNDS | Missing | Missing | ✓ | ✓ | BackGround Sounds (?) |
| BLDEF | Missing | Missing | ✓ | ✓ | Actor Lighting Definition |
| 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 |
| BMSAS | Missing | Missing | ✓ | ✓ | Action Sets |
| BMSAT | ✗ | ✗ | ✓ | ✓ | Animation Tree |
| BMSBK | ✓ | ✓ | Missing | Missing | Blocks, per Scenario |
| BMSCC | ✓ | ✓ | ✓ | ✓ | Collision Cameras |
| BMSCD | ✓ | ✓ | ✓ | ✓ | Collision Data / Geometry |
| BMSCP | Missing | Missing | ✓ | ✓ | GUI Composition |
| BMSCU | ✗ | ✗ | ✓ | ✓ | Cutscene Files |
| BMSEM | ✓ | ✓ | Missing | Missing | Environment Music |
| BMSES | ✓ | ✓ | Missing | Missing | Environment Sound |
| BMSEV | ✗ | ✗ | Missing | Missing | Environment Visuals (fx) |
| BMSLD | ✓ | ✓ | Missing | Missing | Samus Returns scenario entity data |
| BMSLGROUP | Missing | Missing | ✓ | ✓ | SmartLink Group |
| BMSLINK | Missing | Missing | ✓ | ✓ | SmartLink (actor-specific navmesh paths) |
| BMSMD | ✓ | ✓ | Missing | Missing | Menu Data (?) |
| BMSMSD | ✓ | ✓ | Missing | Missing | Map Screen Data (?) |
| BMSNAV | ✓ | ✓ | ✓ | ✓ | Navigation Meshes |
| BMSND | ✗ | ✗ | Missing | Missing | Sound (?) |
| BMSSA | ✗ | ✗ | Missing | Missing | SSA (?) |
| BMSSD | ✗ | ✗ | ✓ | ✓ | Static Scenario Data (background dressing) |
| BMSSH | Missing | Missing | ✓ | ✓ | GUI Shape |
| BMSSK | Missing | Missing | ✓ | ✓ | GUI Skin |
| BMSSS | Missing | Missing | ✓ | ✓ | GUI SpriteSheet |
| BMSSTOC | Missing | Missing | ✗ | ✗ | Sound Table of Contents (links BFSAR sfx to BFGRP files) |
| BMTRE | ✗ | ✗ | ✓ | ✓ | Behavior Tree; entitity AI)|
| BMTUN | ✓ | ✓ | Missing | Missing | Tunables; exposed variables |
| BNVIB | Missing | Missing | ✓ | ✓ | Vibration Data |
| BPSI | ✓ | ✓ | ✓ | ✓ | PackSet; dev leftovers |
| BPTDAT | Missing | Missing | ✓ | ✓ | PlayThrough Data |
| BPTDEF | Missing | Missing | ✓ | ✓ | PlayThrough Def |
| BREM | Missing | Missing | ✓ | ✓ | Environmental Music Presets |
| BRES | Missing | Missing | ✓ | ✓ | Environmental Sound Presets |
| BREV | Missing | Missing | ✓ | ✓ | Environmental Visual Presets |
| BRFLD | Missing | Missing | ✓ | ✓ | Dread Scenario Entity Data |
| BRSA | Missing | Missing | ✓ | ✓ | SubArea Setups |
| BRSPD | Missing | Missing | ✓ | ✓ | Shot Audio Presets |
| BSHDAT | ✗ | ✗ | ✗ | ✗ | Shader Data |
| BSMAT | Missing | Missing | ✓ | ✓ | Mesh Material |
| BTUNDA | Missing | Missing | ✓ | ✓ | Tunable Data |
| BUCT | ✓ | ✓ | ✓ | ✓ | Font Glyph Data (?) |
| INI | Missing | Missing | ✓ | ✓ | Standard INI |
| LC | ✓ | ✓ | ✓ | ✓ | Lua Bytecode |
| PKG | ✓ | ✓ | ✓ | ✓ | Packaged Files |
| TOC | ✓ | ✓ | ✓ | ✓ | Table of Contents |
| TXT | ✓ | ✓ | ✓ | ✓ | UTF-16 Text File (?) |
| WEBM | Missing | Missing | ✗ | ✗ | Standard WEBM |


## Example Usage
Expand Down

0 comments on commit c7b1d2b

Please sign in to comment.