Help:Tools/Wild Bits: Difference between revisions

From ZeldaMods (Breath of the Wild)
Jump to navigation Jump to search
VisualWikitext
imported>NiceneNerd
No edit summary
 
(2 intermediate revisions by 2 users not shown)
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
Line 13: 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]]
[[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.


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.

Latest revision as of 01:41, 10 July 2020

Wild Bits
Author(s) NiceneNerd
Source code https://github.com/NiceneNerd/Wild-Bits/
License GPLv3+
Written in Python
Platform support Cross-platform

Wild Bits is a graphical frontend for several tools in the oead Python library and the MSYT editor for MSBTs.

Setup

  1. 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.
  2. (Optional) For best results on Windows, install cefpython3. [CLI help]
  3. Install the wildbits package. [CLI help]

Usage

Wild Bits UI preview.png

Wild Bits can be launched with the wildbits command.[help] A desktop shortcut can also be made pointing to the executable in Python's Scripts 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 if the file extension begins with .s.

For more details on using Wild Bits, see the readme on GitHub.

Known issues

On some system configurations, launching with wildbits doesn't work and you must use python -m wildbits instead.

Retrieved from "https://zeldamods.org/w_botw/index.php?title=Help:Tools/Wild_Bits&oldid=10849"