Help:Tools/byml-v2: Difference between revisions

From ZeldaMods (Breath of the Wild)
Jump to navigation Jump to search
imported>Leoetlino
imported>Leoetlino
No edit summary
Line 14: Line 14:
== Setup ==
== Setup ==
Install the <code>byml</code> package. {{Install py package help|package=byml}}
Install the <code>byml</code> package. {{Install py package help|package=byml}}
== Usage ==
This tool automatically decompresses Yaz0-encoded files, and re-compresses them if the extension starts with an <code>s</code>.
* <code>byml_to_yml INPUT_FILE.byml OUTPUT_FILE.yml</code>
* <code>yml_to_byml [-b] INPUT_FILE.yml OUTPUT_FILE.sbyml</code> (Use <code>-b</code> for Wii U only).


== Known issues ==
== Known issues ==
None
None

Revision as of 18:54, 15 October 2018

byml-v2
Author(s) leoetlino
Source code https://github.com/leoetlino/byml-v2
License GPLv3
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.

  • byml_to_yml INPUT_FILE.byml OUTPUT_FILE.yml
  • yml_to_byml [-b] INPUT_FILE.yml OUTPUT_FILE.sbyml (Use -b for Wii U only).

Known issues

None