Help:Tools/Wild Bits

From ZeldaMods (Breath of the Wild)
< Help:Setting up tools
Revision as of 01:41, 10 July 2020 by NiceneNerd (talk | contribs) (→‎Usage)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search
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.