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 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):

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 (x86-64 / 64-bit)

  • Recent Linux distributions (x86-64, glibc and musl)

Precompiled builds for macOS are currently unavailable as the wheel build process seems to be broken. Please help us fix this release failure <https://github.com/zeldamods/oead/actions/runs/9588470856/job/26440567392> if you know how!

The following versions of Python are supported:

  • CPython 3.6 to 3.12

  • PyPy3.7 to 3.9

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

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 Distribution

oead-1.2.9.post4.tar.gz (4.6 MB view details)

Uploaded Source

Built Distributions

oead-1.2.9.post4-pp310-pypy310_pp73-win_amd64.whl (1.3 MB view details)

Uploaded PyPy Windows x86-64

oead-1.2.9.post4-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB view details)

Uploaded PyPy manylinux: glibc 2.17+ x86-64

oead-1.2.9.post4-pp39-pypy39_pp73-win_amd64.whl (1.3 MB view details)

Uploaded PyPy Windows x86-64

oead-1.2.9.post4-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB view details)

Uploaded PyPy manylinux: glibc 2.17+ x86-64

oead-1.2.9.post4-pp38-pypy38_pp73-win_amd64.whl (1.3 MB view details)

Uploaded PyPy Windows x86-64

oead-1.2.9.post4-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB view details)

Uploaded PyPy manylinux: glibc 2.17+ x86-64

oead-1.2.9.post4-pp37-pypy37_pp73-win_amd64.whl (1.3 MB view details)

Uploaded PyPy Windows x86-64

oead-1.2.9.post4-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB view details)

Uploaded PyPy manylinux: glibc 2.17+ x86-64

oead-1.2.9.post4-cp312-cp312-win_amd64.whl (1.3 MB view details)

Uploaded CPython 3.12 Windows x86-64

oead-1.2.9.post4-cp312-cp312-musllinux_1_2_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.12 musllinux: musl 1.2+ x86-64

oead-1.2.9.post4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.12 manylinux: glibc 2.17+ x86-64

oead-1.2.9.post4-cp311-cp311-win_amd64.whl (1.3 MB view details)

Uploaded CPython 3.11 Windows x86-64

oead-1.2.9.post4-cp311-cp311-musllinux_1_2_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.11 musllinux: musl 1.2+ x86-64

oead-1.2.9.post4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.11 manylinux: glibc 2.17+ x86-64

oead-1.2.9.post4-cp310-cp310-win_amd64.whl (1.3 MB view details)

Uploaded CPython 3.10 Windows x86-64

oead-1.2.9.post4-cp310-cp310-musllinux_1_2_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.10 musllinux: musl 1.2+ x86-64

oead-1.2.9.post4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.10 manylinux: glibc 2.17+ x86-64

oead-1.2.9.post4-cp39-cp39-win_amd64.whl (1.3 MB view details)

Uploaded CPython 3.9 Windows x86-64

oead-1.2.9.post4-cp39-cp39-musllinux_1_2_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.9 musllinux: musl 1.2+ x86-64

oead-1.2.9.post4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.9 manylinux: glibc 2.17+ x86-64

oead-1.2.9.post4-cp38-cp38-win_amd64.whl (1.3 MB view details)

Uploaded CPython 3.8 Windows x86-64

oead-1.2.9.post4-cp38-cp38-musllinux_1_2_x86_64.whl (2.6 MB view details)

Uploaded CPython 3.8 musllinux: musl 1.2+ x86-64

oead-1.2.9.post4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.6 MB view details)

Uploaded CPython 3.8 manylinux: glibc 2.17+ x86-64

File details

Details for the file oead-1.2.9.post4.tar.gz.

File metadata

  • Download URL: oead-1.2.9.post4.tar.gz
  • Upload date:
  • Size: 4.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for oead-1.2.9.post4.tar.gz
Algorithm Hash digest
SHA256 5df951989325d1efef5e154cfb9f8986f8458618b1ba1f538eb7bd46c3a7591a
MD5 d2b319f971466054d8a1c8758022d31f
BLAKE2b-256 fe21e36cd33277bd4e3da223ec1e1cf3c3b9bc599dbe321ea26a37866193ad67

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-pp310-pypy310_pp73-win_amd64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-pp310-pypy310_pp73-win_amd64.whl
Algorithm Hash digest
SHA256 38a2dfb7c55d69e877aa590b405ca00ae2dd244409f3667a860783ce12f8dc5a
MD5 4b4c504848968947e39fec378d215565
BLAKE2b-256 42fa22a50b13abbd0a808d1182821ee04fda73b2dae67113abc539b04825e11b

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b68aa25662a4d0b2d8da38ecd6f6026d91d66de700693f544c5d7c4d9d00e072
MD5 1228e05fae121d144c48c4cbc13b0118
BLAKE2b-256 4ed429035c63fd70cb54b6b045445e7b81b8ede3b2b29e6232b7bd765c3829ff

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-pp39-pypy39_pp73-win_amd64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-pp39-pypy39_pp73-win_amd64.whl
Algorithm Hash digest
SHA256 594dd571583297d52ffa89b8762a7249e3dae5ade0f02c5a7148644bebd61943
MD5 d2d5818896d80841a8a734a2ba1e2447
BLAKE2b-256 97bde731b3f576edc0c23b2d8c6d78b82ee654987ada309ade6657bf4c03a2b0

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 a556e287c3285ef44bbf08c4bf3dad99d0c8211db5cb37851613326aaff8b98e
MD5 1c6e9143d60b53bbaed9969b00386484
BLAKE2b-256 49391303def211ddd76d2766c3cead3fd794f097a4296f3866f22376b741d297

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-pp38-pypy38_pp73-win_amd64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-pp38-pypy38_pp73-win_amd64.whl
Algorithm Hash digest
SHA256 b21517f8ca6986d6e7b849fe9b81f872a3b768b1dbad054994ccd8ba60f03945
MD5 8f5e2e4bc0116286f83470935a39f35e
BLAKE2b-256 c8b8b8c3c8fb46e8472cee75fe21019b9a9d3982882c588f6082857f5310d17b

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-pp38-pypy38_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 7858bf21786518aab8192b62efa78b5669863f67261744a08966231a79391c0b
MD5 b2b377252ddfae4d88b3234848fc49bc
BLAKE2b-256 dd4d1ffa131b15593f9e348f452a889a839271874e0888a223f81f6518bb6b92

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-pp37-pypy37_pp73-win_amd64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-pp37-pypy37_pp73-win_amd64.whl
Algorithm Hash digest
SHA256 84d8a4e9885af9e57fd4c466816a7f21233a65cf1bf4fd9ef251eff0b7633085
MD5 f580d473fbd63c5d81d62f5a1024ea97
BLAKE2b-256 43fe7141930507308e7b9121159d42a6b8d2b20f928e915d79ec9c05086291a4

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-pp37-pypy37_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 2705aff4fae65e2fef0c6d8122eddad9ee60afece7d3dff08e1be82c09381d54
MD5 cf8ae1acb2d1998f453d7a568d1e3c9e
BLAKE2b-256 5b4f3a65bb381db5c6597938edf369ed92a5ada5556455e05fcc6f002a33c42c

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp312-cp312-win_amd64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp312-cp312-win_amd64.whl
Algorithm Hash digest
SHA256 e018a9904af9239357b5665514447407f76608d039fbbeaa4b3445e8f4857dce
MD5 713627b5d2214caa8b988b0b4c8da328
BLAKE2b-256 bc1b8f541f12da3da8c27c75f37978d1d7da0dbe70db71338233a0e182d792f5

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp312-cp312-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp312-cp312-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 e2e04c72f072f1659f8e7a2c92c56fffa025ffb1b2a0a76c34334b653e72776d
MD5 9a3de65b0ea80c93f0241d89dc71dc6e
BLAKE2b-256 91c83e2ae246e0158351d892894d88589d2a3be0d088c5b585f1ac665de9f1a2

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c04710997082000bdc5cc506e43e777f44adbde9e877fa2c446c596abb52735d
MD5 20d652191c23d075e68e82b5d171e26a
BLAKE2b-256 27a464a1d0e8290a1ccac302135c3a2806018cc2e8e82cad81f2b8108553900e

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp311-cp311-win_amd64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp311-cp311-win_amd64.whl
Algorithm Hash digest
SHA256 528b36fe15d354a94720eb6e56d0764c07d12ce8782fca5dcc49223fad256a0a
MD5 8160c16b9102be0d91e23bf52ff94f07
BLAKE2b-256 1486e11b1eb7a9cdbbefe7c7a56f13b99e8a3a98d3fdf2fbe360cb6656d46ab1

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp311-cp311-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp311-cp311-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 5073332baaabd57827dc9bd2c701a588d7939eac602b061b43799fdb31a052ff
MD5 60ab1ad89fc32d9c8b0f4df0ec90009b
BLAKE2b-256 7fcf4b54da8b78de98ad71066626c7e868e1f4600a4e2f2e860ea24bb4c16ee4

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 3a4cfadd3a94ab0359600d6be1cc7964fc323944ed6f9b7b59f4c50ae9d93dcd
MD5 65f6bb8bdbeb6b5d208f32fb736545fa
BLAKE2b-256 685232eea50b9fdd6afb19752940bd25142f20348b3247cc20e88d6602d5eb18

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp310-cp310-win_amd64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp310-cp310-win_amd64.whl
Algorithm Hash digest
SHA256 7bac65512649aa15608ec6e823be63448be17b193b2f4e1bd242a3e53acb532c
MD5 0283d331baab7631783000bdcbf1de93
BLAKE2b-256 31bc581c3565b5eeabe750bbaa96e89ce7430ffb698c77f8c5608c32896a7b83

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp310-cp310-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp310-cp310-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 d1ccfe92ce8317c4133f55c971512472f53ac4c3e07a2db86888859366d650ce
MD5 907eb1aa5cc269b0963f20c26097dd08
BLAKE2b-256 ba7012d26ce4e513c71741a704c61c52a5a93dc30b75e9717f28bc868e1de167

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 c4191cff354ae5d3f2b8cc5a8ef75cdbd9a9c72a926b1161f4fba9fccd3233f4
MD5 9f9d8c9d6c9a4dcab5cbcdb43e53fd70
BLAKE2b-256 63087baca39ca8117862371441b658d90253644b326f29bd970c5c666768a3ae

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp39-cp39-win_amd64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp39-cp39-win_amd64.whl
Algorithm Hash digest
SHA256 9974df1204bb641d11e59aa0413fa09cfe9aad86656108e465be6205bac474fb
MD5 853f531606ab25f5208655be06f3fdc4
BLAKE2b-256 cdf7b5c8541c8742c30147d2dd4e06c66c501266e9ac06e403f51583fe9e271b

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp39-cp39-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp39-cp39-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 44784189705e338ce14c7f4f9f3577b4d6bf58e434437b9592a5ab34d422b9f3
MD5 ffb4df341d04ea355ce75f09ee1e034b
BLAKE2b-256 93c7a6b3b9960ca56bbb26f0b39938c6d48b361bd6bd94a99e4ce5ed58a0a625

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 b3738064c60d4f5d39666a57efa1714c43cec956b46cb275d975e79e540d1f60
MD5 4c651bd1cb1d79a67f54d7b9ccf37e90
BLAKE2b-256 e28d53ad14388becbfb20d57f1900bd6b67299e17155c6ee60136d95f299cfcb

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp38-cp38-win_amd64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp38-cp38-win_amd64.whl
Algorithm Hash digest
SHA256 c95925a0d547f1664ff63f3cd8387f3a5c808aa52fd44505e71a7e8f9482b9ec
MD5 2f8808bd1130a97552725eb4c8af8941
BLAKE2b-256 e4c603e37a3501bb8c5110477c565a1154c50eee6683a5134db1ea4ea86317fe

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp38-cp38-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp38-cp38-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 af4a161040038ab6e03b548ec89d6f13a210d72c531c21815019bd5a3f7df2a0
MD5 42ddc4f880e50682af894e10aa2a6a64
BLAKE2b-256 120618906e727a08c3a92b3cd81e96565aecc51b08d2b7388bc411b34d197ad8

See more details on using hashes here.

File details

Details for the file oead-1.2.9.post4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for oead-1.2.9.post4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 1a2ec2e4122ed7df8afe94b6468603eac44a268a79dcf89a1b7352e2a3cb920f
MD5 0e5b47de479aad4157f6dc0b73fd8497
BLAKE2b-256 15dc78741ada7ea9b92af5c74f47178b296c3f44b3542288ad4a062ca4c9e092

See more details on using hashes here.

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