Help:Tools/byml-v2

From ZeldaMods (Breath of the Wild)
< Help:Setting up tools
Revision as of 18:27, 1 February 2019 by imported>Leoetlino
Jump to navigation Jump to search
byml-v2
Author(s) leoetlino
Source code https://github.com/leoetlino/byml-v2
License GPLv2+
Written in Python
Platform support Cross-platform

byml-v2 is an BYML tool. It can convert documents from BYML (or BYAML) to a human readable format (YAML) and vice versa. It is a newer tool that was written based on analysis of the official BYML code and game code in the executable. As such, this tool supports all the newer node types that are used in Breath of the Wild and other recent Switch games such as Super Mario Odyssey.

Setup

Install the byml package. [CLI help]

Usage

This tool automatically decompresses Yaz0-encoded files, and re-compresses them if the extension starts with an s. This means that you do not need to compress or decompress files manually.

  • To convert a BYML file to text (YML): byml_to_yml INPUT_FILE.byml OUTPUT_FILE.yml [help]
  • To convert back to binary YML: yml_to_byml INPUT_FILE.yml OUTPUT_FILE.sbyml [help] (add -b at the end for Wii U).

Known issues

None