Editing Hey! Pikmin save file

{{stub}}
The file format for a ''Hey! Pikmin'' [[Save files|saved game]]. Note: this comes from analyses of the <code>.sav</code> files generated by Citra.

== Format ==
The save data is split into several blocks that start with 4-byte magic words. The blocks are ordered in the same order they are presented in this article.

=== SAVE ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0000</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>SAVE</code>.
|-
| <code>0x000C</code> || <code>0x000C</code> || 4 bytes || Save data checksum || Calculated using [[#Checksum|this method]].
|}

=== NEWS ===
What "news" the player has seen. "News" are the cutscenes that take place inside the S.S. Dolphin II, where the ship explains something to Olimar.
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0010</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>NEWS</code>.
|-
| <code>0x0014</code> || <code>0x0004</code> || 4 bytes || Unknown || 
|-
| <code>0x0018</code> || <code>0x0008</code> || 4 bytes || Unknown news controller 1 || 0 when the player hasn't heard the news about 1-A yet, 1 when they have.
|-
| <code>0x001C</code> || <code>0x000C</code> || 4 bytes || Unknown news controller 2 || 0 when the player hasn't heard the news about 1-A yet, 8 when they have.
|}

=== OPTI ===
The player's preferences in the options menu.
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0020</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>OPTI</code>.
|-
| <code>0x0024</code> || <code>0x0004</code> || 4 bytes || {{unknown|Unknown}} || 
|-
| <code>0x0028</code> || <code>0x0008</code> || 1 byte || Music volume || 0 to 3.
|-
| <code>0x0029</code> || <code>0x0009</code> || 1 byte || Sound effects volume || 0 to 3.
|-
| <code>0x002A</code> || <code>0x000A</code> || 2 bytes || {{unknown|Unknown}} || 
|}

=== PBUF ===
Which log entries the player has unlocked, and which they have read.
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x002C</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>PBUF</code>.
|-
| <code>0x0030</code> || <code>0x0004</code> || 4 bytes || Unknown || Messing with it can make the save file be recognized as empty in the title screen.
|-
| <code>0x0034</code> || <code>0x0008</code> || 36 bytes || Unlocked entries bitfield || The first 11 bits correspond to the Pikmin Logs category (blue pellet, red pellet, rock pellet, winged pellet, yellow pellet, Onion, Red Pikmin, Blue Pikmin, Yellow Pikmin, Rock Pikmin, Winged Pikmin). After that come the enemies, normal treasures, and amiibo treasures, but their order is all over the place.
|-
| <code>0x0058</code> || <code>0x002C</code> || 4 bytes || Read "Pikmin Logs" entries bitfield || 
|-
| <code>0x005C</code> || <code>0x0030</code> || 36 bytes || Read entries from the other categories bitfield || 
|}

=== PARK ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0080</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>PARK</code>.
|-
|}

=== MINI ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x04A4</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>MINI</code>.
|-
|}

=== CRNT ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0588</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>CRNT</code>.
|-
|}

=== GAME ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x09A8</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>GAME</code>.
|-
| <code>0x09AC</code> || <code>0x0004</code> || 4 bytes || {{unknown|Unknown}} || 
|-
| <code>0x09B0</code> || <code>0x0008</code> || 4 bytes || Sparklium total || Values over 99999 will make the game assume it's just 99999
|-
| <code>0x09B4</code> || <code>0x000C</code> || 44 bytes || {{unknown|Unknown}} || 
|-
|}

=== EVNT ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x09E0</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>EVNT</code>.
|-
|}

=== HELP ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0AE8</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>HELP</code>.
|-
|}

=== RINF ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0BF0</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>0xRINF</code>.
|-
|}

=== RSLT ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0C2C</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>RSLT</code>.
|-
|}

=== SPER ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0C38</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>SPER</code>.
|-
|}

=== STRE ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0C48</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>STRE</code>.
|-
|}

=== PLRP ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0C90</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>PLRP</code>.
|-
|}

=== DATE ===
Time at which the save was made.

{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0CE0</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>DATE</code>.
|-
| <code>0x0CE4</code> || <code>0x0004</code> || 4 bytes || {{unknown|Unknown}} || 
|-
| <code>0x0CE8</code> || <code>0x0008</code> || 4 bytes || Year || Human format. For instance, 2019 has the actual value "2019".
|-
| <code>0x0CEC</code> || <code>0x000C</code> || 1 byte || Month || 1 to 12.
|-
| <code>0x0CED</code> || <code>0x000D</code> || 1 byte || Day || 1 to 31.
|-
| <code>0x0CEE</code> || <code>0x000E</code> || 1 byte || Hours || 0 to 23.
|-
| <code>0x0CEF</code> || <code>0x000F</code> || 1 byte || Minutes || 0 to 59.
|-
| <code>0x0CF0</code> || <code>0x0010</code> || 1 byte || Seconds || 0 to 59.
|-
| <code>0x0CF1</code> || <code>0x0011</code> || 11 bytes || {{unknown|Unknown}} || 
|}

=== TTDS ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0CFC</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>TTDS</code>.
|-
|}

=== WMAP ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0D08</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>WMAP</code>.
|-
|}

=== SAMI ===
{| class="wikitable sortable"
! colspan="2" | Offset || rowspan="2" | Length || rowspan="2" | Field || rowspan="2" | Notes
|-
! File || Block
|-
| <code>0x0D80</code> || <code>0x0000</code> || 4 bytes || Block magic word || Always <code>SAMI</code>.
|-
|}

== Checksum ==
The checksum seems to be a CRC32 of the 0xd87 bytes that follow after the checksum (i.e. just one byte short of the entire remaining data), with crc32 as implemented by e.g. zlib.

The following python code can recalculate the checksum if the data after the checksum is modified:
<pre>
import struct
from zlib import crc32

filepath = "radish0.sav"  # put the script in the same folder as the save file
with open(filepath, "rb") as f:
    header = f.read(0xC)
    chksum = struct.unpack("I", f.read(4))[0]
    
    data = f.read()

calculated_chksum = crc32(data[0:0xd87])
with open(filepath, "wb") as f:
    f.write(header)
    f.write(struct.pack("I", calculated_chksum))
    f.write(data)
</pre>

== Tools ==
* [https://github.com/Espyo/Misc_Pikmin_tools/tree/master/hp_save_editor Hey! Pikmin save editor]

[[Category:File formats]]
[[Category:Hey! Pikmin]]