Help:Tools/Wild Bits - Revision history

NiceneNerd: /* Usage */

2020-07-10T01:41:43Z

Usage

← Older revision		Revision as of 01:41, 10 July 2020
Line 22:		Line 22:

	== Usage ==		== Usage ==
			[[File:Wild Bits UI preview.png\|250px\|thumb\|right]]
	Wild Bits can be launched with the <code>wildbits</code> command.{{CLI help}} A desktop shortcut can also be made pointing to the executable in Python's <code>Scripts</code> directory.		Wild Bits can be launched with the <code>wildbits</code> command.{{CLI help}} A desktop shortcut can also be made pointing to the executable in Python's <code>Scripts</code> directory.

NiceneNerd: Significant update

2020-07-10T01:39:08Z

Significant update

← Older revision		Revision as of 01:39, 10 July 2020
Line 14:		Line 14:
	}}		}}

	Wild Bits is a graphical frontend for ~~a handful of [[User:Leoetlino\|Leoetlino]]'s BotW Python~~ tools~~, including~~ <code>~~[[Help:Tools/rstb\|rstb]]~~</code>~~, <code>[[Help:Tools/sarc\|sarc]]</code>, <code>[[Help:Tools/aamp\|aamp]]</code>,~~ and ~~<code>~~[[Help:Tools/~~byml-v2~~\|~~byml-v2~~]]~~</code>. It is currently in beta and rather unpolished~~.		Wild Bits is a graphical frontend for several tools in the <code>oead</code> Python library and the [[Help:Tools/msyt\|MSYT]] editor for MSBTs.

	== Setup ==		== Setup ==
	# Ensure you have a '''64 bit version''' of Python 3.'''7+''' before continuing. You will not be able to install or launch Wild Bits otherwise.		# Ensure you have a '''64 bit version''' of Python 3.'''7+''' before continuing. Windows users must also install the latest x64 Visual C++ redistributable. You will not be able to install or launch Wild Bits otherwise. See [[Help:Setting_up_tools]].
	# ~~Install PySide2~~. {{Install py package help\|package=~~PySide2~~}}		# (Optional) For best results on Windows, install <code>cefpython3</code>. {{Install py package help\|package=cefpython3}}
	# Install the <code>wildbits</code> package. {{Install py package help\|package=wildbits}}		# Install the <code>wildbits</code> package. {{Install py package help\|package=wildbits}}

	== Usage ==		== Usage ==
	~~[[File:Wild Bits UI.png\|thumb\|right\|Wild Bits interface]]~~		Wild Bits can be launched with the <code>wildbits</code> command.{{CLI help}} A desktop shortcut can also be made pointing to the executable in Python's <code>Scripts</code> directory.
	Wild Bits can be launched with the <code>wildbits</code> command. {{CLI help}} A desktop shortcut can also be made pointing to the executable in Python's <code>Scripts</code> directory.

	The main Wild Bits interface has 3 tabs corresponding to its main functions: a SARC editor, an RSTB editor, and a YAML editor. Each editor supports both Wii U and Switch (big and little endian) formats where relevant and will automatically keep track of them. Each editor also automatically handles yaz0 decompression when loading, and will recompress on saving ~~except when using Save As, which will present~~ the ~~choice to compress or not~~.		The main Wild Bits interface has 3 tabs corresponding to its main functions: a SARC editor, an RSTB editor, and a YAML editor. Each editor supports both Wii U and Switch (big and little endian) formats where relevant and will automatically keep track of them. Each editor also automatically handles yaz0 decompression when loading, and will recompress on saving if the file extension begins with <code>.s</code>.

	~~Notes about~~ the ~~YAML editor~~: ~~The YAML editor handles both BYML and AAMP files~~. ~~It will keep track of which kind you have open, though it will not prevent using Save As to switch between the two (which would likely ruin the output file). The YAML output displayed in~~ Wild Bits ~~is readonly~~. ~~The actual editing must be done~~ on ~~a temp file in an external program, which Wild Bits will automatically track changes to and process~~.		For more details on using Wild Bits, see the [https://github.com/NiceneNerd/Wild-Bits/blob/master/docs/README.md readme on GitHub].

	== Known issues ==		== Known issues ==
	~~Performance for RSTB functions may be poor~~		On some system configurations, launching with <code>wildbits</code> doesn't work and you must use <code>python -m wildbits</code> instead.

imported>CEObrainz at 18:51, 17 January 2020

2020-01-17T18:51:59Z

← Older revision		Revision as of 18:51, 17 January 2020
Line 4:		Line 4:
	[[Category:Tools (BYML)]]		[[Category:Tools (BYML)]]
	[[Category:Tools (RSTB)]]		[[Category:Tools (RSTB)]]
			[[Category:Tools (MSBT)]]
	{{Tool infobox		{{Tool infobox
	\| name = Wild Bits		\| name = Wild Bits

imported>NiceneNerd at 22:01, 24 July 2019

2019-07-24T22:01:35Z

← Older revision		Revision as of 22:01, 24 July 2019
Line 3:		Line 3:
	[[Category:Tools (AAMP)]]		[[Category:Tools (AAMP)]]
	[[Category:Tools (BYML)]]		[[Category:Tools (BYML)]]
			[[Category:Tools (RSTB)]]
	{{Tool infobox		{{Tool infobox
	\| name = Wild Bits		\| name = Wild Bits

imported>NiceneNerd at 16:34, 1 July 2019

2019-07-01T16:34:05Z

← Older revision		Revision as of 16:34, 1 July 2019
Line 1:		Line 1:
	[[Category:Tools]]		[[Category:Tools]]
			[[Category:Tools (SARC)]]
			[[Category:Tools (AAMP)]]
			[[Category:Tools (BYML)]]
	{{Tool infobox		{{Tool infobox
	\| name = Wild Bits		\| name = Wild Bits

imported>Leoetlino: typo

2019-06-29T06:52:20Z

typo

← Older revision		Revision as of 06:52, 29 June 2019
Line 9:		Line 9:
	}}		}}

	Wild Bits is a graphical frontend for a handful of [[User:Leoetlino\|Leoetlino]]'s ~~BoTW~~ Python tools, including <code>[[Help:Tools/rstb\|rstb]]</code>, <code>[[Help:Tools/sarc\|sarc]]</code>, <code>[[Help:Tools/aamp\|aamp]]</code>, and <code>[[Help:Tools/byml-v2\|byml-v2]]</code>. It ~~can~~ currently in beta and rather unpolished.		Wild Bits is a graphical frontend for a handful of [[User:Leoetlino\|Leoetlino]]'s BotW Python tools, including <code>[[Help:Tools/rstb\|rstb]]</code>, <code>[[Help:Tools/sarc\|sarc]]</code>, <code>[[Help:Tools/aamp\|aamp]]</code>, and <code>[[Help:Tools/byml-v2\|byml-v2]]</code>. It is currently in beta and rather unpolished.

	== Setup ==		== Setup ==

imported>NiceneNerd: /* Usage */ Moved UI preview

2019-06-29T02:38:10Z

Usage: Moved UI preview

← Older revision		Revision as of 02:38, 29 June 2019
Line 17:		Line 17:

	== Usage ==		== Usage ==
			[[File:Wild Bits UI.png\|thumb\|right\|Wild Bits interface]]
	Wild Bits can be launched with the <code>wildbits</code> command. {{CLI help}} A desktop shortcut can also be made pointing to the executable in Python's <code>Scripts</code> directory.		Wild Bits can be launched with the <code>wildbits</code> command. {{CLI help}} A desktop shortcut can also be made pointing to the executable in Python's <code>Scripts</code> directory.
	~~[[File:Wild Bits UI.png\|thumb\|right\|Wild Bits interface]]~~
	The main Wild Bits interface has 3 tabs corresponding to its main functions: a SARC editor, an RSTB editor, and a YAML editor. Each editor supports both Wii U and Switch (big and little endian) formats where relevant and will automatically keep track of them. Each editor also automatically handles yaz0 decompression when loading, and will recompress on saving except when using Save As, which will present the choice to compress or not.		The main Wild Bits interface has 3 tabs corresponding to its main functions: a SARC editor, an RSTB editor, and a YAML editor. Each editor supports both Wii U and Switch (big and little endian) formats where relevant and will automatically keep track of them. Each editor also automatically handles yaz0 decompression when loading, and will recompress on saving except when using Save As, which will present the choice to compress or not.

imported>NiceneNerd: Created page for Wild Bits

2019-06-29T02:37:22Z

Created page for Wild Bits

New page

[[Category:Tools]]
{{Tool infobox
| name = Wild Bits
| authors = NiceneNerd
| source = https://github.com/NiceneNerd/Wild-Bits/
| license = GPLv3+
| written_in = Python
| win_only=
}}

Wild Bits is a graphical frontend for a handful of [[User:Leoetlino|Leoetlino]]'s BoTW Python tools, including <code>[[Help:Tools/rstb|rstb]]</code>, <code>[[Help:Tools/sarc|sarc]]</code>, <code>[[Help:Tools/aamp|aamp]]</code>, and <code>[[Help:Tools/byml-v2|byml-v2]]</code>. It can currently in beta and rather unpolished.

== Setup ==
# Ensure you have a '''64 bit version''' of Python 3.'''7+''' before continuing. You will not be able to install or launch Wild Bits otherwise.
# Install PySide2. {{Install py package help|package=PySide2}}
# Install the <code>wildbits</code> package. {{Install py package help|package=wildbits}}

== Usage ==
Wild Bits can be launched with the <code>wildbits</code> command. {{CLI help}} A desktop shortcut can also be made pointing to the executable in Python's <code>Scripts</code> directory.
[[File:Wild Bits UI.png|thumb|right|Wild Bits interface]]
The main Wild Bits interface has 3 tabs corresponding to its main functions: a SARC editor, an RSTB editor, and a YAML editor. Each editor supports both Wii U and Switch (big and little endian) formats where relevant and will automatically keep track of them. Each editor also automatically handles yaz0 decompression when loading, and will recompress on saving except when using Save As, which will present the choice to compress or not.

Notes about the YAML editor: The YAML editor handles both BYML and AAMP files. It will keep track of which kind you have open, though it will not prevent using Save As to switch between the two (which would likely ruin the output file). The YAML output displayed in Wild Bits is readonly. The actual editing must be done on a temp file in an external program, which Wild Bits will automatically track changes to and process.

== Known issues ==
Performance for RSTB functions may be poor