Metadata-Version: 2.1
Name: mercury-engine-data-structures
Version: 0.31.0
Summary: Construct file definitions for the Mercury Engine, the in-house game engine from MercurySteam
Project-URL: Homepage, https://github.com/randovania/mercury-engine-data-structures
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: construct>=2.10.70
Requires-Dist: randovania-lupa>=2.0.1
Requires-Dist: zstd
Provides-Extra: test
Requires-Dist: pytest<8.0.0; extra == "test"
Requires-Dist: pytest-cov; extra == "test"

# Mercury Engine Data Structures
Construct type definitions for Mercury Engine

| Format    | Samus Returns (Read) | Samus Returns (Write) | Dread (Read) | Dread (Write) |
|-----------|----------------------|-----------------------|--------------|---------------|
| BAPD      | Missing              | Missing               | &check;      | &check;       |
| BCCAM     | &cross;              | &cross;               | &cross;      | &cross;       |
| BCLGT     | &cross;              | &cross;               | Missing      | Missing       |
| BCMDL     | &cross;              | &cross;               | &check;      | &cross;       |
| BCPTL     | &cross;              | &cross;               | &cross;      | &cross;       |
| BCSKLA    | &cross;              | &cross;               | &cross;      | &cross;       |
| BCTEX     | &cross;              | &cross;               | &check;      | &cross;       |
| BCURV     | Missing              | Missing               | &cross;      | &cross;       |
| BCUT      | &cross;              | &cross;               | Missing      | Missing       |
| BCWAV     | &cross;              | &cross;               | Missing      | Missing       |
| BFGRP     | Missing              | Missing               | &cross;      | &cross;       |
| BFONT     | &cross;              | &cross;               | &cross;      | &cross;       |
| BFSAR     | Missing              | Missing               | &cross;      | &cross;       |
| BFSTM     | Missing              | Missing               | &cross;      | &cross;       |
| BGSNDS    | Missing              | Missing               | &cross;      | &cross;       |
| BLDEF     | Missing              | Missing               | &check;      | &check;       |
| BLSND     | &check;              | &check;               | &check;      | &check;       |
| BLUT      | Missing              | Missing               | &cross;      | &cross;       |
| BMBLS     | Missing              | Missing               | &check;      | &check;       |
| BMDEFS    | &check;              | &check;               | &check;      | &check;       |
| BMMAP     | Missing              | Missing               | &check;      | &check;       |
| BMMDEF    | Missing              | Missing               | &check;      | &check;       |
| BMSAD     | &check;              | &check;               | &check;      | &check;       |
| BMSAS     | Missing              | Missing               | &check;      | &check;       |
| BMSAT     | &cross;              | &cross;               | &cross;      | &cross;       |
| BMSBK     | &check;              | &check;               | Missing      | Missing       |
| BMSCC     | &check;              | &check;               | &check;      | &check;       |
| BMSCD     | &check;              | &check;               | &check;      | &check;       |
| BMSCP     | Missing              | Missing               | &check;      | &check;       |
| BMSCU     | &cross;              | &cross;               | &check;      | &check;       |
| BMSEM     | &check;              | &check;               | Missing      | Missing       |
| BMSES     | &check;              | &check;               | Missing      | Missing       |
| BMSEV     | &cross;              | &cross;               | Missing      | Missing       |
| BMSLD     | &check;              | &check;               | Missing      | Missing       |
| BMSLGROUP | Missing              | Missing               | &check;      | &check;       |
| BMSLINK   | Missing              | Missing               | &check;      | &check;       |
| BMSMD     | &check;              | &check;               | Missing      | Missing       |
| BMSMSD    | &check;              | &check;               | Missing      | Missing       |
| BMSNAV    | &check;              | &check;               | &check;      | &check;       |
| BMSND     | &cross;              | &cross;               | Missing      | Missing       |
| BMSSA     | &cross;              | &cross;               | Missing      | Missing       |
| BMSSD     | &cross;              | &cross;               | &check;      | &check;       |
| BMSSH     | Missing              | Missing               | &cross;      | &cross;       |
| BMSSK     | Missing              | Missing               | &check;      | &check;       |
| BMSSS     | Missing              | Missing               | &check;      | &check;       |
| BMSSTOC   | Missing              | Missing               | &cross;      | &cross;       |
| BMTRE     | &cross;              | &cross;               | &check;      | &check;       |
| BMTUN     | &check;              | &check;               | Missing      | Missing       |
| BNVIB     | Missing              | Missing               | &cross;      | &cross;       |
| BPSI      | &cross;              | &cross;               | &cross;      | &cross;       |
| BPTDAT    | Missing              | Missing               | &cross;      | &cross;       |
| BPTDEF    | Missing              | Missing               | &cross;      | &cross;       |
| BREM      | Missing              | Missing               | &check;      | &check;       |
| BRES      | Missing              | Missing               | &check;      | &check;       |
| BREV      | Missing              | Missing               | &check;      | &check;       |
| BRFLD     | Missing              | Missing               | &check;      | &check;       |
| BRSA      | Missing              | Missing               | &check;      | &check;       |
| BRSPD     | Missing              | Missing               | &cross;      | &cross;       |
| BSHDAT    | &cross;              | &cross;               | &cross;      | &cross;       |
| BSMAT     | Missing              | Missing               | &check;      | &check;       |
| BTUNDA    | Missing              | Missing               | &check;      | &check;       |
| BUCT      | &cross;              | &cross;               | &cross;      | &cross;       |
| INI       | Missing              | Missing               | &check;      | &check;       |
| LC        | &check;              | &check;               | &check;      | &check;       |
| PKG       | &check;              | &check;               | &check;      | &check;       |
| TOC       | &check;              | &check;               | &check;      | &check;       |
| TXT       | &check;              | &check;               | &check;      | &check;       |
| WEBM      | Missing              | Missing               | &cross;      | &cross;       |


## Example Usage

```python
# TODO
```

## Colors for Text

Metroid Dread uses the following annotations in text to change color:

| Code | Color       |              |
|------|-------------|--------------|
| {c0} | White       | (Default)    |
| {c1} | Yellow      |              |
| {c2} | Red         |              |
| {c3} | Pink        |              |
| {c4} | Green       |              |
| {c5} | Blue        |              |
| {c6} | UI Active   | (Light blue) |
| {c7} | UI Inactive | (Dim blue)   |
