Help:Setting up tools - Revision history

Leoetlino: /* Common requirements */ Python 3.9 incompatibility

2020-11-05T16:31:46Z

Common requirements: Python 3.9 incompatibility

← Older revision		Revision as of 16:31, 5 November 2020
Line 16:		Line 16:

	If you have any trouble installing Python, or need more detailed instructions, you can use [https://www.youtube.com/watch?v=ndrCfBJkkvE this video tutorial].		If you have any trouble installing Python, or need more detailed instructions, you can use [https://www.youtube.com/watch?v=ndrCfBJkkvE this video tutorial].
			}}

			{{alert\|class=warning\|text=Several tools and libraries (e.g. oead) are not compatible with Python 3.9 yet [https://bugs.python.org/issue41237 because of CPython issue #41237]. 3.9 compatibility will be added when Python 3.9.1 is released with the bug fix, which is due to happen in December 2020.
	}}		}}

NiceneNerd: Correct Python installer link

2020-09-18T19:05:54Z

Correct Python installer link

← Older revision		Revision as of 19:05, 18 September 2020
Line 11:		Line 11:
	On Windows, follow the below instructions to install Python:		On Windows, follow the below instructions to install Python:
	# Uninstall any existing Python version to avoid conflicts.		# Uninstall any existing Python version to avoid conflicts.
	# Download the [https://www.python.org/ftp/python/3.7.4/python-3.7.4.exe Python 3.7 installer] (latest version as of July 2019).		# Download the [https://www.python.org/ftp/python/3.7.7/python-3.7.7-amd64.exe Python 3.7 installer] (latest version as of July 2019).
	# Run the installer: do a ''system-wide install'' and tick the "''add Python to environment variables / PATH''" option. Note that if you install to the Program Files folder, you may occasionally run into permission issues with certain Python programs. To avoid this, install Python somewhere that does not require administrator permissions, such as <code>C:\Python37</code>.		# Run the installer: do a ''system-wide install'' and tick the "''add Python to environment variables / PATH''" option. Note that if you install to the Program Files folder, you may occasionally run into permission issues with certain Python programs. To avoid this, install Python somewhere that does not require administrator permissions, such as <code>C:\Python37</code>.
	# Verify that <code>py -3 --version</code> works and gives the correct version (3.7 or higher). {{CLI help}}		# Verify that <code>py -3 --version</code> works and gives the correct version (3.7 or higher). {{CLI help}}

CEObrainz: /* MSBT */

2020-09-02T10:26:07Z

MSBT

← Older revision		Revision as of 10:26, 2 September 2020
Line 63:		Line 63:

	=== MSBT ===		=== MSBT ===
	[[MSBT]] files contain game texts. Convert them to an editable YAML format (and back) with {{ltool\|msyt}} or (built on top of msyt) [https://github.com/polarbunny/msyt-tools msyt-tools].		[[MSBT]] files contain game texts. Convert them to an editable YAML format (and back) with {{ltool\|msyt}} or (built on top of msyt) [https://github.com/polarbunny/msyt-tools msyt-tools]. Wild Bits also provides a GUI frontend for msbt.

	== Reverse engineering ==		== Reverse engineering ==

imported>Leoetlino: mention the DLL ImportError for search purposes

2020-01-06T20:32:37Z

mention the DLL ImportError for search purposes

← Older revision		Revision as of 20:32, 6 January 2020
Line 20:		Line 20:
	=== For Windows users: Visual C++ redistributable for Visual Studio 2019 ===		=== For Windows users: Visual C++ redistributable for Visual Studio 2019 ===
	Several tools require the [https://aka.ms/vs/16/release/vc_redist.x64.exe 64-bit Visual C++ redistributable for Visual Studio 2019] to be installed. To be clear, Visual Studio is '''not''' required.		Several tools require the [https://aka.ms/vs/16/release/vc_redist.x64.exe 64-bit Visual C++ redistributable for Visual Studio 2019] to be installed. To be clear, Visual Studio is '''not''' required.

			Failure to install the redistributable will cause several Python tools to fail with the error "ImportError: DLL load failed".

	== Tools ==		== Tools ==

imported>Leoetlino: /* Common requirements */ Visual C++ redist

2020-01-01T22:05:02Z

Common requirements: Visual C++ redist

← Older revision		Revision as of 22:05, 1 January 2020
Line 17:		Line 17:
	If you have any trouble installing Python, or need more detailed instructions, you can use [https://www.youtube.com/watch?v=ndrCfBJkkvE this video tutorial].		If you have any trouble installing Python, or need more detailed instructions, you can use [https://www.youtube.com/watch?v=ndrCfBJkkvE this video tutorial].
	}}		}}

			=== For Windows users: Visual C++ redistributable for Visual Studio 2019 ===
			Several tools require the [https://aka.ms/vs/16/release/vc_redist.x64.exe 64-bit Visual C++ redistributable for Visual Studio 2019] to be installed. To be clear, Visual Studio is '''not''' required.

	== Tools ==		== Tools ==

imported>NiceneNerd: More minor Python edits

2019-07-26T14:02:14Z

More minor Python edits

← Older revision		Revision as of 14:02, 26 July 2019
Line 12:		Line 12:
	# Uninstall any existing Python version to avoid conflicts.		# Uninstall any existing Python version to avoid conflicts.
	# Download the [https://www.python.org/ftp/python/3.7.4/python-3.7.4.exe Python 3.7 installer] (latest version as of July 2019).		# Download the [https://www.python.org/ftp/python/3.7.4/python-3.7.4.exe Python 3.7 installer] (latest version as of July 2019).
	# Run the installer: do a ''system-wide install'' and tick the "''add Python to environment variables / PATH''" option.		# Run the installer: do a ''system-wide install'' and tick the "''add Python to environment variables / PATH''" option. Note that if you install to the Program Files folder, you may occasionally run into permission issues with certain Python programs. To avoid this, install Python somewhere that does not require administrator permissions, such as <code>C:\Python37</code>.
	# Verify that <code>py -3 --version</code> works and gives the correct version (3.7 or higher). {{CLI help}}		# Verify that <code>py -3 --version</code> works and gives the correct version (3.7 or higher). {{CLI help}}

imported>NiceneNerd: /* Python */

2019-07-26T13:59:57Z

Python

← Older revision		Revision as of 13:59, 26 July 2019
Line 11:		Line 11:
	On Windows, follow the below instructions to install Python:		On Windows, follow the below instructions to install Python:
	# Uninstall any existing Python version to avoid conflicts.		# Uninstall any existing Python version to avoid conflicts.
	# Download the [https://www.python.org/ftp/python/3.7.4/python-3.7.4.exe Python 3.7 installer] (latest version as of ~~September 2018~~).		# Download the [https://www.python.org/ftp/python/3.7.4/python-3.7.4.exe Python 3.7 installer] (latest version as of July 2019).
	# Run the installer: do a ''system-wide install'' and tick the "''add Python to environment variables / PATH''" option.		# Run the installer: do a ''system-wide install'' and tick the "''add Python to environment variables / PATH''" option.
	# Verify that <code>py -3 --version</code> works and gives the correct version (3.7 or higher). {{CLI help}}		# Verify that <code>py -3 --version</code> works and gives the correct version (3.7 or higher). {{CLI help}}

imported>NiceneNerd: Minor updates to Python installation instructions

2019-07-26T13:59:34Z

Minor updates to Python installation instructions

← Older revision		Revision as of 13:59, 26 July 2019
Line 3:		Line 3:
	== Common requirements ==		== Common requirements ==
	=== Python ===		=== Python ===
	Many of the tools for these formats require [[wikipedia:Python (programming language)\|Python]] 3.6+ ('''64 bit version''') to be installed.		Many of the tools for these formats require [[wikipedia:Python (programming language)\|Python]] 3.7+ ('''64 bit version''') to be installed.

	On Linux, Python 3 is surely already installed. Just make sure you have a recent enough version (3.6+). Ubuntu 16.04 and Debian stretch are too old; the latest Ubuntu LTS (18.04) and rolling distros such as Arch and Debian sid have 3.6+ in their repos.		On Linux, Python 3 is surely already installed. Just make sure you have a recent enough version (3.7+). Ubuntu 16.04 and Debian stretch are too old; the latest Ubuntu LTS (18.04) and rolling distros such as Arch and Debian sid have 3.7+ in their repos.

			{{alert\|class=primary\|text=<b><i class="fa fa-download"></i> Setup instructions</b>

	~~{{alert\|class=primary\|text=<b><i class="fa fa-download"></i> Setup instructions</b><br>~~
	On Windows, follow the below instructions to install Python:		On Windows, follow the below instructions to install Python:
	# Uninstall any existing Python version to avoid conflicts.		# Uninstall any existing Python version to avoid conflicts.
	# Download the [https://www.python.org/ftp/python/3.7.0/python-3.7.~~0-amd64~~.exe Python 3.7 installer] (latest version as of September 2018).		# Download the [https://www.python.org/ftp/python/3.7.4/python-3.7.4.exe Python 3.7 installer] (latest version as of September 2018).
	# Run the installer: do a ''system-wide install'' and tick the "''add Python to environment variables / PATH''" option.		# Run the installer: do a ''system-wide install'' and tick the "''add Python to environment variables / PATH''" option.
	# Verify that <code>py -3 --version</code> works and gives the correct version (3.6 or higher). {{CLI help}}		# Verify that <code>py -3 --version</code> works and gives the correct version (3.7 or higher). {{CLI help}}

			If you have any trouble installing Python, or need more detailed instructions, you can use [https://www.youtube.com/watch?v=ndrCfBJkkvE this video tutorial].
	}}		}}

imported>NiceneNerd at 02:33, 8 July 2019

2019-07-08T02:33:36Z

← Older revision		Revision as of 02:33, 8 July 2019
Line 53:		Line 53:

	For the second method, follow [https://gitlab.com/ice-spear-tools/ice-spear-builds the instructions in the official repo for Ice-Spear builds].		For the second method, follow [https://gitlab.com/ice-spear-tools/ice-spear-builds the instructions in the official repo for Ice-Spear builds].

			=== MSBT ===
			[[MSBT]] files contain game texts. Convert them to an editable YAML format (and back) with {{ltool\|msyt}} or (built on top of msyt) [https://github.com/polarbunny/msyt-tools msyt-tools].

	== Reverse engineering ==		== Reverse engineering ==

imported>NiceneNerd: Mention Wild Bits where relevant

2019-07-01T16:07:10Z

Mention Wild Bits where relevant

← Older revision		Revision as of 16:07, 1 July 2019
Line 20:		Line 20:

	=== AAMP ===		=== AAMP ===
	[[AAMP]] is used for configuration files, such as [[actor parameters]], the [[normal.bwinfo\|world configuration (climate, lighting, ...)]], etc. Convert them to an editable format (and back) with {{ltool\|aamp}}.		[[AAMP]] is used for configuration files, such as [[actor parameters]], the [[normal.bwinfo\|world configuration (climate, lighting, ...)]], etc. Convert them to an editable format (and back) with {{ltool\|aamp}}. {{ltool\|Wild Bits}} can also edit AAMP files.

	Note: Unlike most other files, AAMP files are exactly the same on both Wii U and Switch.		Note: Unlike most other files, AAMP files are exactly the same on both Wii U and Switch.

	=== BYML ===		=== BYML ===
	[[BYML]] files contain game parameters for [[actor]]s, [[map unit]]s, etc. Convert them to an editable format (and back) with {{ltool\|byml-v2}}.		[[BYML]] files contain game parameters for [[actor]]s, [[map unit]]s, etc. Convert them to an editable format (and back) with {{ltool\|byml-v2}}. {{ltool\|Wild Bits}} can also edit BYML files.

	=== BFRES ===		=== BFRES ===
Line 40:		Line 40:

	=== RSTB ===		=== RSTB ===
	[[ResourceSizeTable.product.rsizetable]] (known as the RSTB) contains sizes for almost every file in the game (calculated from the non-Yaz0-compressed file sizes). If you edit a file to make its filesize bigger, you'll need to edit this file to prevent errors. The recommended tool for manipulating the RSTB is {{ltool\|rstb}}.		[[ResourceSizeTable.product.rsizetable]] (known as the RSTB) contains sizes for almost every file in the game (calculated from the non-Yaz0-compressed file sizes). If you edit a file to make its filesize bigger, you'll need to edit this file to prevent errors. The recommended tool for manipulating the RSTB is {{ltool\|rstb}}. {{ltool\|Wild Bits}} also provides a GUI frontend for <code>rstb</code>.

	=== SARC ===		=== SARC ===
	[[SARC]] archives contain collections of other files and folders, like .zip folders.		[[SARC]] archives contain collections of other files and folders, like .zip folders.

	Use {{ltool\|sarc}} to create or modify archives.		Use {{ltool\|sarc}} to create or modify archives. {{ltool\|Wild Bits}} also provides a GUI frontend for <code>sarc</code>.

	=== Map units ===		=== Map units ===