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 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 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)
Getting started
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, Python 3.6/3.7/3.8 (64-bit)
Recent Linux distributions, Python 3.8 (64-bit)
macOS 10.14 / 10.15, Python 3.8 (64-bit)
If you are using any other platform, you must build oead from source (refer to the next section).
For more information, refer to the documentation.
Building from source
Building oead from source requires:
CMake 3.12+
A compiler that supports C++17
Everything needed to build libyaml
First, clone the repository then enter the oead directory and run git submodule update --init --recursive.
Building the Python module
To install the module, run pip install -e .. This requires the following Python modules to be installed: setuptools, wheel
If you just want to build the Python module from source without installing it, run python setup.py bdist_wheel.
C++ usage
Linking to the oead target is sufficient to use the library.
Contributing
Issue tracker: https://github.com/zeldamods/oead/issues
Source code: https://github.com/zeldamods/oead
This project is licensed under the GPLv2+ license.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distributions
Hashes for oead-1.2.3-cp310-cp310-win_amd64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | da3563c177fe6a5eb96e85f58ee86761b9d3391de589cd99766e49a1d58f2a35 |
|
| MD5 | 520236badd0ddb5c623b896b0e38f977 |
|
| BLAKE2b-256 | 3aada0ba5a96278ea357ae2b8e76ab057f0d7b1ebd3af43755fbfc9fe8231822 |
Hashes for oead-1.2.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 19a104f09045a93545465c2377a49f0d6e3bd987c1dcd7ee39400e90f5a86990 |
|
| MD5 | 79926d266f906083a6b9e1b2d25148b9 |
|
| BLAKE2b-256 | 2735f4e105c5e1ec12ec3500b8359643d49c86e9898644fed686c403b76e4f62 |
Hashes for oead-1.2.3-cp310-cp310-macosx_10_14_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 87d119055b28bcf3eb31e61de6ad75ea1c03e6bda2ff2473b3549a1e4d45be7b |
|
| MD5 | 4f005e6c425b325333dc62c8db03ff94 |
|
| BLAKE2b-256 | c2b8cfd9082be9f592dd20e745de844e9960a69a4dcc2c785a818110089f49b4 |
Hashes for oead-1.2.3-cp39-cp39-win_amd64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c601d604c21788f382c8e6219ebae87f40922ff491b73f5631502adb9441fd49 |
|
| MD5 | 3aa21a53aa0ca9d648137cc370fcc19f |
|
| BLAKE2b-256 | 6c1cbd45e51c4529e7703af618136078eff2d40fd080d2650e345aff7e9ac5e2 |
Hashes for oead-1.2.3-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2c79536c0544ff38c270dcccdf305dfa280d17e2a0322d510b8d6c30e04344b4 |
|
| MD5 | b96e03f10d377a455ba5c1820efe51cc |
|
| BLAKE2b-256 | 9d1fc4c58e0425b179326165df39a1e7b8d4ce60820cf2acfe121922af734cfb |
Hashes for oead-1.2.3-cp39-cp39-macosx_10_14_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 92a626d18028851e5563fec1f30ffbd7a99af18d698a270df8620ffdf0809c93 |
|
| MD5 | 29478a03418abd91e022240526660eca |
|
| BLAKE2b-256 | 829b8dca57c333002d0021769ab620668e6fbfdc62f8dbb3b4f1365958f1a4de |
Hashes for oead-1.2.3-cp38-cp38-win_amd64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ce2c5e39717c5b2368a5e57ef0fbf7ecc02b5044b805c6e1554e8fd1fcb34d2e |
|
| MD5 | 215957f8bdfb757146acbfaae219697c |
|
| BLAKE2b-256 | 924035c98c33df7a3755e13aa25d26d29d7a319c13485de4ee60da4d49ced079 |
Hashes for oead-1.2.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a0a67a52f7dbba26d5b026995cd587b0ffb2566c558cb7b84eb1e77324d5ebe0 |
|
| MD5 | d4902355bd5cca9a5200d46c87be17cd |
|
| BLAKE2b-256 | 2eec4c1e26c325b94d4865cda2408f1f7ae3f6f7a2207efebcbc68b5b7db3829 |
Hashes for oead-1.2.3-cp38-cp38-macosx_10_14_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 94fb63bc7ece387f545be4799e92cfef35bf0f15dfaf58468d003fd900fe8391 |
|
| MD5 | 371d730204df5469f8620f4320418a79 |
|
| BLAKE2b-256 | 9ef37a35acb9866e47a9c4e7ef4737e0367706eebba2f1a43bdea1a6ea4b8fc2 |
Hashes for oead-1.2.3-cp37-cp37m-win_amd64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a4d877f0bf39f7b3e78b297d4b2b3916ee70999f3e64f70161e00be5aacdfd97 |
|
| MD5 | 71b953ac645580748a5308e46d2542ee |
|
| BLAKE2b-256 | 79fb623f12a37429840c30526e88478769b175ef9dbc9616eeb2af376ee66aba |
Hashes for oead-1.2.3-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7eb41534e0d00d17f05799b522e5aaa37ee6e10a6428d265d74df2d88c4ceec1 |
|
| MD5 | 7a200158312a2eb21c81483bfc5a2d91 |
|
| BLAKE2b-256 | 9df170298602bd0901edfeb5d0c0d29eec887cbdc5ed0c834d1e9319d88aea50 |
Hashes for oead-1.2.3-cp36-cp36m-win_amd64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9ccc68f9c10eba6409349d4123c2a214d42749581969182c099cda1bd12cd677 |
|
| MD5 | f279b5d972143635952a7fefabb557ef |
|
| BLAKE2b-256 | 6730bae577530ba8d9776d2d2100e98f563aa8707da9039abd03b1b4794105c7 |
Hashes for oead-1.2.3-cp36-cp36m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3b7a429f8395794fe068b85fd9528562121fa0e5bf71f70b371f5ad01fe7a39c |
|
| MD5 | 8fbb12661ef4134e0da1f290d1a6ff5f |
|
| BLAKE2b-256 | 2aa3bef401d66ce7154d80f1425fc7d2e2c700b284ceb6c25ea7491919bdd9ee |
