Class SarcFile

Class representing a Nintendo SARC (Simple Archive) file. Allows parsing existing archives, adding/removing files, and compiling new SARC archives.

Index

Constructors

Methods

addFile addRawFile getFiles getIsLittleEndian load removeFile save setDefaultAlignment setHashMultiplier setLittleEndian

Constructors

constructor

new SarcFile(isLittleEndian?): SarcFile
Creates a new empty SarcFile.
Parameters
- isLittleEndian: boolean = false
  Specifies if the SARC file should be compiled/written in Little Endian. Defaults to false (Big Endian, standard for Wii U/Switch).
Returns SarcFile
- Defined in SarcFile.ts:21

Methods

addFile

addFile(file): void
Adds an existing FileEntry object to the SARC.
Parameters
- file: FileEntry
  The FileEntry to add.
Returns void
- Defined in SarcFile.ts:30

addRawFile

addRawFile(data, destinationFilePath): void
Helper to add a raw file directly by specifying its data and destination path.
Parameters
- data: Bytes
  The file data (ArrayBuffer or Uint8Array).
- destinationFilePath: string
  The relative path/filename inside the archive.
Returns void
- Defined in SarcFile.ts:40

getFiles

getFiles(): FileEntry[]
Retrieves the array of all file entries currently in this SARC.

Returns FileEntry[]
An array of FileEntry references.
- Defined in SarcFile.ts:59

getIsLittleEndian

getIsLittleEndian(): boolean
Returns true if the archive is read/written in Little Endian byte order.

Returns boolean
True if Little Endian, false if Big Endian.
- Defined in SarcFile.ts:91

load

load(input): void
Parses and loads a SARC archive from binary data. Supports both uncompressed SARC files and Yaz0-compressed archives.
Parameters
- input: Bytes
  The binary source data (ArrayBuffer or Uint8Array).
Returns void
- Defined in SarcFile.ts:153

removeFile

removeFile(file): void
Removes a FileEntry from the SARC list.
Parameters
- file: FileEntry
  The FileEntry reference to remove.
Returns void
- Defined in SarcFile.ts:49

save

save(compression?): Uint8Array<ArrayBufferLike>
Compiles and builds the SARC archive into a single Uint8Array.
Parameters
- compression: number = 0
  The Yaz0 compression level to apply to the output file (0 = no compression, 9 = maximum search depth compression). Defaults to 0.
Returns Uint8Array<ArrayBufferLike>
The built SARC archive as a Uint8Array.
- Defined in SarcFile.ts:208

setDefaultAlignment

setDefaultAlignment(value): void
Sets the default byte alignment for files inside the SARC archive data section. Alignment must be a non-zero power of 2 (e.g. 4, 8, 0x2000).
Parameters
- value: number
  The byte alignment value.
Returns void
- Defined in SarcFile.ts:69

setHashMultiplier

setHashMultiplier(value): void
Sets the multiplier value used during filename string hash calculation. Defaults to 0x65.
Parameters
- value: number
  The hash multiplier value.
Returns void
- Defined in SarcFile.ts:82

setLittleEndian

setLittleEndian(isLittleEndian): void
Sets the byte order format (Endianness) for the archive.
Parameters
- isLittleEndian: boolean
  True for Little Endian, false for Big Endian.
Returns void
- Defined in SarcFile.ts:100