Help:Tools/botwfstools

botwfstools

Author(s)	leoetlino
Source code	https://github.com/leoetlino/botwfstools
License	GPLv2+
Written in	Python
Platform support	Cross-platform

botwfstools is a toolset that makes accessing and editing the game ROM easier.

Indeed, a common operation when exploring and modifying BotW's content is manipulating SARC archives (unpacking and repacking), which quickly becomes tedious and annoying. Resource system internals also cause most resource changes to require an update to the resource size table (RSTB).

botwfstools intends to address these issues with a series of tools that help the user:

• avoid clobbering their game dump (without the need to keep space-wasting backups)
• explore and modify content files by exposing archives as simple directories
• edit files more easily by automatically repacking archives and editing the RSTB as needed.

Setup

1. Install Python 3.6+ (see Help:Setting up tools for help)
2. Install fusepy 3.0+: install the https://github.com/fusepy/fusepy/archive/master.zip package^{[CLI help]}
3. If you're on Windows, install WinFsp
4. Install the botwfstools package^{[CLI help]}

Usage

Usage instructions can be found in the botwfstools repository.

Known issues

• Platform limitations: On Windows, strange errors may happen with botw-contentfs. This is unfortunately caused by Windows limitations; nothing that can be fixed by the tool author. For full functionality and better performance in general, it is recommended to use Linux.