BYML - Revision history

Leoetlino: link to EPD wiki for v7+

2024-07-07T18:47:59Z

link to EPD wiki for v7+

← Older revision		Revision as of 18:47, 7 July 2024
Line 1:		Line 1:
	<onlyinclude>'''BYML''' is a simplified, binary form of [[wikipedia:YAML\|YAML]].</onlyinclude>		<onlyinclude>'''BYML''' is a simplified, binary form of [[wikipedia:YAML\|YAML]].</onlyinclude>

	Only the version 2+ format is documented in this article.		Only the version 2+ format is documented in this article. For newer versions (v7+), see [https://epd.zeldamods.org/wiki/Byaml the EPD wiki for more information].

	== Structure ==		== Structure ==

Kyto: Updated file format to version 7 for TotK

2023-05-15T21:17:52Z

Updated file format to version 7 for TotK

Show changes

imported>Leoetlino: /* Nodes */

2020-03-21T13:45:55Z

Nodes

← Older revision		Revision as of 13:45, 21 March 2020
Line 49:		Line 49:
	\|-		\|-
	\| align="center" \| 0xA1		\| align="center" \| 0xA1
	\| align="center" \| ~~Container~~		\| align="center" \| Value (Special)
	\| Binary data.		\| Binary data.
	\| 4+		\| 4+
Line 115:		Line 115:
	For string nodes, this encoding is simply a four byte index into the string table respectively.		For string nodes, this encoding is simply a four byte index into the string table respectively.

	For special value nodes, the value is an offset ~~to a 64 bit integer / floating-point number~~ relative to the start of the file.		For special value nodes, the value is an offset relative to the start of the file.

	==== 0xA1 - Binary Data Node ====		==== 0xA1 - Binary Data Node ====

imported>Leoetlino: add ACNH and v4 info

2020-03-21T13:13:07Z

add ACNH and v4 info

← Older revision		Revision as of 13:13, 21 March 2020
Line 1:		Line 1:
	<onlyinclude>'''BYML''' is a simplified, binary form of [[wikipedia:YAML\|YAML]].</onlyinclude>		<onlyinclude>'''BYML''' is a simplified, binary form of [[wikipedia:YAML\|YAML]].</onlyinclude>

	Only the version 2 ~~and 3 formats are~~ documented in this article.		Only the version 2+ format is documented in this article.

	== Structure ==		== Structure ==
Line 14:		Line 14:
	\| align="center" \| 0x00		\| align="center" \| 0x00
	\| align="center" \| 2		\| align="center" \| 2
	\| ~~String~~ “BY” (big endian) or “YB” (little endian~~) in ASCII (file identifier~~).		\| “BY” (big endian) or “YB” (little endian).
	\|-		\|-
	\| align="center" \| 0x02		\| align="center" \| 0x02
	\| align="center" \| 2		\| align="center" \| 2
	\| Version 0x0002 in Breath of the Wild. ~~Values of~~ 1 and 3 are ~~accepted as well~~.		\| Version 0x0002 in ''Breath of the Wild''. 1, 3 and 4 are also valid version numbers.
	\|-		\|-
	\| align="center" \| 0x04		\| align="center" \| 0x04
Line 40:		Line 40:
	! align="center" width="8%" \| Identifier		! align="center" width="8%" \| Identifier
	! align="center" width="17%" \| Type		! align="center" width="17%" \| Type
	! width="73%" \| Description		! width="63%" \| Description
			! width="10%" \| Version
	\|-		\|-
	\| align="center" \| 0xA0		\| align="center" \| 0xA0
	\| align="center" \| Value (Index)		\| align="center" \| Value (Index)
	\| String. Value is an index into the string table.		\| String. Value is an index into the string table.
			\| 2+
			\|-
			\| align="center" \| 0xA1
			\| align="center" \| Container
			\| Binary data.
			\| 4+
	\|-		\|-
	\| align="center" \| 0xC0		\| align="center" \| 0xC0
	\| align="center" \| Container		\| align="center" \| Container
	\| Array. Node is an array of nodes, typically, though not necessarily, all of the same format.		\| Array. Node is an array of nodes, typically, though not necessarily, all of the same format.
			\| 2+
	\|-		\|-
	\| align="center" \| 0xC1		\| align="center" \| 0xC1
	\| align="center" \| Container		\| align="center" \| Container
	\| Hash. Node is a mapping from strings in the hash key table to other nodes.		\| Hash. Node is a mapping from strings in the hash key table to other nodes.
			\| 2+
	\|-		\|-
	\| align="center" \| 0xC2		\| align="center" \| 0xC2
	\| align="center" \| Container (Special)		\| align="center" \| Container (Special)
	\| String table. Special purpose node type only seen in the hash key table and the string table.		\| String table. Special purpose node type only seen in the hash key table and the string table.
			\| 2+
	\|-		\|-
	\| align="center" \| 0xD0		\| align="center" \| 0xD0
	\| align="center" \| Value		\| align="center" \| Value
	\| Bool. Node is 1 or 0 representing true or false respectively.		\| Bool. Node is 1 or 0 representing true or false respectively.
			\| 2+
	\|-		\|-
	\| align="center" \| 0xD1		\| align="center" \| 0xD1
	\| align="center" \| Value		\| align="center" \| Value
	\| Int. Node is a signed 32 bit integer value.		\| Int. Node is a signed 32 bit integer value.
			\| 2+
	\|-		\|-
	\| align="center" \| 0xD2		\| align="center" \| 0xD2
	\| align="center" \| Value		\| align="center" \| Value
	\| Float. Node is a binary32 floating-point number.		\| Float. Node is a binary32 floating-point number.
			\| 2+
	\|-		\|-
	\| align="center" \| 0xD3		\| align="center" \| 0xD3
	\| align="center" \| Value		\| align="center" \| Value
	\| UInt. Node is an unsigned 32 bit integer value. The game uses this for some CRC32 hashes and for masks.		\| UInt. Node is an unsigned 32 bit integer value. The game uses this for some CRC32 hashes and for masks.
			\| 2+
	\|-		\|-
	\| align="center" \| 0xD4		\| align="center" \| 0xD4
	\| align="center" \| Value (Special)		\| align="center" \| Value (Special)
	\| Int64. Node is a 64 bit integer value. ~~Not seen in Breath of the Wild.~~		\| Int64. Node is a 64 bit integer value.
			\| 3+
	\|-		\|-
	\| align="center" \| 0xD5		\| align="center" \| 0xD5
	\| align="center" \| Value (Special)		\| align="center" \| Value (Special)
	\| UInt64. Node is an unsigned 64 bit integer value. ~~Not seen in Breath of the Wild.~~		\| UInt64. Node is an unsigned 64 bit integer value.
			\| 3+
	\|-		\|-
	\| align="center" \| 0xD6		\| align="center" \| 0xD6
	\| align="center" \| Value (Special)		\| align="center" \| Value (Special)
	\| Double. Node is a binary64 floating-point number. ~~Not seen in Breath of the Wild.~~		\| Double. Node is a binary64 floating-point number.
			\| 3+
	\|-		\|-
	\| align="center" \| 0xFF		\| align="center" \| 0xFF
	\| align="center" \| Value		\| align="center" \| Value
	\| Null. Value is always 0. ~~Not seen in Breath of the Wild.~~		\| Null. Value is always 0.
			\| 3+
	\|}		\|}

Line 98:		Line 116:

	For special value nodes, the value is an offset to a 64 bit integer / floating-point number relative to the start of the file.		For special value nodes, the value is an offset to a 64 bit integer / floating-point number relative to the start of the file.

			==== 0xA1 - Binary Data Node ====
			{\| class="wikitable"
			! align="center" \| Offset
			! align="center" \| Size
			! Description
			\|-
			\| align="center" \| 0x00
			\| align="center" \| 4
			\| Data length
			\|-
			\| align="center" \| 0x04
			\| align="center" \| variable
			\| Data
			\|}

	==== 0xC0 - Array Node ====		==== 0xC0 - Array Node ====
Line 197:		Line 230:
	\| ''Breath of the Wild'' (Switch) \|\| Little endian \|\| 2 \|\| Uses SMO's library (in al::), but with unused code and support for big endian eliminated		\| ''Breath of the Wild'' (Switch) \|\| Little endian \|\| 2 \|\| Uses SMO's library (in al::), but with unused code and support for big endian eliminated
	\|-		\|-
	\| ''Super Mario Odyssey'' (Switch) \|\| Little endian (supports big endian as well) \|\| 2 or 3 \|\|		\| ''Super Mario Odyssey'' (Switch) \|\| Little endian (supports big endian as well) \|\| 3 \|\|
			\|-
			\| ''Splatoon 2'' (Switch) \|\| Little endian (supports big endian as well) \|\| 3? \|\| Uses SMO's library, but in the Lp::Utl:: namespace
	\|-		\|-
	\| ''~~Splatoon 2~~'' (Switch) \|\| Little endian (supports big endian as well) \|\| ~~2 or 3~~ \|\| ~~Uses SMO's library, but in the Lp::Utl:: namespace~~		\| ''Animal Crossing: New Horizons'' (Switch) \|\| Little endian (supports big endian as well) \|\| 4 \|\|
	\|}		\|}

imported>NiceneNerd: /* Usage in Nintendo games */

2019-07-26T23:47:25Z

Usage in Nintendo games

← Older revision		Revision as of 23:47, 26 July 2019
Line 203:		Line 203:

	The v3 format seems to be identical to v2 but with the 64-bit node types added.		The v3 format seems to be identical to v2 but with the 64-bit node types added.

			=== Extensions ===
			Nintendo uses several file extensions for BYML files in BotW. The basic format is the same even though each kind has a different purpose and contains different parameters. Known extensions:
			* [[Baischedule\|.baischedule]]
			* [[Baniminfo\|.baniminfo]]
			* [[Bgdata\|.bgdata]]
			* [[Bgsvdata\|.bgsvdata]]
			* [[Bquestpack\|.bquestpack]]
			* [[BYML\|.byml]]
			* [[Mubin\|.mubin]]

	== Tools ==		== Tools ==

imported>Leoetlino at 13:35, 26 December 2018

2018-12-26T13:35:13Z

← Older revision		Revision as of 13:35, 26 December 2018
Line 127:		Line 127:
	==== 0xC1 - Hash Node ====		==== 0xC1 - Hash Node ====

	Hash / dictionary nodes are used to encode name value collections. ~~The order of entries~~ in ~~the dictionary does not seem to matter~~.		Hash / dictionary nodes are used to encode name value collections. Entries must be lexicographically sorted<ref>Nintendo's BYML library performs a binary search when looking up items by key in a hash node.</ref>.

	{\| class="wikitable"		{\| class="wikitable"

imported>Leoetlino: /* Tools */

2018-10-14T11:44:59Z

Tools

← Older revision		Revision as of 11:44, 14 October 2018
Line 205:		Line 205:

	== Tools ==		== Tools ==
	* [https://github.com/SeekingFunChild/Byaml_Editor Byaml Editor]		{{tool table\|category=Tools (BYML)}}
	* [https://github.com/arbiter34/ninten-file-tool ~~ninten-file-tool]: sbyml/sbwlp/smubin/baniminfo encode/decode with Yaz0~~ (~~byml/prod w/ yaz0~~)
	* [https://github.com/leoetlino/byml-v2 byml-v2]: BYML <-> YAML converter which supports v2 and v3 files, all the new node types and both Switch and Wii U files. Can also be used as a library.

	''This article was adapted from documentation in the [https://github.com/handsomematt/botw-modding/blob/master/docs/file_formats/byml.md handsomematt/botw-modding repo].''		''This article was adapted from documentation in the [https://github.com/handsomematt/botw-modding/blob/master/docs/file_formats/byml.md handsomematt/botw-modding repo].''
	[[Category:File formats]]		[[Category:File formats]]

imported>Leoetlino: /* Usage in Nintendo games */ whoops

2018-10-14T11:03:14Z

Usage in Nintendo games: whoops

← Older revision		Revision as of 11:03, 14 October 2018
Line 193:		Line 193:
	! Game !! Endianness !! Version \|\| Notes		! Game !! Endianness !! Version \|\| Notes
	\|-		\|-
	\| ''Breath of the Wild'' (Wii U) \|\| Big endian \|\| 2 \|\| Uses SMO's library (in al::)~~, but with unused code and support for big endian eliminated~~		\| ''Breath of the Wild'' (Wii U) \|\| Big endian \|\| 2 \|\| Uses SMO's library (in al::)
	\|-		\|-
	\| ''Breath of the Wild'' (Switch) \|\| Little endian \|\| 2 \|\| Uses SMO's library (in al::), but with unused code and support for big endian eliminated		\| ''Breath of the Wild'' (Switch) \|\| Little endian \|\| 2 \|\| Uses SMO's library (in al::), but with unused code and support for big endian eliminated

imported>Leoetlino at 21:38, 7 October 2018

2018-10-07T21:38:57Z

← Older revision		Revision as of 21:38, 7 October 2018
Line 188:		Line 188:

	Y’ is Y rounded up to the nearest multiple of 4.		Y’ is Y rounded up to the nearest multiple of 4.

			== Usage in Nintendo games ==
			{\|class="wikitable"
			! Game !! Endianness !! Version \|\| Notes
			\|-
			\| ''Breath of the Wild'' (Wii U) \|\| Big endian \|\| 2 \|\| Uses SMO's library (in al::), but with unused code and support for big endian eliminated
			\|-
			\| ''Breath of the Wild'' (Switch) \|\| Little endian \|\| 2 \|\| Uses SMO's library (in al::), but with unused code and support for big endian eliminated
			\|-
			\| ''Super Mario Odyssey'' (Switch) \|\| Little endian (supports big endian as well) \|\| 2 or 3 \|\|
			\|-
			\| ''Splatoon 2'' (Switch) \|\| Little endian (supports big endian as well) \|\| 2 or 3 \|\| Uses SMO's library, but in the Lp::Utl:: namespace
			\|}

			The v3 format seems to be identical to v2 but with the 64-bit node types added.

	== Tools ==		== Tools ==

imported>Leoetlino at 13:29, 9 September 2018

2018-09-09T13:29:35Z

← Older revision		Revision as of 13:29, 9 September 2018
Line 1:		Line 1:
	'''BYML''' ~~is a file format that is used as a generic data container throughout ''Breath of the Wild''. It~~ is a simplified, binary form of [[wikipedia:YAML\|YAML]].		<onlyinclude>'''BYML''' is a simplified, binary form of [[wikipedia:YAML\|YAML]].</onlyinclude>

	Only the version 2 and 3 formats are documented in this article.		Only the version 2 and 3 formats are documented in this article.