Library for recent Nintendo EAD formats in first-party games

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Mindstormman from gravatar.com Mindstormman

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v2 or later (GPLv2+)
  • Author: TKVSC Team
  • Requires: Python >=3.6
Classifiers
Report project as malware

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 YAL): Versions 1-10 are supported (32-bit and 64-bit hash nodes, monotyped arrays). Remapped container nodes and non-container root nodes are not 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)

  • macOS 10.14+ (x86-64 / arm64)

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for Mindstormman from gravatar.com Mindstormman

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: GNU General Public License v2 or later (GPLv2+)
  • Author: TKVSC Team
  • Requires: Python >=3.6
Classifiers

Release history Release notifications | RSS feed

1.5

This version

1.4.5

Download files

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

Source Distribution

tkvsc_oead-1.4.5.tar.gz (4.9 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

tkvsc_oead-1.4.5-cp314-cp314-win_amd64.whl (2.1 MB view details)

Uploaded CPython 3.14Windows x86-64

tkvsc_oead-1.4.5-cp314-cp314-musllinux_1_2_x86_64.whl (3.2 MB view details)

Uploaded CPython 3.14musllinux: musl 1.2+ x86-64

tkvsc_oead-1.4.5-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.14manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

tkvsc_oead-1.4.5-cp314-cp314-macosx_11_0_arm64.whl (1.9 MB view details)

Uploaded CPython 3.14macOS 11.0+ ARM64

tkvsc_oead-1.4.5-cp313-cp313-win_amd64.whl (2.0 MB view details)

Uploaded CPython 3.13Windows x86-64

tkvsc_oead-1.4.5-cp313-cp313-musllinux_1_2_x86_64.whl (3.2 MB view details)

Uploaded CPython 3.13musllinux: musl 1.2+ x86-64

tkvsc_oead-1.4.5-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (2.2 MB view details)

Uploaded CPython 3.13manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

tkvsc_oead-1.4.5-cp313-cp313-macosx_11_0_arm64.whl (1.9 MB view details)

Uploaded CPython 3.13macOS 11.0+ ARM64

File details

Details for the file tkvsc_oead-1.4.5.tar.gz.

File metadata

  • Download URL: tkvsc_oead-1.4.5.tar.gz
  • Upload date:
  • Size: 4.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tkvsc_oead-1.4.5.tar.gz
Algorithm Hash digest
SHA256 b51e02a2638cf1c4652b78d47bfbc182441b97d54cf49ef332cb4799d04060e0
MD5 ca347574d4a4b22722711aef49d0221f
BLAKE2b-256 aa887a4cb67d25e15927cdbaaa67641642cd7fe2bf3628a9779c8e5415b39d21

See more details on using hashes here.

Provenance

The following attestation bundles were made for tkvsc_oead-1.4.5.tar.gz:

Publisher: release.yml on TKVSC-Team/oead

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tkvsc_oead-1.4.5-cp314-cp314-win_amd64.whl.

File metadata

  • Download URL: tkvsc_oead-1.4.5-cp314-cp314-win_amd64.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: CPython 3.14, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tkvsc_oead-1.4.5-cp314-cp314-win_amd64.whl
Algorithm Hash digest
SHA256 2c6695540606cfadc35b8d3886389f407b8410fd958ffaaa8ee31a458e987ae1
MD5 6fdb3a7a1992d29118d937f554efb261
BLAKE2b-256 5e876e5bf5a59799d04ec2f29d43d51db0ecddddf4bfe1f8432976f8964ed664

See more details on using hashes here.

Provenance

The following attestation bundles were made for tkvsc_oead-1.4.5-cp314-cp314-win_amd64.whl:

Publisher: release.yml on TKVSC-Team/oead

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tkvsc_oead-1.4.5-cp314-cp314-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for tkvsc_oead-1.4.5-cp314-cp314-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 201a894bdaff781e178af37b8ef9560d4b3f4cff47f8b32ad903b04ae5dbebce
MD5 7b240c222ba4a455821d69a232eb956f
BLAKE2b-256 33ba83587e327c7be354237c81f7cfe68efadd3aad9fc9f872ed246f51af90f7

See more details on using hashes here.

Provenance

The following attestation bundles were made for tkvsc_oead-1.4.5-cp314-cp314-musllinux_1_2_x86_64.whl:

Publisher: release.yml on TKVSC-Team/oead

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tkvsc_oead-1.4.5-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for tkvsc_oead-1.4.5-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 f703f20c9ebcc4d477739b0031c9bc186b799c403a89a48a2f6ea1543f41d923
MD5 3d3f695217970a393842c54f7f832b18
BLAKE2b-256 2d53d8db1cf4c2e7a04601d5614019c1085248793910d6d687e1aaada31576c4

See more details on using hashes here.

Provenance

The following attestation bundles were made for tkvsc_oead-1.4.5-cp314-cp314-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release.yml on TKVSC-Team/oead

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tkvsc_oead-1.4.5-cp314-cp314-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for tkvsc_oead-1.4.5-cp314-cp314-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 4a9f50183aef68cea94e71cb193808018a122965c0e80d93fd61685db70d13f0
MD5 33a0c1b0f2033d18274702a1d7a15dd1
BLAKE2b-256 1426c79910bf50c6f953590a58383ac646e8422adcf2e339d1271d3a64aa4cdf

See more details on using hashes here.

Provenance

The following attestation bundles were made for tkvsc_oead-1.4.5-cp314-cp314-macosx_11_0_arm64.whl:

Publisher: release.yml on TKVSC-Team/oead

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tkvsc_oead-1.4.5-cp313-cp313-win_amd64.whl.

File metadata

  • Download URL: tkvsc_oead-1.4.5-cp313-cp313-win_amd64.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: CPython 3.13, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for tkvsc_oead-1.4.5-cp313-cp313-win_amd64.whl
Algorithm Hash digest
SHA256 bba1df40af9e28c1709698646a24bf8f35de2d3f25cd180766386984f306d31b
MD5 867bcdbdef9d70d8c7c6e5b7573ce016
BLAKE2b-256 98e764542acb9c3a2a435e06a9731bd74e1e0dd2bd9016493fa897eae7f1d8b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for tkvsc_oead-1.4.5-cp313-cp313-win_amd64.whl:

Publisher: release.yml on TKVSC-Team/oead

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tkvsc_oead-1.4.5-cp313-cp313-musllinux_1_2_x86_64.whl.

File metadata

File hashes

Hashes for tkvsc_oead-1.4.5-cp313-cp313-musllinux_1_2_x86_64.whl
Algorithm Hash digest
SHA256 eb5ee3be3f201d8806f3697422aacebb9641bd20fa3cfb5fc7daaa8d68616d78
MD5 b8f5bf4e9e43cd08dd778bbecbedf78a
BLAKE2b-256 7422089a1155f4391cbf005096ac2a05844ae295b2cfb7b0b8bed27c61fff64f

See more details on using hashes here.

Provenance

The following attestation bundles were made for tkvsc_oead-1.4.5-cp313-cp313-musllinux_1_2_x86_64.whl:

Publisher: release.yml on TKVSC-Team/oead

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tkvsc_oead-1.4.5-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for tkvsc_oead-1.4.5-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 b5ed37b906f19ace3a3c12dd99a858849113f8f7cde3f7dce0abcfa60f4a600d
MD5 1bfbee91f30d3232043babec7de11cc7
BLAKE2b-256 42999ffbc9719b98d922679d562f5b53627de4e000b02e28d425bcb5a8dbf380

See more details on using hashes here.

Provenance

The following attestation bundles were made for tkvsc_oead-1.4.5-cp313-cp313-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: release.yml on TKVSC-Team/oead

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file tkvsc_oead-1.4.5-cp313-cp313-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for tkvsc_oead-1.4.5-cp313-cp313-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 ba04a23accc26160ee2ef22a6693fce2cfddd4a6bb99520ef01a75b9e8b5c293
MD5 b96b9e490068024d293771ee65cf7428
BLAKE2b-256 b4185808c564b5e70099713a02453ecb9df4d352d57d98b9293798923153ca26

See more details on using hashes here.

Provenance

The following attestation bundles were made for tkvsc_oead-1.4.5-cp313-cp313-macosx_11_0_arm64.whl:

Publisher: release.yml on TKVSC-Team/oead

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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