SARC: Difference between revisions

From ZeldaMods (Breath of the Wild)
Jump to navigation Jump to search
imported>Leoetlino
(→‎Tools: add warning about file sizes)
imported>Leoetlino
Line 37: Line 37:
* [https://github.com/Shadsterwolf/BotWUnpacker BotW Unpacker] (for Wii U)
* [https://github.com/Shadsterwolf/BotWUnpacker BotW Unpacker] (for Wii U)
* [https://github.com/leoetlino/sarc <code>sarc</code>] (for Wii U and Switch)
* [https://github.com/leoetlino/sarc <code>sarc</code>] (for Wii U and Switch)
'''We strongly advise against using other tools because they do not handle file alignment properly.'''


[[Category:File formats]] 
[[Category:File formats]] 

Revision as of 19:35, 23 September 2018

SARCs are archive files.

Structure

The basic structure of SARC files is documented on the MK8 wiki.

Usage in Breath of the Wild

SARCs are used extensively in Breath of the Wild to keep related data in memory and minimise loading times.

Extensions

Archives have a wide range of extensions. However, the file format is completely the same regardless of the extension.

The following extensions are specific to the game:

The following extensions are used by Nintendo libraries that are included in the game (non exhaustive list):

  • sarc
  • bgenv
  • genvb
  • blarc

Data alignment

Some files have specific alignment requirements (e.g. for GPU data). Because Nintendo's SARC library returns file data by giving pointers to the data section directly, special care must be taken to pack files in a way that satisfies all alignment requirements.

Nintendo libraries do not use BotW's resource system and expect files to be properly aligned. This is the case for layout archives (blarc) and agl environment files (Pack/Bootup.pack/Env/env.genvb).

However unlike most other Nintendo games, for files that are managed by the game's resource system, aligning archive file data is usually unnecessary because the system will automatically allocate an aligned buffer and copy the archive data into it.

Tools

Because of the alignment problem and file size limitations due to Breath of the Wild's resource system, only the following tools are recommended:

  • SARC Tool (for Wii U and Switch) Warning: SARC Tool may add unnecessary padding when archives are repacked, meaning generated archives may end up larger than the original even if no file size was increased inside the SARC. The game will fail to load it unless you fix the Resource system.
  • BotW Unpacker (for Wii U)
  • sarc (for Wii U and Switch)

We strongly advise against using other tools because they do not handle file alignment properly.