Difference between revisions of "SARC (File Format)"

From MK8
Jump to navigation Jump to search
m (Minor cleanup. Still needs some fixing.)
m
 
(27 intermediate revisions by 10 users not shown)
Line 1: Line 1:
−
'''SARC Files''' are uncompressed archive files used in [[Wii U]] applications and games, including [[Mario Kart 8]]. They are similar to the [[mkw:U8 (File Format)|U8]] files found in GameCube and Wii games. Common extensions are .arc, .sarc, .pack, and .bars.
+
'''SARC Files''' are archive files used in [[Wii U]] and [[3DS]], including [[Mario Kart 8]]. They are similar to the [[:mkw:U8 (File Format)|U8]] files found in GameCube and Wii games. Common extensions are '''.arc''' and '''.sarc''' (general), '''.pack''' (when the archive contains mostly other archive files), '''.bars''' (when it contains audio data), and '''.bgenv/.genvb''' (when it contains [[AAMP]]/shader files). SARC files are sometimes [[:mkw:Yaz0 (File Format)|Yaz0]] compressed into '''.szs''' files.
  
 
= File Format =
 
= File Format =
−
The file begins with a 16 bytes long header, and is followed by a file system and a list of filenames that are included in the archive. All values are big endian.
+
The basic structure of the archive is a '''SARC Header''' followed by a '''File Table''' and a '''File Name Table'''. Finally, the content of all files in the archive is stored directly. The '''File Table''' references the data.
 +
 
 +
== Header (SARC) ==
 +
Every SARC file begins with a 0x14 byte '''SARC Header''' structure.
  
−
== Header ==
 
 
{| class="wikitable"
 
{| class="wikitable"
 
! Offset !! Size !! Description
 
! Offset !! Size !! Description
 
|-
 
|-
−
| 0x00 || 4 || '''Magic''': 0x53415243 ("SARC").
+
| 0x00 || 4 || '''Magic''': 0x53415243 ("SARC" in ASCII).
 +
|-
 +
| 0x04 || 2 || '''Header Length''': the length of this header in bytes. Always '''0x14'''.
 
|-
 
|-
−
| 0x04 || 2 || {{Unknown|'''Unknown.''' Always 0x0014?}}
+
| 0x06 || 2 || {{BOM}}
 
|-
 
|-
−
| 0x04 || 2 || '''Byte order mark''' (0xFEFF)
+
| 0x08 || 4 || '''File size''' of the entire archive in bytes.
 
|-
 
|-
−
| 0x08 || 4 || '''File size''' of the entire archive.
+
| 0x0C || 4 || '''Beginning of data''' offset.
 
|-
 
|-
−
| 0x0c || 4 || '''Beginning of data''' offset.
+
| 0x10 || 2 || '''Version number''' of the file format. Always 0x0100.
 
|-
 
|-
−
| 0x10 || colspan=2 {{Unknown|End of '''SARC''' header}}
+
| 0x12 || 2 || Reserved.
 
|-
 
|-
 +
| 0x14 || colspan=2 {{Unknown|End of '''SARC''' header}}
 
|}
 
|}
  
−
== File Table ==
+
== File Allocation Table ==
−
Unlike the U8 format, SARC does generally not contain subdirectory nodes (though files may reside inside subfolders). It is currently unknown if it is able to.
+
Unlike the U8 format, SARC does generally not contain directory nodes (though files may reside inside subfolders).
 +
 
 +
=== Header (SFAT) ===
 +
The '''SARC Header''' is immediately followed by 12 byte '''SFAT Header''' structure.
  
−
=== Header ===
 
 
{| class="wikitable"
 
{| class="wikitable"
 
! Offset !! Type !! Description
 
! Offset !! Type !! Description
Line 31: Line 38:
 
| 0x00 || 4 || '''Magic''': 0x53464154 ("SFAT").
 
| 0x00 || 4 || '''Magic''': 0x53464154 ("SFAT").
 
|-
 
|-
−
| 0x04 || 2 || {{Unknown|'''Unknown.''' Always 0x000C?}}
+
| 0x04 || 2 || '''Header Length''': the length of this header in bytes. Always '''0xC'''.
 
|-
 
|-
 
| 0x06 || 2 || '''Node count'''.
 
| 0x06 || 2 || '''Node count'''.
 
|-
 
|-
−
| 0x08 || 4 || {{Unknown|'''Unknown.''' Always 0x00000065?}}
+
| 0x08 || 4 || '''Hash Key'''. Always '''0x00000065'''.
−
|-
 
−
| 0x0c || colspan=2 {{Unknown|End of '''SFAT''' header}}
 
 
|-
 
|-
 +
| 0x0C || colspan=2 {{Unknown|End of '''SFAT''' header}}
 
|}
 
|}
  
 
=== Node ===
 
=== Node ===
 +
The '''SFAT Header''' is followed by an array of 16 byte '''SFAT Node''' structures.
 +
 
{| class="wikitable"
 
{| class="wikitable"
 
! Offset !! Size !! Description
 
! Offset !! Size !! Description
 
|-
 
|-
−
| 0x00 || 4 || {{Unknown|'''Unknown.'''}}
+
| 0x00 || 4 || '''File Name Hash'''. Look below for the calculation.
−
|-
 
−
| 0x04 || 1 || {{Unknown|'''Unknown.''' Always 0x01? Comparable to the file/folder flag from U8?}}
 
 
|-
 
|-
−
| 0x05 || 3 || '''String table entry''' offset, relative to the end of the file name table header, divided by 4.
+
| 0x04 || 4 || '''File Attributes''', if flag 0x01000000 is set, bottom half (0xFFFF) is the Name Table offset (after header), divided by 4.
 
|-
 
|-
−
| 0x08 || 4 || '''Beginning of node file data''', relative to the starting offset specified in the SARC header.
+
| 0x08 || 4 || '''Beginning of node file data''', relative to the '''Beginning of data''' offset specified in the '''SARC header'''.
 
|-
 
|-
−
| 0x0c || 4 || '''End of node file data''', relative to the starting offset specified in the SARC header.
+
| 0x0C || 4 || '''End of node file data''', relative to the '''Beginning of data''' offset specified in the '''SARC header'''.
 
|-
 
|-
 
| 0x10 || colspan=2 {{Unknown|End of node}}
 
| 0x10 || colspan=2 {{Unknown|End of node}}
−
|-
 
 
|}
 
|}
 +
 +
==== File Name Hash ====
 +
The hash is calculated like this:
 +
<pre>
 +
uint GetHash(char* name, int length, uint key)
 +
{
 +
uint result = 0;
 +
for(int i = 0; i < length; i++)
 +
{
 +
result = name[i] + result * key;
 +
}
 +
return result;
 +
}
 +
</pre>
  
 
== File Name Table ==
 
== File Name Table ==
−
The header is immediately followed by 4-byte aligned null-terminated strings that represent the filenames of the packed files.
+
The '''File Name Table''' is a list of null-terminated strings which represent the filenames of the packed files. It is referenced by '''SFAT Node'''s.
 +
 
 +
=== Header (SFNT) ===
 +
The '''SFAT Node''' array is immediately followed by an 8 byte '''SFNT Header''' structure.
  
−
=== Header ===
 
 
{| class="wikitable"
 
{| class="wikitable"
−
! Offset !! Type !! Description
+
! Offset !! Size !! Description
 
|-
 
|-
 
| 0x00 || 4 || '''Magic''': 0x53464E54 ("SFNT").
 
| 0x00 || 4 || '''Magic''': 0x53464E54 ("SFNT").
 
|-
 
|-
−
| 0x04 || 4 || {{Unknown|'''Unknown.''' Always 0x00080000?}}
+
| 0x04 || 2 || '''Header Length''': the length of this header in bytes. Always '''0x8'''.
 +
|-
 +
| 0x06 || 2 || Reserved.
 
|-
 
|-
 
| 0x08 || colspan=2 {{Unknown|End of '''SFNT''' header}}
 
| 0x08 || colspan=2 {{Unknown|End of '''SFNT''' header}}
−
|-
 
 
|}
 
|}
 +
 +
=== Strings ===
 +
The '''SFAT Header''' is immediately followed by 4-byte aligned null-terminated strings that represent the filenames of the packed files.
  
 
== File Data ==
 
== File Data ==
−
The data begins at the variable value specified in the SARC header. There is padding between the files for 256-byte (0x100) alignment.
+
The data begins at the '''Beginning of data''' offset specified in the '''SARC Header'''. The alignment of the internal files vary between different files. Some files use 0x4 as the alignment.
  
 
= Tools =
 
= Tools =
−
 
+
The following tools can handle SARC files:
−
The following tool can extract SARC files:
+
* [http://florian.nouwt.com/wiki/index.php/Every_File_Explorer Every File Explorer], by [[Gericom]]
−
 
+
* [https://github.com/aboood40091/SARC-Tool/releases/tag/v0.3 SARC Tool], by [[User:Aboood40091|AboodXD]]
−
* SARCUnpack from the [https://www.dropbox.com/sh/tfg2nd6q809oqn3/AADWk3SgQEsqnvlbplcWOfv5a CWRT] package, by [[User:Celcodioc|Celcodioc]]
+
* [https://github.com/NWPlayer123/WiiUTools/tree/master/SARCTools SARCTools], by [[User:NWPlayer123|NwPlayer123]]
 +
* [https://drive.google.com/file/d/0B9ETxoIujjPFLTJOY2pIZ3RfRms/view Uwizard], by [[User:Mr. Mysterio|Mr. Mysterio]]
 +
* [https://github.com/smb123w64gb/Uwizard/releases/tag/1.2.0 Uwizard.Woomy], by [[User:smb123w64gb|smb123w64gb]]
 +
* [[Wexos's Toolbox]], by [[Wexos]]
 +
* [https://www.dropbox.com/sh/tfg2nd6q809oqn3/AADWk3SgQEsqnvlbplcWOfv5a WiiUExplorer], by [[User:Celcodioc|Celcodioc]]
  
 
[[Category:File Format]]
 
[[Category:File Format]]

Latest revision as of 12:55, 26 May 2022

SARC Files are archive files used in Wii U and 3DS, including Mario Kart 8. They are similar to the U8 files found in GameCube and Wii games. Common extensions are .arc and .sarc (general), .pack (when the archive contains mostly other archive files), .bars (when it contains audio data), and .bgenv/.genvb (when it contains AAMP/shader files). SARC files are sometimes Yaz0 compressed into .szs files.

File Format

The basic structure of the archive is a SARC Header followed by a File Table and a File Name Table. Finally, the content of all files in the archive is stored directly. The File Table references the data.

Header (SARC)

Every SARC file begins with a 0x14 byte SARC Header structure.

Offset Size Description
0x00 4 Magic: 0x53415243 ("SARC" in ASCII).
0x04 2 Header Length: the length of this header in bytes. Always 0x14.
0x06 2 Byte Order Mark (BOM): 0xFEFF for big endian and 0xFFFE for little endian.
0x08 4 File size of the entire archive in bytes.
0x0C 4 Beginning of data offset.
0x10 2 Version number of the file format. Always 0x0100.
0x12 2 Reserved.
0x14 End of SARC header

File Allocation Table

Unlike the U8 format, SARC does generally not contain directory nodes (though files may reside inside subfolders).

Header (SFAT)

The SARC Header is immediately followed by 12 byte SFAT Header structure.

Offset Type Description
0x00 4 Magic: 0x53464154 ("SFAT").
0x04 2 Header Length: the length of this header in bytes. Always 0xC.
0x06 2 Node count.
0x08 4 Hash Key. Always 0x00000065.
0x0C End of SFAT header

Node

The SFAT Header is followed by an array of 16 byte SFAT Node structures.

Offset Size Description
0x00 4 File Name Hash. Look below for the calculation.
0x04 4 File Attributes, if flag 0x01000000 is set, bottom half (0xFFFF) is the Name Table offset (after header), divided by 4.
0x08 4 Beginning of node file data, relative to the Beginning of data offset specified in the SARC header.
0x0C 4 End of node file data, relative to the Beginning of data offset specified in the SARC header.
0x10 End of node

File Name Hash

The hash is calculated like this: 

uint GetHash(char* name, int length, uint key)
{
	uint result = 0;
	for(int i = 0; i < length; i++)
	{
		result = name[i] + result * key;
	}
	return result;
}

File Name Table

The File Name Table is a list of null-terminated strings which represent the filenames of the packed files. It is referenced by SFAT Nodes.

Header (SFNT)

The SFAT Node array is immediately followed by an 8 byte SFNT Header structure.

Offset Size Description
0x00 4 Magic: 0x53464E54 ("SFNT").
0x04 2 Header Length: the length of this header in bytes. Always 0x8.
0x06 2 Reserved.
0x08 End of SFNT header

Strings

The SFAT Header is immediately followed by 4-byte aligned null-terminated strings that represent the filenames of the packed files.

File Data

The data begins at the Beginning of data offset specified in the SARC Header. The alignment of the internal files vary between different files. Some files use 0x4 as the alignment.

Tools

The following tools can handle SARC files:

Retrieved from "https://mk8.tockdom.com/w/index.php?title=SARC_(File_Format)&oldid=6342"