View source for Ripping Assets

This guide explains how to use the [[SA Tools]] to extract assets from different versions of SA1/DX and SA2/B.

To get started, you need an image of the game you want to rip. Dreamcast games usually come in GDI and CDI formats, Gamecube games can be ISO or GCM. For PC, an installed copy of the game is fine.

== Supported games ==
There are many different builds and regional revisions of the games. At the moment the tools support only specific versions of the games. Also, for each game we have a "main" version which has the most assets mapped out, and additional templates for other versions which are used for research purposes. If you're looking to get the most complete asset rip of SA1/DX or SA2/B, you need to get the "main" version of the game as follows.

'''Where and how to get the correct version is up to you. Please do not ask us for copies of the games or ripped assets from them.'''

=== Sonic Adventure/Sonic Adventure DX ===
{| class="wikitable"
!Game
!Version
!Comments
|-
|Sonic Adventure (Dreamcast)
|US, version 1.005 (animated title screen)
|Japanese, European (PAL), International, Limited, Taikenban and other versions are NOT supported. The US 1.004 version (static title screen) has a template but it's less complete than 1.005. We also have a research template for the Autodemo prototype.
|-
|Sonic Adventure DX (Gamecube)
|US version
|Japanese and European (PAL) versions are NOT supported.
|-
|Sonic Adventure DX (PC)
|2004 US version (Activision)
|Steam version NOT supported. Use the [[SADX Mod Installer]] to convert it to the 2004 version.
|}

=== Sonic Adventure 2/Sonic Adventure 2 Battle ===
{| class="wikitable"
|+
!Game
!Version
!Comments
|-
|Sonic Adventure 2 (Dreamcast)
|US version
|Japanese and European (PAL) versions are NOT supported. We have a separate template for SA2: The Trial and Preview prototypes.
|-
|Sonic Adventure 2: Battle (Gamecube)
|US version
|Japanese and European (PAL) versions are NOT supported.
|-
|Sonic Adventure 2 (PC)
|Steam version
|Replace <code>sonic2app.exe</code> in the game folder with a [https://sf94.reimuhakurei.net/share/sonic2app_decrypt.exe decrypted version] to make it possible to use with SA Tools.
|}

== Extracting game files ==

If you have an ISO of the game, you need to extract it first. If you're ripping the PC version, you can skip this section assuming you have the game installed.

=== Extracting Dreamcast games ===

'''Extracting CDI files'''

If your game is in the CDI format, you can use the trial version of ISOBuster to extract it. Open the CDI file in the program, select the session on the left and the files on the right. Make sure you've selected the file <code>1ST_READ.BIN</code> and the <code>SONICADV</code> folder. Usually these are found in Session 2 Track 02. Sometimes the <code>SONICADV</code> folder is also located on Session 1 Track 01. Extract both tracks in that case. If the folder is named <code>SONICAD</code>, you have the wrong version of the game.

Right click the selected files and click "Extract objects", then choose an output folder. If the files extracted successfully, you can proceed to the next section.

[[File:296433640-1bbab28c-3ed3-4562-b912-a80ad34d866e.png|460x460px]]

'''Extracting GDI files'''

There are several different GDI formats, some of which require additional conversion before they can be processed by other software. The best supported dumps are TOSEC dumps, which contain a GDI file and files <code>track01.bin</code>, <code>track02.raw</code> (or <code>track02.bin</code>) and <code>track03.bin</code>. If your game is in the this format, you can use GDI2Data to extract files from it. If your BIN files are named differently, find a different dump.

[https://github.com/X-Hax/sa_tools/files/13927174/Gdi2Data.zip Gdi2Data.zip]

Extract the GDI2Data archive to any folder, copy the game's GDI file to the same folder (including all BIN and RAW files that come with the GDI file) and double click GDI2Data.bat. A command line window will open. When it says "DONE! FamilyGuy 2009", check if the <code>data</code> folder contains extracted files. If the files extracted successfully, you can proceed to the next section.

[[File:296434143-0f06c607-8db0-467b-a8f2-5002c98ffede.png|600x600px]]

[[File:296434226-95d2e8f2-2fa0-4e62-b880-2516a98b867c.png|600x600px]]

[[File:296434220-6be40614-a163-49c8-9329-f407a1206d6b.png|600x600px]]

=== Extracting Gamecube games ===

The easiest way to extract Gamecube games is with the Dolphin Gamecube emulator. Right click the game and select Properties. Go to the Filesystem tab, right click the "Disc" text and select "Extract entire disc". Choose an output folder. Now you can proceed to the next section.

[[File:296434494-96ad849a-f04f-4fb4-8fde-f3d3e4832e88.png]]

== Creating a project with SA Tools Hub ==



Run the [[SA Tools Hub]] and click the "New Project" button.

[[File:296434582-fa000911-9f45-48eb-b439-aed3e8d3b2d9.png]]

Select the base game and the platform, then pick the template.

[[File:296434622-471434e1-2c0d-4ac4-944d-728fbc31ab10.png]]

If you haven't created rips of this specific version of the game before, SA Tools Hub will ask for the game's location. Point it to the location of <code>1ST_READ.BIN</code> (Dreamcast games) or <code>Main.dol</code> (Gamecube games, located in the <code>sys</code> folder) extracted earlier, <code>sonic.exe</code> (SADX PC) or <code>sonic2app.exe</code> (SA2 PC). If the game version is correct, the "Create Project" button will be enabled. Click it and specify the location of the project file. Once the project is created, the ripped data will be in the project folder, in the subfolder with the same name as the project.

== Viewing assets in SA Tools ==

'''Levels and models'''

When the project .sap file is opened in SA Tools Hub, you can use the icons on the right to open different programs that let you view and/or edit assets. Alternatively you can run these programs separately and open the project .sap file in them.

[[File:296435558-b67c995b-cdb5-46f8-bd6a-eb257a5d1f8a.png]]

When you open the .sap file in these editors, they run in Project Mode, which auto-loads additional data such as textures, level objects etc. and lets you pick assets from a list instead of browsing through files. Although you can open individual level files (<code>.sa*lvl</code>) in [[SALVL]] and model files (<code>.sa*mdl) in [[SAMDL]], using the editors in Project Mode is recommended for ease of use.
{| class="wikitable"
![[File:296435780-37c01a93-2ead-4418-851b-39f103dcae96.png|none|frame|Model select in SAMDL Project Mode]]
![[File:296435767-0a60e369-d48f-4491-8d4e-921e4111c2e3.png|none|frame|Level Select in SALVL Project Mode]]
|}
'''Textures'''

Textures from the original game are not included in the project. If you need to view or extract textures, use Texture Editor to open PVM, GVM, PRS or PAK files in the game's source data folder (<code>SONICADV</code> for SA1 DC, <code>system</code> for SADX PC, <code>resource\GC_PC</code> for SA2 PC etc.).

'''Sounds'''

Sounds from the original game are not included in the project. [[SADXSndSharp]] can be used for .DAT soundbanks in SADX PC, and [https://github.com/blueskythlikesclouds/SonicAudioTools SonicAudioTools] for CSB soundbanks in SA2 PC.

== Exporting assets for use with other software ==

Levels, models and animations can be imported into Blender using the [https://github.com/X-Hax/SonicAdventureBlenderIO SAIO Blender Addon].

'''The import and export functionality in SAMDL and SALVL is unreliable and not recommended for general use.'''

'''The SAIO Blender addon is recommended for import and export from/to <code>.sa*mdl</code> and <code>.sa*lvl files.'''