Help:Tools/botwfstools: Difference between revisions

no edit summary
imported>Leoetlino
No edit summary
imported>Leoetlino
No edit summary
Line 1: Line 1:
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).
[[Category:Tools]]
{{Tool infobox
| name = botwfstools
| authors = leoetlino
| source = https://github.com/leoetlino/botwfstools
| license = GPLv3
| written_in = Python
| win_only =
}}
 
'''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:
botwfstools intends to address these issues with a series of tools that help the user:
Line 6: Line 18:
* edit files more easily by automatically repacking archives and editing the RSTB as needed.
* edit files more easily by automatically repacking archives and editing the RSTB as needed.


== Requirements ==
== Setup ==
* Python 3.6+ (see [[Help:Setting up tools]] for help)
# Install Python 3.6+ (see [[Help:Setting up tools]] for help)
* [https://github.com/fusepy/fusepy fusepy] 3.0+: install the [https://github.com/fusepy/fusepy/archive/master.zip <code>https://github.com/fusepy/fusepy/archive/master.zip</code>] package{{Install py package help|package=https://github.com/fusepy/fusepy/archive/master.zip}}
# Install fusepy 3.0+: install the [https://github.com/fusepy/fusepy/archive/master.zip <code>https://github.com/fusepy/fusepy/archive/master.zip</code>] package{{Install py package help|package=https://github.com/fusepy/fusepy/archive/master.zip}}
* [http://www.secfs.net/winfsp/download/ WinFsp] if you're on Windows
# If you're on Windows, install [http://www.secfs.net/winfsp/download/ WinFsp]
* [https://github.com/leoetlino/botwfstools botwfstools]: install the <code>botwfstools</code> package{{Install py package help|package=botwfstools}}
# Install the <code>botwfstools</code> package{{Install py package help|package=botwfstools}}


== Instructions ==
== Usage ==
Usage instructions can be found in the [https://github.com/leoetlino/botwfstools#quick-usage botwfstools] repository.
Usage instructions can be found in the [https://github.com/leoetlino/botwfstools#quick-usage botwfstools] repository.


[[Category:Guides]]
== Known issues ==
[[Category:Guides (tools)]]
* '''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.
Anonymous user