PAK (File Format)/RetroStudios - Revision history

Wexos: Document compressed block containing decompressed data

2025-07-11T20:22:08Z

Document compressed block containing decompressed data

← Older revision		Revision as of 20:22, 11 July 2025
Line 86:		Line 86:
	\| 0x08 \|\| UInt64 \|\| '''Resource ID'''.		\| 0x08 \|\| UInt64 \|\| '''Resource ID'''.
	\|-		\|-
	\| 0x10 \|\| UInt32 \|\| '''File data size''' in bytes. Files are always padded with 0x40 ~~using byte 0xFF~~, which is reflected in the file data size.		\| 0x10 \|\| UInt32 \|\| '''File data size''' in bytes. Files are always padded with 0x40, which is reflected in the file data size.
	\|-		\|-
	\| 0x14 \|\| UInt32 \|\| '''File data offset''', relative to the start of the [[#DATA\|DATA]] section.		\| 0x14 \|\| UInt32 \|\| '''File data offset''', relative to the start of the [[#DATA\|DATA]] section.
Line 102:		Line 102:
	\| 0x00 \|\| Char[4] \|\| '''Data magic'''. Always ''CMPD'' in ASCII.		\| 0x00 \|\| Char[4] \|\| '''Data magic'''. Always ''CMPD'' in ASCII.
	\|-		\|-
	\| 0x04 \|\| UInt32 \|\| '''Block count''' ('''N'''). Specifies the number of compressed blocks the data has been divided into~~. For Donkey Kong Country Returns this will always be 1~~.		\| 0x04 \|\| UInt32 \|\| '''Block count''' ('''N'''). Specifies the number of compressed blocks the data has been divided into.
	\|}		\|}

Line 114:		Line 114:
	\| 0x01 \|\| UInt24 \|\| '''Compressed size''' in bytes.		\| 0x01 \|\| UInt24 \|\| '''Compressed size''' in bytes.
	\|-		\|-
	\| 0x04 \|\| UInt32 \|\| '''Decompressed size''' in bytes.		\| 0x04 \|\| UInt32 \|\| '''Decompressed size''' in bytes. If the compressed size is identical to the decompressed size, it means the block data is not compressed and the data should be copied directly rather than decompressing.
	\|}		\|}

Wexos at 19:57, 11 July 2025

2025-07-11T19:57:31Z

@@ Line 80: / Line 80: @@
 ! Offset !! Type !! Description
 |-
-| 0x00 || UInt32 || '''Compression flag'''. Either 0 (uncompressed) or 1 (compressed). In Donkey Kong Country Returns, files may be compressed using ZLib.
+| 0x00 || UInt32 || '''Compression flag'''. Either 0 (uncompressed) or 1 (compressed). See [[#Compressed Data|here]] for more details.
 |-
 | 0x04 || Char[4] || '''Resource magic'''. File magic of the resource specifying file type.
@@ Line 86: / Line 86: @@
 | 0x08 || UInt64 || '''Resource ID'''.
 |-
-| 0x10 || UInt32 || '''File data size''' in bytes.
+| 0x10 || UInt32 || '''File data size''' in bytes. Files are always padded with 0x40 using byte 0xFF, which is reflected in the file data size.
 |-
 | 0x14 || UInt32 || '''File data offset''', relative to the start of the [[#DATA|DATA]] section.
@@ Line 92: / Line 92: @@
 == DATA ==
-All file data is stored in the '''DATA''' section and references by each [[#Resource|resource]].
+All file data is stored in the '''DATA''' section and references by each [[#Resource|resource]]. File data is always padded to nearest 0x40 with 0xFF.
 = Tools =

Wexos at 19:23, 11 July 2025

2025-07-11T19:23:20Z

← Older revision		Revision as of 19:23, 11 July 2025
Line 37:		Line 37:
	\|}		\|}

	~~Afterwards~~ the section data ~~is layout~~ in the same order as they are specified above.		At 0x80 the section data for each section starts. They are laid out in the same order as they are specified above.

	== STRG ==		== STRG ==
	The '''STRG''' ~~data~~ starts with the following structure:		The '''STRG''' section specifies files which are named, in other words identified by a string. It starts with the following structure:

	{\|class="wikitable"		{\|class="wikitable"
Line 60:		Line 60:
	\| '''N''' + 1 \|\| Char[4] \|\| '''Resource magic'''. File magic of the resource specifying file type.		\| '''N''' + 1 \|\| Char[4] \|\| '''Resource magic'''. File magic of the resource specifying file type.
	\|-		\|-
	\| '''N''' + 5 \|\| UInt64 \|\| '''Resource ID'''.		\| '''N''' + 5 \|\| UInt64 \|\| '''Resource ID'''. There is always an entry in the [[#RSHD\|RSHD section]] with the same ''Resource ID''.
	\|}		\|}

	== RSHD ==		== RSHD ==
	The '''RSHD ''' ~~data~~ starts with the following structure:		The '''RSHD ''' section specifies all files, where the files are identified by a 64-bit integer. All files in [[#STRG\|STRG]] are also stores in the RSHD section. It starts with the following structure:

	{\|class="wikitable"		{\|class="wikitable"
Line 80:		Line 80:
	! Offset !! Type !! Description		! Offset !! Type !! Description
	\|-		\|-
	\| 0x00 \|\| UInt32 \|\| '''Compression flag'''. Either 0 (uncompressed) or 1 (compressed).		\| 0x00 \|\| UInt32 \|\| '''Compression flag'''. Either 0 (uncompressed) or 1 (compressed). In Donkey Kong Country Returns, files may be compressed using ZLib.
	\|-		\|-
	\| 0x04 \|\| Char[4] \|\| '''Resource magic'''. File magic of the resource specifying file type.		\| 0x04 \|\| Char[4] \|\| '''Resource magic'''. File magic of the resource specifying file type.

Wexos: Created page with "'''PAK''' is an archive file format used in games such as Donkey Kong Country Returns created by RetroStudios. = File Format = == Header == The file starts with the following header: {|class="wikitable" ! Offset !! Type !! Description |- | 0x00 || UInt32 || {{Unknown-left|'''Unknown'''. Always 2, possibly a version number.}} |- | 0x04 || UInt32 || '''Header size'''. Always 0x40. |- | 0x08 || Byte[0x10] || '''MD5 hash''' of the file data following the header. |- |..."

2025-07-11T17:34:52Z

Created page with "'''PAK''' is an archive file format used in games such as Donkey Kong Country Returns created by RetroStudios. = File Format = == Header == The file starts with the following header: {|class="wikitable" ! Offset !! Type !! Description |- | 0x00 || UInt32 || {{Unknown-left|'''Unknown'''. Always 2, possibly a version number.}} |- | 0x04 || UInt32 || '''Header size'''. Always 0x40. |- | 0x08 || Byte[0x10] || '''MD5 hash''' of the file data following the header. |- |..."

New page

'''PAK''' is an archive file format used in games such as [[Donkey Kong Country Returns]] created by RetroStudios.

= File Format =

== Header ==
The file starts with the following header:

{|class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || {{Unknown-left|'''Unknown'''. Always 2, possibly a version number.}}
|-
| 0x04 || UInt32 || '''Header size'''. Always 0x40.
|-
| 0x08 || Byte[0x10] || '''MD5 hash''' of the file data following the header.
|-
| 0x18 || Byte[0x18] || '''Padding'''.
|}

== Table Of Content ==
After the header, a table of content structure specify what sections are stored in the file. It has the following structure:

{|class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || '''Section count''' ('''N'''). In practice this will always be 3 with order [[#STRG|STRG]], [[#RSHD|RSHD]], [[#DATA|DATA]].
|}

'''N''' entries of the following structure follows.

{|class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Char[4] || '''Section magic'''.
|-
| 0x04 || UInt32 || '''Section size''' in bytes.
|}

Afterwards the section data is layout in the same order as they are specified above.

== STRG ==
The '''STRG''' data starts with the following structure:

{|class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || '''Number of [[#Named Resource|named resources]]''' ('''N''').
|}

Immediately afterwards '''N''' [[#Named Resource|named resources]] follows.

=== Named Resource ===
Each resource has the following structure:

{|class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || Char['''N''' + 1] || '''Resource name''' stored as a null-terminated string of length '''N'''.
|-
| '''N''' + 1 || Char[4] || '''Resource magic'''. File magic of the resource specifying file type.
|-
| '''N''' + 5 || UInt64 || '''Resource ID'''.
|}

== RSHD ==
The '''RSHD ''' data starts with the following structure:

{|class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || '''Number of [[#Resource|resources]]''' ('''N''').
|}

Immediately afterwards '''N''' [[#Resource|resources]] follows.

=== Resource ===
Each resource has the following structure:

{|class="wikitable"
! Offset !! Type !! Description
|-
| 0x00 || UInt32 || '''Compression flag'''. Either 0 (uncompressed) or 1 (compressed).
|-
| 0x04 || Char[4] || '''Resource magic'''. File magic of the resource specifying file type.
|-
| 0x08 || UInt64 || '''Resource ID'''.
|-
| 0x10 || UInt32 || '''File data size''' in bytes.
|-
| 0x14 || UInt32 || '''File data offset''', relative to the start of the [[#DATA|DATA]] section.
|}

== DATA ==
All file data is stored in the '''DATA''' section and references by each [[#Resource|resource]].

= Tools =
The following tools can handle PAK files:
* [https://github.com/jellees/crPakTool crPakTool] by jellees

[[Category:Donkey Kong Country Returns File Formats]]