Tools Overview - X-Hax/sa_tools GitHub Wiki
Below you will find a general overview for all tools included in the SA Tools package. If a tool has a dedicated wiki page to its usage, links will be included in the tool description.
Filename: SA Tools/SAToolsHub.exe
Description: Primary tool used for creating projects. Contains shortcuts to all other GUI tools.
Usage Guide
Filename: SA Tools/tools/SALVL.exe
Description: Level viewer and editor for both titles. Currently only full support for SADX PC. This does not include a model editor in the sense of ediitng mesh data
Usage Guide
Filename: SA Tools/tools/SAMDL.exe
Description: Model viewer and object element editor for both titles. This is not a model editor in the sense of editing mesh data.
Usage Guide
Filename: SA Tools/tools/TextureEditor.exe
Description: Texture Archive Editor for both titles. This is not an image editor.
Usage: TBD
Filename: SA Tools/tools/Datatoolbox.exe
Description: General use "toolbox" for extracting assets, converting files to C code, or splitting data using the split mapping or SA2 Model/Motion archives.
Usage Guide
Filename: SA Tools/tools/PLTool.exe
Description: Lantern Engine PL/SL File Editor.
Usage Guide
Filename: SA Tools/tools/SADXTweaker2.exe
Description: General Editor for a variety of data in SADX PC.
Usage: TBD
Filename: SA Tools/tools/SADXFontEdit.exe
Description: Editor for changing the look of the fonts in SADX PC.
Usage: TBD
Filename: SA Tools/tools/SADXsndSharp.exe
Description: Tool for extracting or modifying sound archives used in SADX PC.
Usage: TBD
Filename: SA Tools/tools/SASave.exe
Description: Save Editor for SA1/SADX (GC)/SADX (PC).
Usage: TBD
Filename: SA Tools/tools/SA2CutsceneTextEditor.exe
Description: Editor for cutscene text within SA2.
Usage: TBD
Filename: SA Tools/tools/SA2MessageFileEditor.exe
Description: Editor for Hint Messages in SA2.
Usage: TBD
Filename: SA Tools/SA2StageSelEdit.exe
Description: Editor for the Stage Select map in SA2.
Usage: TBD
Filename: SA Tools/tools/SA2EventViewer.exe
Description: Viewer for SA2 Event Files. This is not an editor for cutscenes in SA2.
Usage: TBD
Filename: SA Tools/tools/VMSEditor.exe
Description: Tool for viewing and editing VMS Data.
Usage Guide
Filename: SA Tools/bin/split.exe
Description: Tool used for splitting game data using .ini mapping files.
Usage:
Split any binary files supported by SA Tools.
-Splitting using an XML template-
split template <xmlfile> [-data sourcepath] [output path]
-Splitting a binary file with INI data-
split binary <file> <inifile> [output path]
-Splitting a single item from a binary file without INI data-
split single <game> <file> <key> <address> <type> [output filename] [-p custom properties] [-name entryName]
-Splitting an NB file-
split nb <file> [output path] [-ini split ini file]
-Splitting SA2 MDL files-
split mdl <file> [output path] [-anim animation files]
-Splitting SA2B MDL files-
split mdl_b <file> [output path] [-anim animation files]
-Splitting dllexport entries from DLL files-
split dllexport <file> <type> <name> [-id array ID] [output path] [-p numparts]
Common switches: [-nometa], [-nolabel]
Filename: SA Tools/tools/splitMDL.exe
Description: Splits SA2 MDL Archives.
Usage: Double clicking will open a GUI to use for splitting archives, otherwise dragging and dropping mdl archives (ex. sonicmdl.prs) onto the exe will split the archive.
Filename: SA Tools/bin/buildMDL
Description: Builds SA2 MDL Archives.
Usage: Drag and drop a folder created by splitMDL to create a new MDL archive.
Filename: SA Tools/bin/splitMTN.exe
Description: Splits SA2 MTN Archives.
Usage: Drag and drop an mtn archive (ex. sonicmtn.prs) onto the exe to split the archive.
Filename: SA Tools/bin/buildMTN.exe
Description: Builds SA2 MTN Archives.
Usage: Drag and drop a folder created by splitMTN to create a new MTN archive.
Filename: SA Tools/bin/splitEvent.exe
Description: Splits SA2 Event Archives.
Usage: Drag and drop an SA2 Event archive (ex. event/e0000.prs) onto the exe will split the archive.
Filename: SA Tools/bin/buildEvent.exe
Description: Builds SA2 Event Archives.
Usage: Drag and drop a folder created by splitEvent to create a new SA2 Event archive.
Filename: SA Tools/bin/splitMiniEvent.exe
Description: Splits SA2 Mini Event Archives.
Usage: TBD
Filename: SA Tools/bin/buildMiniEvent.exe
Description: Builds SA2 Mini Event Archives.
Usage: TBD
Filename: SA Tools/bin/SplitShapeMotion.exe
Description: Splits Shape Motions into separate *mdl files from a .saanim file and corresponding *mdl file.
Usage:
Base Model: [*.sa1mdl/*.sa2mdl reference file]
Motion: [*.saanim shape motion file]
Filename: SA Tools/bin/BuildShapeMotion.exe
Description: Builds Shape Motions into a Shape Motion .saanim file.
Usage: Drag and drop a folder created by SplitShapeMotion to create a new *.saanim shape motion.
Filename: SA Tools/bin/ArchiveTool.exe
Description: Opens various archives and outputs their contents.
Usage:
ArchiveTool is a command line tool to extract and create archives in various formats used in SA1/2.
Usage:
Extracting a PVM/GVM/PRS/PB/PVMX/DAT/PAK/REL file:
ArchiveTool <archivefile>
If the archive is PRS compressed, it will be decompressed first.
If the archive contains textures/sounds, the program will extract them and create index file(s).
Extracting an NjUtil archive: ArchiveTool -nju <archivefile>
Converting a PVM/GVM to a folder texture pack (PVM2TexPack mode): ArchiveTool -png <archivefile>
Converting GVM to PVM (lossy): ArchiveTool -gvm2pvm <file.gvm> [-prs]
Creating a PVM from a folder texture pack (CompilePVM mode): ArchiveTool -pvm <folder> [-prs]
The texture list 'index.txt' must contain global indices listed before each texture filename for this option to work.
Creating a PVM/GVM/DAT/PB/PVMX/PAK from a folder with textures/sounds: ArchiveTool <foldername> [-pb] [-prs]
Only PVR and GVR textures can be used for PVMs/GVMs in this mode.
The program will create an archive from files listed in 'index.txt' (or INI file for PAK) in the folder.
The -prs option will make the program output a PRS compressed archive.
The -pb option will make it output a PB archive instead of PVM.
Creating a PRS compressed binary: ArchiveTool <file.bin>
File extension must be .BIN for this option to work.
Filename: SA Tools/bin/PAKTool.exe
Description: Splits or Builds .pak files used in SA2PC.
Usage:
paktool [Arguments] (file)
Arguments:
/? Show this help.
/t filename Reads text file filename as a commandline.
/u filename Extracts files from an archive.
/p filename Packs files into an archive.
Filename: SA Tools/bin/AnimJSONConverter.exe
Description: Converts .saanim files to .json and vice versa.
Usage: Double clicking on the executable will open a file dialog where *.saanim or *.json can be selected.
Filename: SA Tools/bin/LevelConverter.exe
Description: Converts levels between the SA1 and SA2 formats.
Usage: Drag and drop a *lvl file on the executable to convert it to the opposite format.
Filename: SA Tools/bin/ModelConverter.exe
Description: Converts Models between SA1 and SA2 formats.
Usage: Drag and drop a *mdl file on the executable to convert it to the opposite format.
Filename: SA Tools/bin/ModelRelabeler.exe
Description: Transfers labels from one model file to another.
Usage:
New Model File: [destination file to receive labels]
Old Model File: [source file from where to take the labels from]
Filename: SA Tools/bin/TextureRemap.exe
Description: Remaps textures in an *mdl file.
Usage: TBD