Help:Tools/botwfstools: Difference between revisions
Jump to navigation
Jump to search
imported>Leoetlino (Created page with "A common operation when exploring and modifying BotW's content is manipulating SARC archives (unpacking and repacking), which quickly becomes tedious and annoying. Resou...") |
imported>Leoetlino (fusepy 3.0 is now published on pypi) |
||
| (6 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Tools]] | |||
{{Tool infobox | |||
| name = botwfstools | |||
| authors = leoetlino | |||
| source = https://github.com/leoetlino/botwfstools | |||
| license = GPLv2+ | |||
| 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: | ||
* avoid clobbering | * avoid clobbering their game dump (without the need to keep space-wasting backups) | ||
* explore and modify content files by exposing archives as simple directories | * 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. | * edit files more easily by automatically repacking archives and editing the RSTB as needed. | ||
== | == Setup == | ||
# Install Python 3.6+ (see [[Help:Setting up tools]] for help) | |||
# Install the <code>fusepy</code> package{{Install py package help|package=fusepy}} | |||
# If you're on Windows, install [http://www.secfs.net/winfsp/download/ WinFsp] | |||
# Install the <code>botwfstools</code> package{{Install py package help|package=botwfstools}} | |||
== | == 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. | ||
== 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. | |||
Latest revision as of 21:25, 1 December 2018
| 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
- Install Python 3.6+ (see Help:Setting up tools for help)
- Install the
fusepypackage[CLI help] - If you're on Windows, install WinFsp
- Install the
botwfstoolspackage[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.