Skip to main content

A library for converting Breath of the Wild Havok packfiles to JSON and back

Project description

botw_havok

A library for converting Breath of the Wild Havok packfiles to JSON and back.

The main purpose of this library is deserializing Havok packfiles into a universal JSON file that can be converted to both Wii U and Switch packfiles.

HKX -> JSON conversion:

from botw_havok import Havok

hk = Havok.from_file('A-1-0.hksc')
hk.deserialize()
hk.to_json('A-1-0.json', pretty_print=True)

JSON -> HKX conversion:

from botw_havok import Havok

hk = Havok.from_json('A-1-0.json')
hk.to_switch() # or hk.to_wiiu()
hk.serialize()
hk.to_file('A-1-0.hksc')

The library also comes with two commands: hk_to_json and json_to_hk

You can learn how to use them by appending --help flag


At the moment, only Havok Physics files (.hksc, .hkrb, .hktmrb) work. Most of them should deserialize and serialize flawlessly and should be nearly identical to the originals (except the pointer section ordering which should be irrelevant).

The library is currently highly experimental, so expect bugs!

It's also really messy. Forgive me.

Project details


Download files

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

Files for botw-havok, version 0.2.3
Filename, size File type Python version Upload date Hashes
Filename, size botw_havok-0.2.3-py3-none-any.whl (81.0 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size botw_havok-0.2.3.tar.gz (38.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page