Difference between revisions of "Paired ARC+DIR file"
m (Minor cleanup.) |
m |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | '''ARC''' files ( | + | '''ARC''' files (short for '''Archive''') and '''DIR''' files (internally named '''Bundle''' ; not to be confused with [[BUN file|'''BUN''' files]]) make up one of ''Pikmin''<nowiki>'s</nowiki> proprietary data storage formats. The '''DIR''' file contains all necessary information about the data in the '''ARC''' file, which stores the aforementioned data. |
| − | With minimal metadata, | + | With minimal metadata, the Bundled Archive file format was used to reduce load time by packing several files into one. The purpose it serves is different from the [[BUN file|bundle]] archive, however, as standalone files within the archive can be read independently of the files before it. This makes the Bundled Archive file format useful for archiving large directories with varied purposes, as to its name. |
__TOC__ | __TOC__ | ||
| Line 9: | Line 9: | ||
=== DIR === | === DIR === | ||
| − | DIR files consist of a header followed by a repeating | + | DIR files consist of a header followed by a repeating entry for each mock-filepath. |
Here is <code>/dataDir/archives/pelletsbin.dir</code> annotated for reference. | Here is <code>/dataDir/archives/pelletsbin.dir</code> annotated for reference. | ||
| Line 21: | Line 21: | ||
| 0x00 || 4 || Size of DIR file | | 0x00 || 4 || Size of DIR file | ||
|- | |- | ||
| − | | 0x04 || 4 || Number of | + | | 0x04 || 4 || Number of entries |
|- | |- | ||
|} | |} | ||
{| class="wikitable" | {| class="wikitable" | ||
| − | |+ Mock-directory | + | |+ Mock-directory entry |
! Offset || Size || Purpose | ! Offset || Size || Purpose | ||
|- | |- | ||
| Line 43: | Line 43: | ||
=== ARC === | === ARC === | ||
| − | Here is <code>/dataDir/archives/pelletsbin.arc</code> annotated to | + | Here is <code>/dataDir/archives/pelletsbin.arc</code> annotated to show how mapping the ARC file would look like with information from the corresponding DIR. Without the DIR file as a guide, the only way you could possibly differentiate between files would be with the <code>0xCC</code> padding between files. |
[[File:ARC_file_documentation.png]][[File:Minty_Meeo_Documentation_Legend.png]] | [[File:ARC_file_documentation.png]][[File:Minty_Meeo_Documentation_Legend.png]] | ||
==== <code>0xCC</code> padding ==== | ==== <code>0xCC</code> padding ==== | ||
| − | + | Files in the ARC always have padding to nearest multiple of 32, or 0x20. This is because data loading into the Gamecube's register's in multiples of 32 is an optimization. | |
== Extra information == | == Extra information == | ||
| − | Every paired | + | Every paired Bundled Archive file archive has an uncompressed copy elsewhere on the disc. |
| − | * In <code>/dataDir/tekis</code> and <code>/dataDir/bosses</code>, a file named <code>arc_all.ini</code> can be found. These INI files holds nothing, but | + | * In <code>/dataDir/tekis</code> and <code>/dataDir/bosses</code>, a file named <code>arc_all.ini</code> can be found. These INI files holds nothing, but are an indicator to the archiving tool to bundle the directory's contents. |
* It is unknown if every file in the archives is identical to its uncompressed sister file. | * It is unknown if every file in the archives is identical to its uncompressed sister file. | ||
In the [[OpenGL / Dolphin System]], many files are not read from the paired ARC+DIR file archives like they are in the final game, and are instead read from the un-archived versions. | In the [[OpenGL / Dolphin System]], many files are not read from the paired ARC+DIR file archives like they are in the final game, and are instead read from the un-archived versions. | ||
| − | + | Bundled Archives that have "bin" in their filename only contain the '''BIN''' files from their respective directory. | |
The <code>log.txt</code> files left in the root of [[Pikmin|''Pikmin'' versions USA Demo, USA v1.00, and JPN v1.02]] detail the plugin "[[OpenGL / Dolphin System|plugTexConv]]" creating a paired ARC+DIR file archive. | The <code>log.txt</code> files left in the root of [[Pikmin|''Pikmin'' versions USA Demo, USA v1.00, and JPN v1.02]] detail the plugin "[[OpenGL / Dolphin System|plugTexConv]]" creating a paired ARC+DIR file archive. | ||
| − | {{Credits|[[User:Minty_Meeo|Minty_Meeo]]}} | + | {{Credits|[[User:Minty_Meeo|Minty_Meeo]], [[User:Patrick_Anton|Ambrosia]]}} |
[[Category:Pikmin]] | [[Category:Pikmin]] | ||
| − | [[Category:File | + | [[Category:File formats]] |
Latest revision as of 16:35, 29 December 2019
ARC files (short for Archive) and DIR files (internally named Bundle ; not to be confused with BUN files) make up one of Pikmin's proprietary data storage formats. The DIR file contains all necessary information about the data in the ARC file, which stores the aforementioned data.
With minimal metadata, the Bundled Archive file format was used to reduce load time by packing several files into one. The purpose it serves is different from the bundle archive, however, as standalone files within the archive can be read independently of the files before it. This makes the Bundled Archive file format useful for archiving large directories with varied purposes, as to its name.
Contents
File structure[edit]
As mentioned before, the paired ARC+DIR file archive consists of two files: the mock-directory (DIR) and the BLOB archive (ARC). Think of the mock-directory as a map to navigate through the BLOB archive.
DIR[edit]
DIR files consist of a header followed by a repeating entry for each mock-filepath.
Here is /dataDir/archives/pelletsbin.dir annotated for reference.
| Offset | Size | Purpose |
|---|---|---|
| 0x00 | 4 | Size of DIR file |
| 0x04 | 4 | Number of entries |
| Offset | Size | Purpose |
|---|---|---|
| 0x00 | 4 | Offset of file in ARC |
| 0x04 | 4 | Size of file in ARC |
| 0x08 | 4 | Mock-directory string length |
| 0x0C | 0x08 value | Mock-directory path |
Mock-directory[edit]
The DIR file emulates filepaths. When a file is unpacked in-game, it is assumed that whatever code is responsible treats the entry in the DIR file as a legitimate filepath on the disc, starting from the root.
ARC[edit]
Here is /dataDir/archives/pelletsbin.arc annotated to show how mapping the ARC file would look like with information from the corresponding DIR. Without the DIR file as a guide, the only way you could possibly differentiate between files would be with the 0xCC padding between files.
0xCC padding[edit]
Files in the ARC always have padding to nearest multiple of 32, or 0x20. This is because data loading into the Gamecube's register's in multiples of 32 is an optimization.
Extra information[edit]
Every paired Bundled Archive file archive has an uncompressed copy elsewhere on the disc.
- In
/dataDir/tekisand/dataDir/bosses, a file namedarc_all.inican be found. These INI files holds nothing, but are an indicator to the archiving tool to bundle the directory's contents. - It is unknown if every file in the archives is identical to its uncompressed sister file.
In the OpenGL / Dolphin System, many files are not read from the paired ARC+DIR file archives like they are in the final game, and are instead read from the un-archived versions.
Bundled Archives that have "bin" in their filename only contain the BIN files from their respective directory.
The log.txt files left in the root of Pikmin versions USA Demo, USA v1.00, and JPN v1.02 detail the plugin "plugTexConv" creating a paired ARC+DIR file archive.
