View source for Help:Tools/byml-v2

[[Category:Tools]]
[[Category:Tools (BYML)]]
{{Tool infobox
| name = byml-v2
| authors = leoetlino
| source = https://github.com/leoetlino/byml-v2
| license = GPLv2+
| written_in = Python
| win_only = 
}}

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 <code>byml</code> package. {{Install py package help|package=byml}}

== Usage ==
{{Tool usage notes|name=byml-v2|is_cli=1|does_auto_compress=1}}

* To '''convert a BYML file to text''' (YML): <code>byml_to_yml INPUT_FILE.byml OUTPUT_FILE.yml</code> {{ch}}
* To '''convert back to binary''' YML: <code>yml_to_byml INPUT_FILE.yml OUTPUT_FILE.sbyml</code> {{ch}} (add <code>-b</code> at the end for Wii U).

== Known issues ==
None