Help:Tools/botwfstools - Revision history

PeregrineHBG: /* Setup */

2025-08-13T17:39:11Z

Setup

← Older revision		Revision as of 17:39, 13 August 2025
Line 21:		Line 21:
	# Install Python 3.6+ (see [[Help:Setting up tools]] for help)		# Install Python 3.6+ (see [[Help:Setting up tools]] for help)
	# Install the <code>fusepy</code> package{{Install py package help\|package=fusepy}}		# 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]		# If you're on Windows, install [https://winfsp.dev/ WinFsp]
	# Install the <code>botwfstools</code> package{{Install py package help\|package=botwfstools}}		# Install the <code>botwfstools</code> package{{Install py package help\|package=botwfstools}}

imported>Leoetlino: fusepy 3.0 is now published on pypi

2018-12-01T21:25:39Z

fusepy 3.0 is now published on pypi

← Older revision		Revision as of 21:25, 1 December 2018
Line 20:		Line 20:
	== Setup ==		== Setup ==
	# Install Python 3.6+ (see [[Help:Setting up tools]] for help)		# Install Python 3.6+ (see [[Help:Setting up tools]] for help)
	# 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~~}}		# 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]		# 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}}		# Install the <code>botwfstools</code> package{{Install py package help\|package=botwfstools}}

imported>Leoetlino: whoops. GPLv3 -> GPLv2+

2018-10-21T14:56:01Z

whoops. GPLv3 -> GPLv2+

← Older revision		Revision as of 14:56, 21 October 2018
Line 4:		Line 4:
	\| authors = leoetlino		\| authors = leoetlino
	\| source = https://github.com/leoetlino/botwfstools		\| source = https://github.com/leoetlino/botwfstools
	\| license = ~~GPLv3~~		\| license = GPLv2+
	\| written_in = Python		\| written_in = Python
	\| win_only =		\| win_only =

imported>Leoetlino: Leoetlino moved page Help:Setting up botwfstools to Help:Tools/botwfstools

2018-10-21T08:21:58Z

Leoetlino moved page Help:Tools/botwfstools to Help:Tools/botwfstools

← Older revision	Revision as of 08:21, 21 October 2018
(No difference)

imported>Leoetlino at 08:21, 21 October 2018

2018-10-21T08:21:47Z

← Older revision		Revision as of 08:21, 21 October 2018
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.

imported>Leoetlino at 19:12, 16 September 2018

2018-09-16T19:12:08Z

← Older revision		Revision as of 19:12, 16 September 2018
Line 16:		Line 16:

	[[Category:Guides]]		[[Category:Guides]]
			[[Category:Guides (tools)]]

imported>Leoetlino: /* Requirements */

2018-09-14T21:43:13Z

Requirements

← Older revision		Revision as of 21:43, 14 September 2018
Line 10:		Line 10:
	* [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}}		* [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}}
	* [http://www.secfs.net/winfsp/download/ WinFsp] if you're on Windows		* [http://www.secfs.net/winfsp/download/ WinFsp] if you're on Windows
	* [https://github.com/leoetlino/botwfstools botwfstools]: install the <code>botwfstools</code> package{{Install py package help}}		* [https://github.com/leoetlino/botwfstools botwfstools]: install the <code>botwfstools</code> package{{Install py package help\|package=botwfstools}}

	== Instructions ==		== Instructions ==

imported>Leoetlino at 21:42, 14 September 2018

2018-09-14T21:42:44Z

← Older revision		Revision as of 21:42, 14 September 2018
Line 2:		Line 2:

	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 ~~your~~ game dump (without the need to keep space-wasting backups)		* 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.

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..."

2018-09-14T21:42:03Z

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..."

New page

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 your 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.

== Requirements ==
* 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}}
* [http://www.secfs.net/winfsp/download/ WinFsp] if you're on Windows
* [https://github.com/leoetlino/botwfstools botwfstools]: install the <code>botwfstools</code> package{{Install py package help}}

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

[[Category:Guides]]