oead is a C++ library for common file formats that are used in modern first-party Nintendo EAD (now EPD) titles.
Python bindings for 3.10+ are also available.
Currently, oead only handles very common formats that are extensively used in recent games such as Breath of the Wild and Super Mario Odyssey.
- AAMP (binary parameter archive): Only version 2 is supported.
- BYML (binary YAML): Versions 1, 2, 3, and 4 are supported.
- SARC (archive)
- Yaz0 (compression algorithm)
oead also supports a recent Grezzo format that is used in Link's Awakening (Switch):
- gsheet (Grezzo datasheet)
To install the Python module, simply run:
pip install oead
This will download and install a precompiled version of oead for the following platforms:
- Windows (x86-64 / 64-bit)
- Recent Linux distributions (x86-64, glibc and musl)
- macOS 10.14+ (x86-64 / arm64)
The following versions of Python are supported:
- CPython 3.10 to 3.14
If you are using any other platform, you must build oead from source (refer to the next section).
Warning
Windows users must ensure that they have the latest Visual C++ 2019 Redistributable installed.
For more information, refer to the documentation.
Building oead from source requires:
- CMake 3.15+
- A compiler that supports C++20
- Everything needed to build libyaml
First, clone the repository then enter the oead directory and run git submodule update --init --recursive.
- To install the module, run
pip install . - If you just want to build the Python module from source without installing it, run
pip wheel --no-deps . - For a debug build, pass
-Ccmake.build-type=Debugto pip. - After changing the bindings, regenerate the type stubs with
python tools/generate_stubs.py(requires thestubsdependency group:pip install --group stubs).
Linking to the oead target is sufficient to use the library.
- Issue tracker: https://github.com/zeldamods/oead/issues
- Source code: https://github.com/zeldamods/oead
This project is licensed under the GPLv2+ license.