View source for Command Line Tools

== Introduction ==
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>).

== List of Tools ==
{| class="wikitable"
!Tool
!Purpose
|-
|AnimJSONConverter
|Converts .saanim files to .json and vice versa
|-
|ArchiveTool
|Extracts and builds PVM/GVM/PRS/DAT and other archives, extracts PB archives
|-
|buildEvent
|Builds SA2 event files
|-
|buildMDL
|Builds SA2 MDL files
|-
|buildMiniEvent
|Builds SA2 in-level cutscenes
|-
|buildMTN
|Builds SA2 MTN files
|-
|BuildShapeMotion
|Creates Ninja Shape animations
|-
|ModelConverter
|Converts .sa1mdl files to .sa2mdl and vice versa
|-
|ModelRelabeler
|Copies [[labels]] from one model file to another
|-
|PAKTool
|Extracts and builds .PAK archives
|-
|SETCodeGenerator
|Creates object loading code from a SET file and an object list
|-
|split
|Extracts data from [[Binary Files|binary files]]
|-
|splitEvent
|Extracts data from SA2 event files
|-
|splitMiniEvent
|Extracts data from SA2 in-level cutscenes
|-
|splitMTN
|Extracts data from SA2 MTN files
|-
|splitShapeMotion
|Extracts data from Ninja Shape animations
|-
|TextureRemap
|Remaps texture IDs in a model file
|-
|WeldConverter
|Converts a model's vertex welds to a custom weight format
|}

== 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:
[[File:107878433-fd52f200-6f15-11eb-9f5b-e90d351286ab.png|none|thumb]]

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]]

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:

[[File:107878688-b960ec80-6f17-11eb-984f-3391717597bc.png|frameless|600x600px]]

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.

[[File:107878787-368c6180-6f18-11eb-87df-40be3f53b01c.png|frameless|600x600px]]

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

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