Command Line Tools - Revision history

PkR at 05:44, 12 January 2026

2026-01-12T05:44:18Z

← Older revision		Revision as of 05:44, 12 January 2026
Line 10:		Line 10:
	\|-		\|-
	\|AnimJSONConverter		\|AnimJSONConverter
	\|Converts .saanim files to .json and vice versa		\|Converts .saanim files to .json and vice versa.
	\|-		\|-
	\|ArchiveTool		\|ArchiveTool
	\|Extracts and builds PVM/GVM/PRS/DAT and other archives, extracts PB archives		\|Extracts and builds PVM/GVM/PRS/DAT and other archives, extracts PB archives.
	\|-		\|-
	\|buildEvent		\|buildEvent
	\|Builds SA2 event files		\|Builds SA2 event files.
	\|-		\|-
	\|buildMDL		\|buildMDL
	\|Builds SA2 MDL files		\|Builds SA2 MDL files.
	\|-		\|-
	\|buildMiniEvent		\|buildMiniEvent
	\|Builds SA2 in-level cutscenes		\|Builds SA2 in-level cutscenes.
	\|-		\|-
	\|buildMTN		\|buildMTN
	\|Builds SA2 MTN files		\|Builds SA2 MTN files.
	\|-		\|-
	\|BuildShapeMotion		\|BuildShapeMotion
	\|Creates Ninja Shape animations		\|Creates Ninja Shape animations.
	\|-		\|-
	\|ModelConverter		\|ModelConverter
	\|Converts .sa1mdl files to .sa2mdl and vice versa		\|Converts .sa1mdl files to .sa2mdl and vice versa.
	\|-		\|-
	\|ModelRelabeler		\|ModelRelabeler
	\|Copies [[labels]] from one model file to another		\|Copies [[labels]] from one model file to another.
	\|-		\|-
	\|PAKTool		\|PAKTool
	\|Extracts and builds .PAK archives		\|Extracts and builds .PAK archives.
			This tool is superseded by ArchiveTool and is only provided for testing purposes.
	\|-		\|-
	\|SETCodeGenerator		\|SETCodeGenerator
	\|Creates object loading code from a SET file and an object list		\|Creates object loading code from a SET file and an object list.
	\|-		\|-
	\|split		\|split
	\|Extracts data from [[Binary Files\|binary files]]		\|Extracts data from [[Binary Files\|binary files]].
	\|-		\|-
	\|splitEvent		\|splitEvent
	\|Extracts data from SA2 event files		\|Extracts data from SA2 event files.
	\|-		\|-
	\|splitMiniEvent		\|splitMiniEvent
	\|Extracts data from SA2 in-level cutscenes		\|Extracts data from SA2 in-level cutscenes.
	\|-		\|-
	\|splitMTN		\|splitMTN
	\|Extracts data from SA2 MTN files		\|Extracts data from SA2 MTN files.
	\|-		\|-
	\|splitShapeMotion		\|splitShapeMotion
	\|Extracts data from Ninja Shape animations		\|Extracts data from Ninja Shape animations.
	\|-		\|-
	\|TextureRemap		\|TextureRemap
	\|Remaps texture IDs in a model file		\|Remaps texture IDs in a model file.
			\|-
			\|TextureTool
			\|Encodes and decodes texture files in all formats supported by SA Tools.
	\|-		\|-
	\|WeldConverter		\|WeldConverter
	\|Converts a model's vertex welds to a custom weight format		\|Converts a model's vertex welds to a custom weight format.
	\|}		\|}

Line 69:		Line 73:

	Go to System Properties, Advanced and Click "Environment Variables...". You will see the following window:		Go to System Properties, Advanced and Click "Environment Variables...". You will see the following window:
	[[File:107878433-fd52f200-6f15-11eb-9f5b-e90d351286ab.png\|none\|thumb]]		[[File:107878433-fd52f200-6f15-11eb-9f5b-e90d351286ab.png\|none\|thumb\|Environment Variables window]]

	Select <code>Path</code> in in User Variables and click "Edit...". Then click New and type the location of your SA Tools' <code>bin</code> folder. Example:		Select <code>Path</code> in in User Variables and click "Edit...". Then click New and type the location of your SA Tools' <code>bin</code> folder. Example:
	[[File:107878513-8b2edd00-6f16-11eb-89bf-7fe910793324.png\|none\|thumb]]		[[File:107878513-8b2edd00-6f16-11eb-89bf-7fe910793324.png\|none\|thumb\|Adding an environment variable]]

	You can now run the tools from any folder in the command prompt.		You can now run the tools from any folder in the command prompt.

End User at 23:32, 29 October 2025

2025-10-29T23:32:49Z

← Older revision		Revision as of 23:32, 29 October 2025
Line 95:		Line 95:

	[[File:107878816-69cef080-6f18-11eb-8832-b8d721c2f966.png\|frameless\|600x600px]]		[[File:107878816-69cef080-6f18-11eb-8832-b8d721c2f966.png\|frameless\|600x600px]]

			{{SAToolsNavbox}}

PkR at 05:18, 6 October 2025

2025-10-06T05:18:16Z

← Older revision		Revision as of 05:18, 6 October 2025
Line 4:		Line 4:
	These tools are located in <code>SA Tools\bin</code>. They are meant to be used with Windows Terminal or the command prompt (<code>cmd.exe</code>).		These tools are located in <code>SA Tools\bin</code>. They are meant to be used with Windows Terminal or the command prompt (<code>cmd.exe</code>).

	== List of ~~tools~~ ==		== List of Tools ==
	{\| class="wikitable"		{\| class="wikitable"
	!Tool		!Tool
Line 64:		Line 64:
	\|}		\|}

	== Adding the PATH ~~environment variable~~ ==		== Adding the PATH Environment Variable ==

	To make using command line tools easier, add the <code>bin</code> folder to your system <code>PATH</code> environment variable.		To make using command line tools easier, add the <code>bin</code> folder to your system <code>PATH</code> environment variable.

	Go to System Properties, Advanced and Click "Environment Variables...". You will see the following window:		Go to System Properties, Advanced and Click "Environment Variables...". You will see the following window:
			[[File:107878433-fd52f200-6f15-11eb-9f5b-e90d351286ab.png\|none\|thumb]]
	[[File:107878433-fd52f200-6f15-11eb-9f5b-e90d351286ab.png]]

	Select <code>Path</code> in in User Variables and click "Edit...". Then click New and type the location of your SA Tools' <code>bin</code> folder. Example:		Select <code>Path</code> in in User Variables and click "Edit...". Then click New and type the location of your SA Tools' <code>bin</code> folder. Example:
			[[File:107878513-8b2edd00-6f16-11eb-89bf-7fe910793324.png\|none\|thumb]]
	[[File:107878513-8b2edd00-6f16-11eb-89bf-7fe910793324.png]]

	You can now run the tools from any folder in the command prompt.		You can now run the tools from any folder in the command prompt.
	== Examples and ~~usage~~ ==		== Examples and Usage ==
	One way to launch the command prompt in the folder you need is opening the folder in Explorer and typing <code>cmd</code> in the address bar:		One way to launch the command prompt in the folder you need is opening the folder in Explorer and typing <code>cmd</code> in the address bar:

PkR at 07:47, 3 October 2025

2025-10-03T07:47:13Z

← Older revision		Revision as of 07:47, 3 October 2025
Line 1:		Line 1:
	== Introduction ==		== Introduction ==
	In addition to GUI tools like Texture Editor and SAMDL, SA Tools include several command line tools useful for scripting and other purposes.		In addition to GUI tools like [[Texture Editor]] and [[SAMDL]], [[SA Tools]] include several command line tools useful for scripting and other purposes.

	These tools are located in <code>SA Tools\bin</code>. They are meant to be used with Windows Terminal or the command prompt (<code>cmd.exe</code>).		These tools are located in <code>SA Tools\bin</code>. They are meant to be used with Windows Terminal or the command prompt (<code>cmd.exe</code>).

PkR at 07:46, 3 October 2025

2025-10-03T07:46:41Z

@@ Line 1: / Line 1: @@
-In addition to GUI tools like Texture Editor and SAMDL, SA Tools include several command line tools useful for scripting and other purposes. These tools are located in <code>SA Tools\bin</code>. The <code>bin</code> folder contains a readme file with a brief overview of all command line tools.
+== Introduction ==
-== Adding the PATH environment variable ==
+These tools are located in <code>SA Tools\bin</code>. They are meant to be used with Windows Terminal or the command prompt (<code>cmd.exe</code>).
-To make using command line tools easier, add the <code>bin</code> folder to your system <code>PATH</code> environment variable. Go to System Properties, Advanced and Click "Environment Variables...". You will see the following window:
+== List of tools ==
-![https://user-images.githubusercontent.com/23312549/107878433-fd52f200-6f15-11eb-9f5b-e90d351286ab.png Environment Variables]
+To make using command line tools easier, add the <code>bin</code> folder to your system <code>PATH</code> environment variable.
-Select <code>Path</code> in in User Variables and click "Edit...". The click New and type the location of your SA Tools' <code>bin</code> folder. Example:
+Go to System Properties, Advanced and Click "Environment Variables...". You will see the following window:
-![https://user-images.githubusercontent.com/23312549/107878513-8b2edd00-6f16-11eb-89bf-7fe910793324.png Add New Environment Variable]
+Select <code>Path</code> in in User Variables and click "Edit...". Then click New and type the location of your SA Tools' <code>bin</code> folder. Example:
 You can now run the tools from any folder in the command prompt.
 == Examples and usage ==
 One way to launch the command prompt in the folder you need is opening the folder in Explorer and typing <code>cmd</code> in the address bar:
 Hit Enter and you can now use the command line tools in this folder:
+[[File:107878729-eca37b80-6f17-11eb-9ff4-4f1356a096af.png|frameless|600x600px]]
 To learn how to use a specific tool, run it without command line arguments.
 Example: Scanning SA1 STG01.PRS for levels and models using the Object Scanner. Type the following in the command prompt and press Enter:
- <code>objscan SA1 STG01.PRS C900000 all</code>
+Note: the file <code>STG01.PRS</code> must exist in the folder you're running the command in (<code>D:\test</code> in this example).
-![https://user-images.githubusercontent.com/23312549/107878816-69cef080-6f18-11eb-8832-b8d721c2f966.png ObjScan example 2]
+[[File:107878816-69cef080-6f18-11eb-8832-b8d721c2f966.png|frameless|600x600px]]

PkR: Created page with "In addition to GUI tools like Texture Editor and SAMDL, SA Tools include several command line tools useful for scripting and other purposes. These tools are located in `SA Tools\bin`. The `bin` folder contains a readme file with a brief overview of all command line tools. == Adding the PATH environment variable == To make using command line tools easier, add the `bin` folder to your system `PATH` environment variable. Go to S..."

2025-10-03T07:36:58Z

Created page with "In addition to GUI tools like Texture Editor and SAMDL, SA Tools include several command line tools useful for scripting and other purposes. These tools are located in <code>SA Tools\bin</code>. The <code>bin</code> folder contains a readme file with a brief overview of all command line tools. == Adding the PATH environment variable == To make using command line tools easier, add the <code>bin</code> folder to your system <code>PATH</code> environment variable. Go to S..."

New page

In addition to GUI tools like Texture Editor and SAMDL, SA Tools include several command line tools useful for scripting and other purposes. These tools are located in <code>SA Tools\bin</code>. The <code>bin</code> folder contains a readme file with a brief overview of all command line tools.

== Adding the PATH environment variable ==

To make using command line tools easier, add the <code>bin</code> folder to your system <code>PATH</code> environment variable. Go to System Properties, Advanced and Click "Environment Variables...". You will see the following window:

![https://user-images.githubusercontent.com/23312549/107878433-fd52f200-6f15-11eb-9f5b-e90d351286ab.png Environment Variables]

Select <code>Path</code> in in User Variables and click "Edit...". The click New and type the location of your SA Tools' <code>bin</code> folder. Example:

![https://user-images.githubusercontent.com/23312549/107878513-8b2edd00-6f16-11eb-89bf-7fe910793324.png Add New Environment Variable]

You can now run the tools from any folder in the command prompt.

== Examples and usage ==
One way to launch the command prompt in the folder you need is opening the folder in Explorer and typing <code>cmd</code> in the address bar:

![https://user-images.githubusercontent.com/23312549/107878688-b960ec80-6f17-11eb-984f-3391717597bc.png Typing CMD]
Hit Enter and you can now use the command line tools in this folder:

![https://user-images.githubusercontent.com/23312549/107878729-eca37b80-6f17-11eb-9ff4-4f1356a096af.png Command Prompt]

To learn how to use a specific tool, run it without command line arguments.
![https://user-images.githubusercontent.com/23312549/107878787-368c6180-6f18-11eb-87df-40be3f53b01c.png ObjScan example]

Example: Scanning SA1 STG01.PRS for levels and models using the Object Scanner. Type the following in the command prompt and press Enter:

<code>objscan SA1 STG01.PRS C900000 all</code>

Note: the file STG01.PRS must exist in the folder you're running the command in (<code>D:\test</code> in this example).

![https://user-images.githubusercontent.com/23312549/107878816-69cef080-6f18-11eb-8832-b8d721c2f966.png ObjScan example 2]