Help:Tools/sarc: Difference between revisions

From ZeldaMods (Breath of the Wild)
Jump to navigation Jump to search
imported>Leoetlino
imported>Leoetlino
 
(7 intermediate revisions by the same user not shown)
Line 5: Line 5:
| authors = leoetlino
| authors = leoetlino
| source = https://github.com/leoetlino/sarc
| source = https://github.com/leoetlino/sarc
| license = GPLv3
| license = GPLv2+
| written_in = Python
| written_in = Python
| win_only =  
| win_only =  
Line 16: Line 16:


== Known issues ==
== Known issues ==
* None for ''Breath of the Wild'' currently.
None
 
== Usage ==
This tool automatically decompresses [[Yaz0]]-compressed archives, and re-compresses them when repacking if the extension starts with an <code>s</code>. This means that '''you do not need to compress or decompress files manually'''.
 
* To '''extract''': <code>sarc extract INPUT_FILE.pack</code>
* To '''pack''' (create a new archive): <code>sarc create INPUT_FOLDER OUTPUT_FILE.sbactorpack</code> (add <code> -b</code> at the end of the line for Wii U only).
* If you are using this tool for non-BotW games, make sure to pass the --not-botw flag as other games need different packing rules.
* If you are using this tool for non-BotW games, make sure to pass the --not-botw flag as other games need different packing rules.
* More commands in the [https://github.com/leoetlino/sarc readme].

Latest revision as of 19:33, 7 February 2019

sarc
Author(s) leoetlino
Source code https://github.com/leoetlino/sarc
License GPLv2+
Written in Python
Platform support Cross-platform

sarc is a tool that can read and generate both big endian and little endian SARC archives, whether they are Yaz0 compressed or not. It is one of the few tools that are able to align file data correctly.

Setup

Install the sarc package. [CLI help]

Known issues

None

Usage

This tool automatically decompresses Yaz0-compressed archives, and re-compresses them when repacking if the extension starts with an s. This means that you do not need to compress or decompress files manually.

  • To extract: sarc extract INPUT_FILE.pack
  • To pack (create a new archive): sarc create INPUT_FOLDER OUTPUT_FILE.sbactorpack (add -b at the end of the line for Wii U only).
  • If you are using this tool for non-BotW games, make sure to pass the --not-botw flag as other games need different packing rules.
  • More commands in the readme.