From 35f3d03e06db3cc9b01da8b21fcd96d18a4acb7a Mon Sep 17 00:00:00 2001 From: sabre230 Date: Wed, 28 Aug 2024 12:39:43 -0700 Subject: [PATCH 1/8] Update README with more info regarding MSR types Includes some notes --- README.md | 140 +++++++++++++++++++++++++++--------------------------- 1 file changed, 70 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index 9902db24..722d48cf 100644 --- a/README.md +++ b/README.md @@ -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) | Samus Returns (Purpose) | Samus Returns (Notes) | +|-----------|----------------------|-----------------------|--------------|---------------|-------------------------|-----------------------| +| BAPD | Missing | Missing | ✓ | ✓ | | | +| BCCAM | ✗ | ✗ | ✗ | ✗ | Camera Objects | | +| BCLGT | ✗ | ✗ | Missing | Missing | Lighting (?) | | +| BCMDL | ✗ | ✗ | ✓ | ✗ | 3D Models | | +| BCPTL | ✗ | ✗ | ✗ | ✗ | PTL (?) | | +| BCSKLA | ✓ | ✓ | ✓ | ✓ | Skeleton Animation | | +| BCTEX | ✗ | ✗ | ✓ | ✗ | Texture File | Texture files can be dumped, customized, and re-written using popular 3DS emulation software.| +| BCURV | Missing | Missing | ✗ | ✗ | | | +| BCUT | ✗ | ✗ | Missing | Missing | UT (?) | | +| BCWAV | ✗ | ✗ | Missing | Missing | WAV Audio File | | +| BFGRP | Missing | Missing | ✗ | ✗ | | | +| BFONT | ✗ | ✗ | ✗ | ✗ | Font File | | +| BFSAR | Missing | Missing | ✗ | ✗ | | | +| BFSTM | Missing | Missing | ✗ | ✗ | | | +| BGSNDS | Missing | Missing | ✓ | ✓ | | | +| BLDEF | Missing | Missing | ✓ | ✓ | | | +| BLSND | ✓ | ✓ | ✓ | ✓ | Sound | | +| BLUT | Missing | Missing | ✓ | ✓ | | | +| BMBLS | Missing | Missing | ✓ | ✓ | | | +| BMDEFS | ✓ | ✓ | ✓ | ✓ | Definitions | | +| BMMAP | Missing | Missing | ✓ | ✓ | | | +| BMMDEF | Missing | Missing | ✓ | ✓ | | | +| BMSAD | ✓ | ✓ | ✓ | ✓ | Actor Definitions | Defines data used for all instances of an actor (doors, enemies, etc.)| +| BMSAS | Missing | Missing | ✓ | ✓ | | | +| BMSAT | ✗ | ✗ | ✓ | ✓ | AT (?) | | +| BMSBK | ✓ | ✓ | Missing | Missing | Blocks (?) | | +| BMSCC | ✓ | ✓ | ✓ | ✓ | Collision Cameras | | +| BMSCD | ✓ | ✓ | ✓ | ✓ | Collision Data |Geometry | +| BMSCP | Missing | Missing | ✓ | ✓ | | | +| BMSCU | ✗ | ✗ | ✓ | ✓ | CU (?) | | +| BMSEM | ✓ | ✓ | Missing | Missing | Environment Data | | +| BMSES | ✓ | ✓ | Missing | Missing | Environment Data | | +| BMSEV | ✗ | ✗ | Missing | Missing | EV (?) | | +| BMSLD | ✓ | ✓ | Missing | Missing | Level Data | Essentially a game scene| +| BMSLGROUP | Missing | Missing | ✓ | ✓ | | | +| BMSLINK | Missing | Missing | ✓ | ✓ | | | +| BMSMD | ✓ | ✓ | Missing | Missing | Menu Data (?) | | +| BMSMSD | ✓ | ✓ | Missing | Missing | Map Screen Data (?) | | +| BMSNAV | ✓ | ✓ | ✓ | ✓ | Navigation Meshes | | +| BMSND | ✗ | ✗ | Missing | Missing | Sound (?) | Not sure if related to BLSND| +| BMSSA | ✗ | ✗ | Missing | Missing | SSA (?) | | +| BMSSD | ✗ | ✗ | ✓ | ✓ | SSD (?) | | +| BMSSH | Missing | Missing | ✓ | ✓ | | | +| BMSSK | Missing | Missing | ✓ | ✓ | | | +| BMSSS | Missing | Missing | ✓ | ✓ | | | +| BMSSTOC | Missing | Missing | ✗ | ✗ | | | +| BMTRE | ✗ | ✗ | ✓ | ✓ | TRE (?) | | +| BMTUN | ✓ | ✓ | Missing | Missing | Tunables | Misspelled as "tuntables", contains exposed variables for tuning| +| BNVIB | Missing | Missing | ✓ | ✓ | | | +| BPSI | ✓ | ✓ | ✓ | ✓ | Packset | Likely a leftover from development| +| 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 | ✗ | ✗ | ✗ | ✗ | Shader Data | | +| BSMAT | Missing | Missing | ✓ | ✓ | | | +| BTUNDA | Missing | Missing | ✓ | ✓ | | | +| BUCT | ✓ | ✓ | ✓ | ✓ | Font File (?) | Not entirely sure what this is| +| INI | Missing | Missing | ✓ | ✓ | | | +| LC | ✓ | ✓ | ✓ | ✓ | Lua Script | | +| PKG | ✓ | ✓ | ✓ | ✓ | Packaged Files | Use something like QuickBMS to extract data from these files| +| TOC | ✓ | ✓ | ✓ | ✓ | Table of Contents | Contains data for which PKG files have what in them| +| TXT | ✓ | ✓ | ✓ | ✓ | Text File | Not quite plain text but close enough| +| WEBM | Missing | Missing | ✗ | ✗ | | | ## Example Usage From cbc0265f99093a43643cc17fc72ea1c90de06224 Mon Sep 17 00:00:00 2001 From: sabre230 <44850786+sabre230@users.noreply.github.com> Date: Wed, 28 Aug 2024 13:46:46 -0700 Subject: [PATCH 2/8] Update README.md Incorporated changes from PR --- README.md | 140 +++++++++++++++++++++++++++--------------------------- 1 file changed, 70 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index 722d48cf..56520643 100644 --- a/README.md +++ b/README.md @@ -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) | Samus Returns (Purpose) | Samus Returns (Notes) | -|-----------|----------------------|-----------------------|--------------|---------------|-------------------------|-----------------------| -| BAPD | Missing | Missing | ✓ | ✓ | | | -| BCCAM | ✗ | ✗ | ✗ | ✗ | Camera Objects | | -| BCLGT | ✗ | ✗ | Missing | Missing | Lighting (?) | | -| BCMDL | ✗ | ✗ | ✓ | ✗ | 3D Models | | -| BCPTL | ✗ | ✗ | ✗ | ✗ | PTL (?) | | -| BCSKLA | ✓ | ✓ | ✓ | ✓ | Skeleton Animation | | -| BCTEX | ✗ | ✗ | ✓ | ✗ | Texture File | Texture files can be dumped, customized, and re-written using popular 3DS emulation software.| -| BCURV | Missing | Missing | ✗ | ✗ | | | -| BCUT | ✗ | ✗ | Missing | Missing | UT (?) | | -| BCWAV | ✗ | ✗ | Missing | Missing | WAV Audio File | | -| BFGRP | Missing | Missing | ✗ | ✗ | | | -| BFONT | ✗ | ✗ | ✗ | ✗ | Font File | | -| BFSAR | Missing | Missing | ✗ | ✗ | | | -| BFSTM | Missing | Missing | ✗ | ✗ | | | -| BGSNDS | Missing | Missing | ✓ | ✓ | | | -| BLDEF | Missing | Missing | ✓ | ✓ | | | -| BLSND | ✓ | ✓ | ✓ | ✓ | Sound | | -| BLUT | Missing | Missing | ✓ | ✓ | | | -| BMBLS | Missing | Missing | ✓ | ✓ | | | -| BMDEFS | ✓ | ✓ | ✓ | ✓ | Definitions | | -| BMMAP | Missing | Missing | ✓ | ✓ | | | -| BMMDEF | Missing | Missing | ✓ | ✓ | | | -| BMSAD | ✓ | ✓ | ✓ | ✓ | Actor Definitions | Defines data used for all instances of an actor (doors, enemies, etc.)| -| BMSAS | Missing | Missing | ✓ | ✓ | | | -| BMSAT | ✗ | ✗ | ✓ | ✓ | AT (?) | | -| BMSBK | ✓ | ✓ | Missing | Missing | Blocks (?) | | -| BMSCC | ✓ | ✓ | ✓ | ✓ | Collision Cameras | | -| BMSCD | ✓ | ✓ | ✓ | ✓ | Collision Data |Geometry | -| BMSCP | Missing | Missing | ✓ | ✓ | | | -| BMSCU | ✗ | ✗ | ✓ | ✓ | CU (?) | | -| BMSEM | ✓ | ✓ | Missing | Missing | Environment Data | | -| BMSES | ✓ | ✓ | Missing | Missing | Environment Data | | -| BMSEV | ✗ | ✗ | Missing | Missing | EV (?) | | -| BMSLD | ✓ | ✓ | Missing | Missing | Level Data | Essentially a game scene| -| BMSLGROUP | Missing | Missing | ✓ | ✓ | | | -| BMSLINK | Missing | Missing | ✓ | ✓ | | | -| BMSMD | ✓ | ✓ | Missing | Missing | Menu Data (?) | | -| BMSMSD | ✓ | ✓ | Missing | Missing | Map Screen Data (?) | | -| BMSNAV | ✓ | ✓ | ✓ | ✓ | Navigation Meshes | | -| BMSND | ✗ | ✗ | Missing | Missing | Sound (?) | Not sure if related to BLSND| -| BMSSA | ✗ | ✗ | Missing | Missing | SSA (?) | | -| BMSSD | ✗ | ✗ | ✓ | ✓ | SSD (?) | | -| BMSSH | Missing | Missing | ✓ | ✓ | | | -| BMSSK | Missing | Missing | ✓ | ✓ | | | -| BMSSS | Missing | Missing | ✓ | ✓ | | | -| BMSSTOC | Missing | Missing | ✗ | ✗ | | | -| BMTRE | ✗ | ✗ | ✓ | ✓ | TRE (?) | | -| BMTUN | ✓ | ✓ | Missing | Missing | Tunables | Misspelled as "tuntables", contains exposed variables for tuning| -| BNVIB | Missing | Missing | ✓ | ✓ | | | -| BPSI | ✓ | ✓ | ✓ | ✓ | Packset | Likely a leftover from development| -| 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 | ✗ | ✗ | ✗ | ✗ | Shader Data | | -| BSMAT | Missing | Missing | ✓ | ✓ | | | -| BTUNDA | Missing | Missing | ✓ | ✓ | | | -| BUCT | ✓ | ✓ | ✓ | ✓ | Font File (?) | Not entirely sure what this is| -| INI | Missing | Missing | ✓ | ✓ | | | -| LC | ✓ | ✓ | ✓ | ✓ | Lua Script | | -| PKG | ✓ | ✓ | ✓ | ✓ | Packaged Files | Use something like QuickBMS to extract data from these files| -| TOC | ✓ | ✓ | ✓ | ✓ | Table of Contents | Contains data for which PKG files have what in them| -| TXT | ✓ | ✓ | ✓ | ✓ | Text File | Not quite plain text but close enough| -| WEBM | Missing | Missing | ✗ | ✗ | | | +| Format | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) | Purpose | +|-----------|----------------------|-----------------------|--------------|---------------|-------------| +| BAPD | Missing | Missing | ✓ | ✓ | | +| BCCAM | ✗ | ✗ | ✗ | ✗ | Camera Objects | +| BCLGT | ✗ | ✗ | Missing | Missing | Lighting (?) | +| BCMDL | ✗ | ✗ | ✓ | ✗ | 3D Models | +| BCPTL | ✗ | ✗ | ✗ | ✗ | PTL (?) | +| BCSKLA | ✓ | ✓ | ✓ | ✓ | Skeleton Animation | +| BCTEX | ✗ | ✗ | ✓ | ✗ | Texture File | +| BCURV | Missing | Missing | ✗ | ✗ | | +| BCUT | ✗ | ✗ | Missing | Missing | UT (?) | +| BCWAV | ✗ | ✗ | Missing | Missing | Audio File | +| BFGRP | Missing | Missing | ✗ | ✗ | | +| BFONT | ✗ | ✗ | ✗ | ✗ | Font File | +| BFSAR | Missing | Missing | ✗ | ✗ | | +| BFSTM | Missing | Missing | ✗ | ✗ | | +| BGSNDS | Missing | Missing | ✓ | ✓ | | +| BLDEF | Missing | Missing | ✓ | ✓ | | +| BLSND | ✓ | ✓ | ✓ | ✓ | Sound | +| BLUT | Missing | Missing | ✓ | ✓ | | +| BMBLS | Missing | Missing | ✓ | ✓ | | +| BMDEFS | ✓ | ✓ | ✓ | ✓ | Music Track Definitions & Properties | +| BMMAP | Missing | Missing | ✓ | ✓ | | +| BMMDEF | Missing | Missing | ✓ | ✓ | | +| BMSAD | ✓ | ✓ | ✓ | ✓ | Actor Definitions | +| BMSAS | Missing | Missing | ✓ | ✓ | | +| BMSAT | ✗ | ✗ | ✓ | ✓ | AT (?) | +| BMSBK | ✓ | ✓ | Missing | Missing | Blocks (?) | +| BMSCC | ✓ | ✓ | ✓ | ✓ | Collision Cameras | +| BMSCD | ✓ | ✓ | ✓ | ✓ | Collision Data, Geometry | +| BMSCP | Missing | Missing | ✓ | ✓ | | +| BMSCU | ✗ | ✗ | ✓ | ✓ | CU (?) | +| BMSEM | ✓ | ✓ | Missing | Missing | Environment Data | +| BMSES | ✓ | ✓ | Missing | Missing | Environment Data | +| BMSEV | ✗ | ✗ | Missing | Missing | EV (?) | +| BMSLD | ✓ | ✓ | Missing | Missing | Level Data | +| BMSLGROUP | Missing | Missing | ✓ | ✓ | | +| BMSLINK | Missing | Missing | ✓ | ✓ | | +| BMSMD | ✓ | ✓ | Missing | Missing | Menu Data (?) | +| BMSMSD | ✓ | ✓ | Missing | Missing | Map Screen Data (?) | +| BMSNAV | ✓ | ✓ | ✓ | ✓ | Navigation Meshes | +| BMSND | ✗ | ✗ | Missing | Missing | Sound (?) | +| BMSSA | ✗ | ✗ | Missing | Missing | SSA (?) | +| BMSSD | ✗ | ✗ | ✓ | ✓ | SSD (?) | +| BMSSH | Missing | Missing | ✓ | ✓ | | +| BMSSK | Missing | Missing | ✓ | ✓ | | +| BMSSS | Missing | Missing | ✓ | ✓ | | +| BMSSTOC | Missing | Missing | ✗ | ✗ | | +| BMTRE | ✗ | ✗ | ✓ | ✓ | TRE (?) | +| BMTUN | ✓ | ✓ | Missing | Missing | Tunables; exposed variables | +| BNVIB | Missing | Missing | ✓ | ✓ | | +| BPSI | ✓ | ✓ | ✓ | ✓ | Packset; dev leftovers | +| 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 | ✗ | ✗ | ✗ | ✗ | Shader Data | +| BSMAT | Missing | Missing | ✓ | ✓ | | +| BTUNDA | Missing | Missing | ✓ | ✓ | | +| BUCT | ✓ | ✓ | ✓ | ✓ | Font File (?) | +| INI | Missing | Missing | ✓ | ✓ | | +| LC | ✓ | ✓ | ✓ | ✓ | Lua Script | +| PKG | ✓ | ✓ | ✓ | ✓ | Packaged Files | +| TOC | ✓ | ✓ | ✓ | ✓ | Table of Contents | +| TXT | ✓ | ✓ | ✓ | ✓ | Text File | +| WEBM | Missing | Missing | ✗ | ✗ | | ## Example Usage From 6d0a50b8756b5286f91eba5b5f4e95aa06706984 Mon Sep 17 00:00:00 2001 From: sabre230 <44850786+sabre230@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:09:55 -0700 Subject: [PATCH 3/8] Update README.md Updated with changes requested from reviews --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 56520643..fff79b2e 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ Construct type definitions for Mercury Engine | BCSKLA | ✓ | ✓ | ✓ | ✓ | Skeleton Animation | | BCTEX | ✗ | ✗ | ✓ | ✗ | Texture File | | BCURV | Missing | Missing | ✗ | ✗ | | -| BCUT | ✗ | ✗ | Missing | Missing | UT (?) | +| BCUT | ✗ | ✗ | Missing | Missing | Related to cutscene files | | BCWAV | ✗ | ✗ | Missing | Missing | Audio File | | BFGRP | Missing | Missing | ✗ | ✗ | | | BFONT | ✗ | ✗ | ✗ | ✗ | Font File | @@ -28,11 +28,11 @@ Construct type definitions for Mercury Engine | BMSAD | ✓ | ✓ | ✓ | ✓ | Actor Definitions | | BMSAS | Missing | Missing | ✓ | ✓ | | | BMSAT | ✗ | ✗ | ✓ | ✓ | AT (?) | -| BMSBK | ✓ | ✓ | Missing | Missing | Blocks (?) | +| BMSBK | ✓ | ✓ | Missing | Missing | Blocks, per Scenario | | BMSCC | ✓ | ✓ | ✓ | ✓ | Collision Cameras | | BMSCD | ✓ | ✓ | ✓ | ✓ | Collision Data, Geometry | | BMSCP | Missing | Missing | ✓ | ✓ | | -| BMSCU | ✗ | ✗ | ✓ | ✓ | CU (?) | +| BMSCU | ✗ | ✗ | ✓ | ✓ | Cutscene Files, called with Game.LaunchCutscene | | BMSEM | ✓ | ✓ | Missing | Missing | Environment Data | | BMSES | ✓ | ✓ | Missing | Missing | Environment Data | | BMSEV | ✗ | ✗ | Missing | Missing | EV (?) | From 7936e1b8797f571bb5b36f227c187aac99cee130 Mon Sep 17 00:00:00 2001 From: sabre230 <44850786+sabre230@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:21:35 -0700 Subject: [PATCH 4/8] Update README.md "Collision Data, Geometry" to "Collision Data/Geometry" Co-authored-by: Miepee <38186597+Miepee@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fff79b2e..25323da1 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ Construct type definitions for Mercury Engine | BMSAT | ✗ | ✗ | ✓ | ✓ | AT (?) | | BMSBK | ✓ | ✓ | Missing | Missing | Blocks, per Scenario | | BMSCC | ✓ | ✓ | ✓ | ✓ | Collision Cameras | -| BMSCD | ✓ | ✓ | ✓ | ✓ | Collision Data, Geometry | +| BMSCD | ✓ | ✓ | ✓ | ✓ | Collision Data / Geometry | | BMSCP | Missing | Missing | ✓ | ✓ | | | BMSCU | ✗ | ✗ | ✓ | ✓ | Cutscene Files, called with Game.LaunchCutscene | | BMSEM | ✓ | ✓ | Missing | Missing | Environment Data | From e70afa47414062d832d1fd1ff4af82d9c6578542 Mon Sep 17 00:00:00 2001 From: sabre230 <44850786+sabre230@users.noreply.github.com> Date: Wed, 28 Aug 2024 14:24:25 -0700 Subject: [PATCH 5/8] Update README.md Updated with suggestions from reviews --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 25323da1..11195d03 100644 --- a/README.md +++ b/README.md @@ -12,11 +12,11 @@ Construct type definitions for Mercury Engine | BCTEX | ✗ | ✗ | ✓ | ✗ | Texture File | | BCURV | Missing | Missing | ✗ | ✗ | | | BCUT | ✗ | ✗ | Missing | Missing | Related to cutscene files | -| BCWAV | ✗ | ✗ | Missing | Missing | Audio File | +| BCWAV | ✗ | ✗ | Missing | Missing | Common 3DS audio format | | BFGRP | Missing | Missing | ✗ | ✗ | | | BFONT | ✗ | ✗ | ✗ | ✗ | Font File | | BFSAR | Missing | Missing | ✗ | ✗ | | -| BFSTM | Missing | Missing | ✗ | ✗ | | +| BFSTM | Missing | Missing | ✗ | ✗ | Common Switch audio format | | BGSNDS | Missing | Missing | ✓ | ✓ | | | BLDEF | Missing | Missing | ✓ | ✓ | | | BLSND | ✓ | ✓ | ✓ | ✓ | Sound | @@ -32,7 +32,7 @@ Construct type definitions for Mercury Engine | BMSCC | ✓ | ✓ | ✓ | ✓ | Collision Cameras | | BMSCD | ✓ | ✓ | ✓ | ✓ | Collision Data / Geometry | | BMSCP | Missing | Missing | ✓ | ✓ | | -| BMSCU | ✗ | ✗ | ✓ | ✓ | Cutscene Files, called with Game.LaunchCutscene | +| BMSCU | ✗ | ✗ | ✓ | ✓ | Cutscene Files | | BMSEM | ✓ | ✓ | Missing | Missing | Environment Data | | BMSES | ✓ | ✓ | Missing | Missing | Environment Data | | BMSEV | ✗ | ✗ | Missing | Missing | EV (?) | @@ -66,7 +66,7 @@ Construct type definitions for Mercury Engine | BTUNDA | Missing | Missing | ✓ | ✓ | | | BUCT | ✓ | ✓ | ✓ | ✓ | Font File (?) | | INI | Missing | Missing | ✓ | ✓ | | -| LC | ✓ | ✓ | ✓ | ✓ | Lua Script | +| LC | ✓ | ✓ | ✓ | ✓ | Lua Bytecode| | PKG | ✓ | ✓ | ✓ | ✓ | Packaged Files | | TOC | ✓ | ✓ | ✓ | ✓ | Table of Contents | | TXT | ✓ | ✓ | ✓ | ✓ | Text File | From ba8768b6d0adb485a3205a288513b5547e47c76f Mon Sep 17 00:00:00 2001 From: sabre230 <44850786+sabre230@users.noreply.github.com> Date: Wed, 28 Aug 2024 18:20:41 -0700 Subject: [PATCH 6/8] Update README.md Added in all the information provided by steven11sjf (tyvm!) --- README.md | 92 +++++++++++++++++++++++++++---------------------------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index 11195d03..f85b3e12 100644 --- a/README.md +++ b/README.md @@ -3,80 +3,80 @@ Construct type definitions for Mercury Engine | Format | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) | Purpose | |-----------|----------------------|-----------------------|--------------|---------------|-------------| -| BAPD | Missing | Missing | ✓ | ✓ | | -| BCCAM | ✗ | ✗ | ✗ | ✗ | Camera Objects | +| BAPD | Missing | Missing | ✓ | ✓ | Audio Preset (positional audio data) | +| BCCAM | ✗ | ✗ | ✗ | ✗ | Camera Objects (used exclusively for a shot) | | BCLGT | ✗ | ✗ | Missing | Missing | Lighting (?) | | BCMDL | ✗ | ✗ | ✓ | ✗ | 3D Models | -| BCPTL | ✗ | ✗ | ✗ | ✗ | PTL (?) | +| BCPTL | ✗ | ✗ | ✗ | ✗ | Particle Effect | | BCSKLA | ✓ | ✓ | ✓ | ✓ | Skeleton Animation | | BCTEX | ✗ | ✗ | ✓ | ✗ | Texture File | -| BCURV | Missing | Missing | ✗ | ✗ | | +| BCURV | Missing | Missing | ✗ | ✗ | CURV (?) | | BCUT | ✗ | ✗ | Missing | Missing | Related to cutscene files | -| BCWAV | ✗ | ✗ | Missing | Missing | Common 3DS audio format | -| BFGRP | Missing | Missing | ✗ | ✗ | | -| BFONT | ✗ | ✗ | ✗ | ✗ | Font File | -| BFSAR | Missing | Missing | ✗ | ✗ | | +| 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 | ✓ | ✓ | | +| BGSNDS | Missing | Missing | ✓ | ✓ | BackGround Sounds (?) | | BLDEF | Missing | Missing | ✓ | ✓ | | -| BLSND | ✓ | ✓ | ✓ | ✓ | Sound | -| BLUT | Missing | Missing | ✓ | ✓ | | +| BLSND | ✓ | ✓ | ✓ | ✓ | Sounds (?) | +| BLUT | Missing | Missing | ✓ | ✓ | LookUp Table (used for ADAM animation) | | BMBLS | Missing | Missing | ✓ | ✓ | | | BMDEFS | ✓ | ✓ | ✓ | ✓ | Music Track Definitions & Properties | -| BMMAP | Missing | Missing | ✓ | ✓ | | -| BMMDEF | Missing | Missing | ✓ | ✓ | | +| BMMAP | Missing | Missing | ✓ | ✓ | MiniMap | +| BMMDEF | Missing | Missing | ✓ | ✓ | MiniMap Definitions (?) | | BMSAD | ✓ | ✓ | ✓ | ✓ | Actor Definitions | -| BMSAS | Missing | Missing | ✓ | ✓ | | -| BMSAT | ✗ | ✗ | ✓ | ✓ | AT (?) | +| BMSAS | Missing | Missing | ✓ | ✓ | Action Sets | +| BMSAT | ✗ | ✗ | ✓ | ✓ | Animation Tree | | BMSBK | ✓ | ✓ | Missing | Missing | Blocks, per Scenario | | BMSCC | ✓ | ✓ | ✓ | ✓ | Collision Cameras | | BMSCD | ✓ | ✓ | ✓ | ✓ | Collision Data / Geometry | -| BMSCP | Missing | Missing | ✓ | ✓ | | +| BMSCP | Missing | Missing | ✓ | ✓ | GUI Composition | | BMSCU | ✗ | ✗ | ✓ | ✓ | Cutscene Files | -| BMSEM | ✓ | ✓ | Missing | Missing | Environment Data | -| BMSES | ✓ | ✓ | Missing | Missing | Environment Data | -| BMSEV | ✗ | ✗ | Missing | Missing | EV (?) | -| BMSLD | ✓ | ✓ | Missing | Missing | Level Data | -| BMSLGROUP | Missing | Missing | ✓ | ✓ | | -| BMSLINK | Missing | Missing | ✓ | ✓ | | +| 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 | ✗ | ✗ | ✓ | ✓ | SSD (?) | -| BMSSH | Missing | Missing | ✓ | ✓ | | -| BMSSK | Missing | Missing | ✓ | ✓ | | -| BMSSS | Missing | Missing | ✓ | ✓ | | -| BMSSTOC | Missing | Missing | ✗ | ✗ | | -| BMTRE | ✗ | ✗ | ✓ | ✓ | TRE (?) | +| 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 | ✓ | ✓ | | -| BPSI | ✓ | ✓ | ✓ | ✓ | Packset; dev leftovers | -| BPTDAT | Missing | Missing | ✓ | ✓ | | -| BPTDEF | Missing | Missing | ✓ | ✓ | | -| BREM | Missing | Missing | ✓ | ✓ | | -| BRES | Missing | Missing | ✓ | ✓ | | -| BREV | Missing | Missing | ✓ | ✓ | | -| BRFLD | Missing | Missing | ✓ | ✓ | | -| BRSA | Missing | Missing | ✓ | ✓ | | -| BRSPD | Missing | Missing | ✓ | ✓ | | +| 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 | ✓ | ✓ | | -| BTUNDA | Missing | Missing | ✓ | ✓ | | -| BUCT | ✓ | ✓ | ✓ | ✓ | Font File (?) | -| INI | Missing | Missing | ✓ | ✓ | | -| LC | ✓ | ✓ | ✓ | ✓ | Lua Bytecode| +| 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 | ✓ | ✓ | ✓ | ✓ | Text File | -| WEBM | Missing | Missing | ✗ | ✗ | | +| TXT | ✓ | ✓ | ✓ | ✓ | UTF-16 Text File | +| WEBM | Missing | Missing | ✗ | ✗ | Standard WEBM | ## Example Usage ```python -# TODO +# TODOBMTRE ``` ## Colors for Text From 2f91356ff1c6dd118c8859b29d780963a112e23a Mon Sep 17 00:00:00 2001 From: sabre230 <44850786+sabre230@users.noreply.github.com> Date: Wed, 28 Aug 2024 19:19:34 -0700 Subject: [PATCH 7/8] Update README.md https://github.com/randovania/mercury-engine-data-structures/pull/215#discussion_r1735453335 https://github.com/randovania/mercury-engine-data-structures/pull/215#discussion_r1735449166 --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f85b3e12..7abaf9e4 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Construct type definitions for Mercury Engine | Format | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) | Purpose | |-----------|----------------------|-----------------------|--------------|---------------|-------------| | BAPD | Missing | Missing | ✓ | ✓ | Audio Preset (positional audio data) | -| BCCAM | ✗ | ✗ | ✗ | ✗ | Camera Objects (used exclusively for a shot) | +| BCCAM | ✗ | ✗ | ✗ | ✗ | Cutscene Camera (used exclusively for cutscene takes) | | BCLGT | ✗ | ✗ | Missing | Missing | Lighting (?) | | BCMDL | ✗ | ✗ | ✓ | ✗ | 3D Models | | BCPTL | ✗ | ✗ | ✗ | ✗ | Particle Effect | @@ -69,7 +69,7 @@ Construct type definitions for Mercury Engine | LC | ✓ | ✓ | ✓ | ✓ | Lua Bytecode | | PKG | ✓ | ✓ | ✓ | ✓ | Packaged Files | | TOC | ✓ | ✓ | ✓ | ✓ | Table of Contents | -| TXT | ✓ | ✓ | ✓ | ✓ | UTF-16 Text File | +| TXT | ✓ | ✓ | ✓ | ✓ | UTF-16 Text File (?) | | WEBM | Missing | Missing | ✗ | ✗ | Standard WEBM | From 7cf01f0096acdb61b146d02cc41c30d9c8fc4656 Mon Sep 17 00:00:00 2001 From: sabre230 <44850786+sabre230@users.noreply.github.com> Date: Wed, 28 Aug 2024 22:06:20 -0700 Subject: [PATCH 8/8] Update README.md fixed typo, added suggested revisions --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7abaf9e4..033632e8 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Construct type definitions for Mercury Engine | Format | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) | Purpose | |-----------|----------------------|-----------------------|--------------|---------------|-------------| | BAPD | Missing | Missing | ✓ | ✓ | Audio Preset (positional audio data) | -| BCCAM | ✗ | ✗ | ✗ | ✗ | Cutscene Camera (used exclusively for cutscene takes) | +| BCCAM | ✗ | ✗ | ✗ | ✗ | Camera Animation (used exclusively for cutscene takes) | | BCLGT | ✗ | ✗ | Missing | Missing | Lighting (?) | | BCMDL | ✗ | ✗ | ✓ | ✗ | 3D Models | | BCPTL | ✗ | ✗ | ✗ | ✗ | Particle Effect | @@ -18,10 +18,10 @@ Construct type definitions for Mercury Engine | BFSAR | Missing | Missing | ✗ | ✗ | FSAR (?) | | BFSTM | Missing | Missing | ✗ | ✗ | Common Switch audio format | | BGSNDS | Missing | Missing | ✓ | ✓ | BackGround Sounds (?) | -| BLDEF | Missing | Missing | ✓ | ✓ | | +| BLDEF | Missing | Missing | ✓ | ✓ | Actor Lighting Definition | | BLSND | ✓ | ✓ | ✓ | ✓ | Sounds (?) | | BLUT | Missing | Missing | ✓ | ✓ | LookUp Table (used for ADAM animation) | -| BMBLS | Missing | Missing | ✓ | ✓ | | +| BMBLS | Missing | Missing | ✓ | ✓ | Blend Space | | BMDEFS | ✓ | ✓ | ✓ | ✓ | Music Track Definitions & Properties | | BMMAP | Missing | Missing | ✓ | ✓ | MiniMap | | BMMDEF | Missing | Missing | ✓ | ✓ | MiniMap Definitions (?) | @@ -76,7 +76,7 @@ Construct type definitions for Mercury Engine ## Example Usage ```python -# TODOBMTRE +# TODO ``` ## Colors for Text