Skip to main content

Library for recent Nintendo EAD formats in first-party games

Project description

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.6+ are also available.

Features

Currently, oead only handles two very common formats that are extensively used in recent games such as Breath of the Wild and Super Mario Odyssey.

  • BYML (binary YAML): Versions 2, 3, and 4 are supported.

  • AAMP (binary parameter archive): Only version 2 is supported.

  • Yaz0 (compression algorithm)

Getting started

Install with:

pip install oead

For more information, refer to the documentation.

Building from source

Building oead from source requires:

  • CMake 3.10+

  • A compiler that supports C++17

  • Everything needed to build libyaml

Linking to the oead target is sufficient to use the library.

To build the Python bindings from source, run python setup.py bdist_wheel. This requires setuptools to be installed.

Contributing

This project is licensed under the GPLv2+ license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distributions

oead-0.10.0-cp38-cp38-win_amd64.whl (753.8 kB view hashes)

Uploaded CPython 3.8 Windows x86-64

oead-0.10.0-cp38-cp38-manylinux2014_x86_64.whl (987.0 kB view hashes)

Uploaded CPython 3.8

oead-0.10.0-cp37-cp37m-win_amd64.whl (747.7 kB view hashes)

Uploaded CPython 3.7m Windows x86-64

oead-0.10.0-cp37-cp37m-manylinux2014_x86_64.whl (988.7 kB view hashes)

Uploaded CPython 3.7m

oead-0.10.0-cp36-cp36m-win_amd64.whl (747.5 kB view hashes)

Uploaded CPython 3.6m Windows x86-64

oead-0.10.0-cp36-cp36m-manylinux2014_x86_64.whl (988.9 kB view hashes)

Uploaded CPython 3.6m

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page