Skip to main content

A collection of tools for modding Breath of the Wild

Project description


A set of CLI tools for Breath of the Wild modding

  • yaz0: De/compress a file with Yaz-0
  • aamp: Convert between AAMP and YML
  • byml: Convert between BYML and YML
  • sarc: Manipulate SARC archives
  • actorinfo: Manipulate ActorInfo file

All commands can read from stdin and write to stdout, either automatically or by explicitly using the pipe (-) character instead of file path.

To see how to use these commands, please refer either to command --help (ex. aamp --help), or the examples below.



# View a AAMP file
aamp DgnObj_EntranceElevatorSP.bphysics

# Save as YML
aamp DgnObj_EntranceElevatorSP.bphysics \!!  # Saves as 'DgnObj_EntranceElevatorSP.physics.yml'
# or
aamp DgnObj_EntranceElevatorSP.bphysics test.yml

Yaz0 and BYML:

# View a BYML file

# First variant
yaz0 ActorInfo.product.sbyml | byml

# Second variant
yaz0 ActorInfo.product.sbyml ActorInfo.product.byml
byml ActorInfo.product.byml

# Save as YML

# First variant
yaz0 ActorInfo.product.sbyml | byml - ActorInfo.product.yml

# Second variant
yaz0 ActorInfo.product.sbyml ActorInfo.product.byml
byml ActorInfo.product.byml \!!  # Saves as 'ActorInfo.product.yml'
# or
byml ActorInfo.product.byml actorinfo.yml

Yaz0 and SARC:

Decompress and extract a SARC archive DgnObj_EntranceElevatorSP.sbactorpack to elevator folder:

# First variant
yaz0 DgnObj_EntranceElevatorSP.sbactorpack | sarc e(x)tract - elevator

# Second variant
yaz0 DgnObj_EntranceElevatorSP.sbactorpack \!!
sarc x DgnObj_EntranceElevatorSP.bactorpack elevator

Remove all files inside SARC:

# First variant
yaz0 DgnObj_EntranceElevatorSP.sbactorpack | sarc (r)emove - \* | yaz0 - Empty.sbactorpack

# Second variant
yaz0 DgnObj_EntranceElevatorSP.sbactorpack DgnObj_EntranceElevatorSP.bactorpack
sarc r DgnObj_EntranceElevatorSP.bactorpack \*
yaz0 DgnObj_EntranceElevatorSP.bactorpack Empty.sbactorpack


# Get an entry
actorinfo ActorInfo.product.sbyml get DgnObj_EntranceElevatorSP
actorinfo ActorInfo.product.sbyml g DgnObj_EntranceElevatorSP

# Duplicate an entry
actorinfo ActorInfo.product.sbyml duplicate DgnObj_EntranceElevatorSP MyCustomEntranceElevator
actorinfo ActorInfo.product.byml d DgnObj_EntranceElevatorSP MyCustomEntranceElevator

# Change entry keys
actorinfo ActorInfo.product.sbyml edit MyCustomEntranceElevator bfres MyCustomEntranceElevatorBfres
actorinfo ActorInfo.product.byml e MyCustomEntranceElevator bfres MyCustomEntranceElevatorBfres

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

botw_tools-0.5.2.tar.gz (113.7 kB view hashes)

Uploaded Source

Built Distribution

botw_tools-0.5.2-py3-none-any.whl (9.2 kB view hashes)

Uploaded Python 3

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