Help:Tools/byml-v2 - Revision history

imported>Leoetlino: /* Usage */

2019-04-07T11:25:57Z

Usage

← Older revision		Revision as of 11:25, 7 April 2019
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>. This means that '''you do not need to compress or decompress files manually.'''~~		{{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 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).		* 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).

imported>Leoetlino at 18:27, 1 February 2019

2019-02-01T18:27:12Z

← Older revision		Revision as of 18:27, 1 February 2019
Line 17:		Line 17:
	== Usage ==		== Usage ==
	This tool automatically decompresses Yaz0-encoded files, and re-compresses them if the extension starts with an <code>s</code>. This means that '''you do not need to compress or decompress files manually.'''		This tool automatically decompresses Yaz0-encoded files, and re-compresses them if the extension starts with an <code>s</code>. This means that '''you do not need to compress or decompress files manually.'''
	* To convert a BYML file to a text ~~format~~ (YML): <code>byml_to_yml INPUT_FILE.byml OUTPUT_FILE.yml</code> {{ch}}		* 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).		* 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

imported>Leoetlino at 18:24, 1 February 2019

2019-02-01T18:24:14Z

← Older revision		Revision as of 18:24, 1 February 2019
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>.		This tool automatically decompresses Yaz0-encoded files, and re-compresses them if the extension starts with an <code>s</code>. This means that '''you do not need to compress or decompress files manually.'''
	* <code>byml_to_yml INPUT_FILE.byml OUTPUT_FILE.yml</code>		* To convert a BYML file to a text format (YML): <code>byml_to_yml INPUT_FILE.byml OUTPUT_FILE.yml</code> {{ch}}
	* <code>yml_to_byml ~~[-b]~~ INPUT_FILE.yml OUTPUT_FILE.sbyml</code> (~~Use~~ <code>-b</code> for Wii U ~~only~~).		* 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

imported>Leoetlino: whoops. GPLv3 -> GPLv2+

2018-10-21T14:55:55Z

whoops. GPLv3 -> GPLv2+

← Older revision		Revision as of 14:55, 21 October 2018
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 =

imported>Leoetlino at 18:54, 15 October 2018

2018-10-15T18:54:24Z

← Older revision		Revision as of 18:54, 15 October 2018
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

imported>Leoetlino: /* Known issues */

2018-10-15T17:46:21Z

Known issues

← Older revision		Revision as of 17:46, 15 October 2018
Line 16:		Line 16:

	== Known issues ==		== Known issues ==
	~~(none currently)~~		None

imported>Leoetlino: /* Setup */

2018-10-15T16:28:22Z

Setup

← Older revision		Revision as of 16:28, 15 October 2018
Line 13:		Line 13:

	== 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}}

	== Known issues ==		== Known issues ==
	(none currently)		(none currently)

imported>Leoetlino: Created page with "Category:Tools Category:Tools (BYML) {{Tool infobox | name = byml-v2 | authors = leoetlino | source = https://github.com/leoetlino/byml-v2 | license = GPLv3 | written_..."

2018-10-14T10:56:17Z

Created page with "Category:Tools Category:Tools (BYML) {{Tool infobox | name = byml-v2 | authors = leoetlino | source = https://github.com/leoetlino/byml-v2 | license = GPLv3 | written_..."

New page

[[Category:Tools]]
[[Category:Tools (BYML)]]
{{Tool infobox
| name = byml-v2
| authors = leoetlino
| source = https://github.com/leoetlino/byml-v2
| license = GPLv3
| 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}}

== Known issues ==
(none currently)