Help:Tools/byml-v2: Difference between revisions

From ZeldaMods (Breath of the Wild)
Jump to navigation Jump to search
imported>Leoetlino
No edit summary
imported>Leoetlino
 
(3 intermediate revisions by the same user not shown)
Line 5: Line 5:
| authors = leoetlino
| authors = leoetlino
| source = https://github.com/leoetlino/byml-v2
| source = https://github.com/leoetlino/byml-v2
| license = GPLv3
| license = GPLv2+
| written_in = Python
| written_in = Python
| win_only =  
| win_only =  
Line 16: Line 16:


== Usage ==
== Usage ==
This tool automatically decompresses Yaz0-encoded files, and re-compresses them if the extension starts with an <code>s</code>.
{{Tool usage notes|name=byml-v2|is_cli=1|does_auto_compress=1}}
* <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).
* 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 ==
== Known issues ==
None
None

Latest revision as of 11:25, 7 April 2019

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

byml-v2 is a CLI tool. For help with using the command line, see Help:Using the command line.  

This tool automatically decompresses Yaz0-compressed 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