ProjectPokemon Wiki - User contributions [en]

Pokemon Save Structure

2010-06-18T04:52:00Z

イーブイ: /* Block B */ clarify shiny leaf storage

Pokémon in the games Pokémon [[Pokémon Diamond|Diamond]], [[Pokemon Pearl|Pearl]], and [[Pokémon Platinum Version|Platinum]] are stored in a 136 byte or 236 byte structures. All unencrypted values are stored in [[little-endian|little-endian]] format. The game encrypts the data when it is stored in the [[Pokémon NDS Save File Structure|save file]]. Party Pokémon have additional values to hold current battle stats and conditions. The information below describes the Pokémon data format.

== Checksum ==

The checksum serves two purposes:
# It validates the data after decryption, and
# It serves as the encryption key for the data.

The checksum is calculated in three steps:
# Split the unencrypted data from offsets 0x08 to 0x87 into two-byte words,
# Take the sum of the words, and
# Truncate the sum to 16 bits.

== Block Shuffling ==

The 128 bytes of Pokémon data are split into four 32-byte blocks for shuffling. The blocks are shuffled according to a shift value derived from the [[personality value]]. Given the personality value ''pv'', the expression yielding the shift value is:
: ''((pv >> 0xD) & 0x1F) % 24''
The right shifting (pv >> 0xD) is equivalent to a division of 8192.

To shuffle the blocks, take the four blocks of unencrypted data, ''A'', ''B'', ''C'', and ''D''. The blocks shall be rearranged in the encrypted data according to the Block Order column of the following table. (To unshuffle, use the Inverse column.)

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Shift Value (decimal)
! Block Order
! Inverse
|- style="background: #eee;" align="center"
| 00
| ABCD
| ABCD
|- style="background: #ddd;" align="center"
| 01
| ABDC
| ABDC
|- style="background: #eee;" align="center"
| 02
| ACBD
| ACBD
|- style="background: #ddd;" align="center"
| 03
| ACDB
| ADBC
|- style="background: #eee;" align="center"
| 04
| ADBC
| ACDB
|- style="background: #ddd;" align="center"
| 05
| ADCB
| ADCB
|- style="background: #eee;" align="center"
| 06
| BACD
| BACD
|- style="background: #ddd;" align="center"
| 07
| BADC
| BADC
|- style="background: #eee;" align="center"
| 08
| BCAD
| CABD
|- style="background: #ddd;" align="center"
| 09
| BCDA
| DABC
|- style="background: #eee;" align="center"
| 10
| BDAC
| CADB
|- style="background: #ddd;" align="center"
| 11
| BDCA
| DACB
|- style="background: #eee;" align="center"
| 12
| CABD
| BCAD
|- style="background: #ddd;" align="center"
| 13
| CADB
| BDAC
|- style="background: #eee;" align="center"
| 14
| CBAD
| CBAD
|- style="background: #ddd;" align="center"
| 15
| CBDA
| DBAC
|- style="background: #eee;" align="center"
| 16
| CDAB
| CDAB
|- style="background: #ddd;" align="center"
| 17
| CDBA
| DCAB
|- style="background: #eee;" align="center"
| 18
| DABC
| BCDA
|- style="background: #ddd;" align="center"
| 19
| DACB
| BDCA
|- style="background: #eee;" align="center"
| 20
| DBAC
| CBDA
|- style="background: #ddd;" align="center"
| 21
| DBCA
| DBCA
|- style="background: #eee;" align="center"
| 22
| DCAB
| CDBA
|- style="background: #ddd;" align="center"
| 23
| DCBA
| DCBA
|}

== Encryption ==

The encryption uses the [http://projectpokemon.org/wiki/PRNG_in_Pok%C3%A9mon pseudorandom number generator (PRNG)], a linear congruential generator. Elements of the PRNG can be described with the recursive function:
: ''X[n+1] = (0x41C64E6D * X[n] + 0x6073)''

To decrypt the data, given a function ''rand()'' which returns the upper 16 bits of consecutive results of the above given function:
# Seed the PRNG with the checksum (let ''X[n]'' be the checksum).
# Sequentially, for each 2-byte word ''Y'' from 0x08 to 0x87, apply the transformation: ''unencryptedByte = Y xor rand()''
# Unshuffle the blocks using the block shuffling algorithm above.

To encrypt the data:
# Shuffle the blocks using the block shuffling algorithm above.
# Seed the PRNG with the checksum (let ''X[n]'' be the checksum),
# Sequentially, for each 2-byte word ''Y'' from 0x08 to 0x87, apply the transformation: ''unencryptedByte = Y xor rand()''

== Unencrypted bytes ==
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x03
| [[Personality value]] (Also known as the [[PID]])
|- style="background: #ddd;" align="center"
| 0x04-0x05
| ''Unused''
|- style="background: #eee;" align="center"
| 0x06-0x07
| Checksum
|}

== Encrypted bytes ==
=== Block A ===

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x08-0x09
| [[Nationaldex|National Pokédex ID]]
|- style="background: #ddd;" align="center"
| 0x0A-0x0B
| [[item index|Held Item]]
|- style="background: #eee;" align="center"
| 0x0C-0x0D
| [[Original Trainer|OT ID]]
|- style="background: #ddd;" align="center"
| 0x0E-0x0F
| [[Original Trainer|OT Secret ID]]
|- style="background: #eee;" align="center"
| 0x10-0x13
| [[Experience Points|Experience points]]
|- style="background: #ddd;" align="center"
| 0x14
| Friendship (Steps to Hatch if an egg)
|- style="background: #eee;" align="center"
| 0x15
| [[Ability]]
|- style="background: #ddd;" align="center"
| 0x16
| [[#Markings|Markings]]
|- style="background: #eee;" align="center"
| 0x17
| [[#Original Language|Original Language]]

|- style="background: #ddd;" align="center"
| 0x18
| [[Effort Values#Hit Points|HP Effort Value]]
|- style="background: #eee;" align="center"
| 0x19
| [[Effort Values#Attack Points|Attack Effort Value]]

|- style="background: #ddd;" align="center"
| 0x1A
| [[Effort Values#Defense Points|Defense Effort Value]]
|- style="background: #eee;" align="center"
| 0x1B
| [[Effort Values#Speed Points|Speed Effort Value]]

|- style="background: #ddd;" align="center"
| 0x1C
| [[Effort Values#Special Attack Points|SP Attack Effort Value]]
|- style="background: #eee;" align="center"
| 0x1D
| [[Effort Values#Special Defense Points|SP Defense Effort Value]]

|- style="background: #ddd;" align="center"
| 0x1E
| [[Contest Stats#Cool|Cool Contest Value]]
|- style="background: #eee;" align="center"
| 0x1F
| [[Contest Stats#Beauty|Beauty Contest Value]]

|- style="background: #ddd;" align="center"
| 0x20
| [[Contest Stats#Cute|Cute Contest Value]]
|- style="background: #eee;" align="center"
| 0x21
| [[Contest Stats#Smart|Smart Contest Value]]

|- style="background: #ddd;" align="center"
| 0x22
| [[Contest Stats#Tough|Tough Contest Value]]
|- style="background: #eee;" align="center"
| 0x23
| [[Contest Stats#Sheen|Sheen Contest Value]]

|- style="background: #ddd;" align="center"
| 0x24-0x25
| [[#Sinnoh Ribbon Set 1|Sinnoh Ribbon Set 1]]
|- style="background: #eee;" align="center"
| 0x26-0x27
| [[#Sinnoh Ribbon Set 2|Sinnoh Ribbon Set 2]]
|}

=== Block B ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x28-0x29
| [[Pokemon Moves|Move 1 ID]]
|- style="background: #ddd;" align="center"
| 0x2A-0x2B
| [[Pokemon Moves|Move 2 ID]]
|- style="background: #eee;" align="center"
| 0x2C-0x2D
| [[Pokemon Moves|Move 3 ID]]
|- style="background: #ddd;" align="center"
| 0x2E-0x2F
| [[Pokemon Moves|Move 4 ID]]
|- style="background: #eee;" align="center"
| 0x30
| [[Pokemon Moves#Power Points|Move 1 Current PP]]
|- style="background: #ddd;" align="center"
| 0x31
| [[Pokemon Moves#Power Points|Move 2 Current PP]]
|- style="background: #eee;" align="center"
| 0x32
| [[Pokemon Moves#Power Points|Move 3 Current PP]]
|- style="background: #ddd;" align="center"
| 0x33
| [[Pokemon Moves#Power Points|Move 4 Current PP]]
|- style="background: #eee;" align="center"
| 0x34-0x37
| [[Pokemon Moves#Power Points|Move PP Ups]]
|- style="background: #ddd;" align="center"
| 0x38-0x3B
| Bits 0-29 - [[Individual Values]] 
[[Individual Values#Hit Points|HP]] ( [0-31] << 0 ) 
[[Individual Values#Attack Points|Attack]] ( [0-31] << 5 ) 
[[Individual Values#Defense Points|Defense]] ( [0-31] << 10 ) 
[[Individual Values#Speed Points|Speed]] ( [0-31] << 15 ) 
[[Individual Values#Special Attack Points|SP Attack]] ( [0-31] << 20 ) 
[[Individual Values#Special Defense Points|SP Defense]] ( [0-31] << 25 ) 
Bit 30 - IsEgg Flag Bit 31 - IsNicknamed Flag
|- style="background: #eee;" align="center"
| 0x3C-0x3D
| [[#Hoenn Ribbon Set 1|Hoenn Ribbon Set 1]]
|- style="background: #ddd;" align="center"
| 0x3E-0x3F
| [[#Hoenn Ribbon Set 2|Hoenn Ribbon Set 2]]
|- style="background: #eee;" align="center"
| 0x40
| Bit 0 - Fateful Encounter Flag Bit 1 - Female Bit 2 - Genderless Bit 3-7 - [[#Alternate Forms|Alternate Forms]]
|- style="background: #ddd;" align="center"
| 0x41
| Shiny Leaves (HGSS) Bit 5 - Leaf Crown Bits 0–4 - Leaves A–E (bit 0 is leftmost)
|- style="background: #eee;" align="center"
| 0x42-0x43
| ''Unused''
|- style="background: #ddd;" align="center"
| 0x44-0x45
| Egg [[Pokemon NDS Locations#Egg Locations|Location]] (Platinum)
|- style="background: #eee;" align="center"
| 0x46-0x47
| Met at [[Pokemon NDS Locations|Location]] (Platinum)
|}

=== Block C ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x48-0x5D
| Nickname
|- style="background: #ddd;" align="center"
| 0x5E
| ''Unused''
|- style="background: #eee;" align="center"
| 0x5F
| [[Pokemon Hometown|Hometown]]
|- style="background: #ddd;" align="center"
| 0x60-0x61
| [[#Sinnoh Ribbon Set 3|Sinnoh Ribbon Set 3]]
|- style="background: #eee;" align="center"
| 0x62-0x63
| [[#Sinnoh Ribbon Set 4|Sinnoh Ribbon Set 4]]
|- style="background: #ddd;" align="center"
| 0x64-0x67
| ''Unused''
|}

=== Block D ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x68-0x77
| [[Original Trainer|OT Name]]
|- style="background: #ddd;" align="center"
| 0x78-0x7A
| Date Egg Received
|- style="background: #eee;" align="center"
| 0x7B-0x7D
| Date Met
|- style="background: #ddd;" align="center"
| 0x7E-0x7F
| Egg [[Pokemon NDS Locations|Location]] (Diamond/Pearl)
|- style="background: #eee;" align="center"
| 0x80-0x81
| Met At [[Pokemon NDS Locations|Location]] (Diamond/Pearl)
|- style="background: #ddd;" align="center"
| 0x82
| [[Pokerus|Pokérus]]
|- style="background: #eee;" align="center"
| 0x83
| [http://projectpokemon.org/wiki/List_of_Diamond,_Pearl,_Platinum,_HeartGold_and_SoulSilver_Items_by_Index_Number#Balls Poké Ball]
|- style="background: #ddd;" align="center"
| 0x84
| Bit 0-6 - Met At Level Bit 7 - Female OT Gender
|- style="background: #eee;" align="center"
| 0x85
| [[#Encounter Types|Encounter Type]]
|- style="background: #ddd;" align="center"
| 0x86
|[http://projectpokemon.org/wiki/List_of_Diamond,_Pearl,_Platinum,_HeartGold_and_SoulSilver_Items_by_Index_Number#HeartGold_and_SoulSilver_exclusive_Balls HGSS Poké Ball]
|- style="background: #eee;" align="center"
| 0x87
| ''Unused''

|}

== Battle Stats ==

The battle stats are encrypted in the same manner, however the seed is not the checksum, it is the PID.

=== Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x88
| Bits 0-2 - Asleep (0-7 rounds) Bit 3 - Poisoned Bit 4 - Burned Bit 5 - Frozen Bit 6 - Paralyzed Bit 7 - Toxic
|- style="background: #ddd;" align="center"
| 0x89
| ''Unknown'' - Flags - Max Value 0xF0
|- style="background: #eee;" align="center"
| 0x8A-0x8B
| ''Unknown''
|- style="background: #ddd;" align="center"
| 0x8C
| Level
|- style="background: #eee;" align="center"
| 0x8D
| Capsule Index (Seals)
|- style="background: #ddd;" align="center"
| 0x8E-0x8F
| Current HP
|- style="background: #eee;" align="center"
| 0x90-0x91
| Max HP
|- style="background: #ddd;" align="center"
| 0x92-0x93
| Attack
|- style="background: #eee;" align="center"
| 0x94-0x95
| Defense
|- style="background: #ddd;" align="center"
| 0x96-0x97
| Speed
|- style="background: #eee;" align="center"
| 0x98-0x99
| Special Attack
|- style="background: #ddd;" align="center"
| 0x9A-0x9B
| Special Defense
|- style="background: #eee;" align="center"
| 0x9C-0xD3
| ''Unknown'' - Contains Trash Data
|- style="background: #ddd;" align="center"
| 0xD4-0xEB
| Seal Coordinates
|}

== Original Language ==
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Value
! Language
|- style="background: #eee;" align="center"
| 0x1
| 日本語 (Japan)
|- style="background: #ddd;" align="center"
| 0x2
| English (US/UK/AU)
|- style="background: #eee;" align="center"
| 0x3
| Français (France/Québec)
|- style="background: #ddd;" align="center"
| 0x4
| Italiano (Italy)
|- style="background: #eee;" align="center"
| 0x5
| Deutsch (Germany)
|- style="background: #ddd;" align="center"
| 0x7
| Español (Spain/Latin Americas)
|- style="background: #eee;" align="center"
| 0x8
| 한국어 (South Korea)
|}

== Markings ==
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Marking
|- style="background: #eee;" align="center"
| 0x01
| Circle
|- style="background: #ddd;" align="center"
| 0x02
| Triangle
|- style="background: #eee;" align="center"
| 0x04
| Square
|- style="background: #ddd;" align="center"
| 0x08
| Heart
|- style="background: #eee;" align="center"
| 0x10
| Star
|- style="background: #ddd;" align="center"
| 0x20
| Diamond
|}

== Alternate Forms ==
Alternate forms are stored at offset 0x40 of the Pokemon structure. Each form follows the pattern of ''index << 3'' where index starts at zero for the main form.

=== Unown's Forms ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
! Bit
! Form
! Bit
! Form
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| A
| 0x38
| H
| 0x70
| O
| 0xA8
| V
|- style="background: #ddd;" align="center"
| 0x08
| B
| 0x40
| I
| 0x78
| P
| 0xB0
| W
|- style="background: #eee;" align="center"
| 0x10
| C
| 0x48
| J
| 0x80
| Q
| 0xB8
| X
|- style="background: #ddd;" align="center"
| 0x18
| D
| 0x50
| K
| 0x88
| R
| 0xC0
| Y
|- style="background: #eee;" align="center"
| 0x20
| E
| 0x58
| L
| 0x90
| S
| 0xC8
| Z
|- style="background: #ddd;" align="center"
| 0x28
| F
| 0x60
| M
| 0x98
| T
| 0xD0
| !
|- style="background: #eee;" align="center"
| 0x30
| G
| 0x68
| N
| 0xA0
| U
| 0xD8
| ?
|}

=== Deoxy's Forms ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Normal
|- style="background: #ddd;" align="center"
| 0x08
| Attack
|- style="background: #eee;" align="center"
| 0x10
| Defense
|- style="background: #ddd;" align="center"
| 0x18
| Speed
|}

=== Burmy's & Wormadam's Forms ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Plant
|- style="background: #ddd;" align="center"
| 0x08
| Sandy
|- style="background: #eee;" align="center"
| 0x10
| Trash
|}

=== Shellos' & Gastrodon's Forms ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| West
|- style="background: #ddd;" align="center"
| 0x08
| East
|}

=== Rotom's Forms ===
Rotom's alternate forms will only be displayed in Pokemon Platinum. Rotom may be traded between Diamond, Pearl, and Platinum without losing the alternate form.
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Normal
|- style="background: #ddd;" align="center"
| 0x08
| Heat
|- style="background: #eee;" align="center"
| 0x10
| Wash
|- style="background: #ddd;" align="center"
| 0x18
| Frost
|- style="background: #eee;" align="center"
| 0x20
| Fan
|- style="background: #ddd;" align="center"
| 0x28
| Cut
|}

=== Giratina's Forms ===
Giratina's Origin form will only be displayed in Pokemon Platinum.
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Altered
|- style="background: #ddd;" align="center"
| 0x08
| Origin
|}

=== Shaymin's Forms ===
Shaymin's Sky form will only be displayed in Pokemon Platinum.
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Land
|- style="background: #ddd;" align="center"
| 0x08
| Sky
|}

=== Arceus' Forms ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Form
! Bit
! Form
! Bit
! Form
|- style="background: #eee;" align="center"
| 0x00
| Normal
| 0x30
| Insect
| 0x60
| Zap
|- style="background: #ddd;" align="center"
| 0x08
| Fist
| 0x38
| Spooky
| 0x68
| Mind
|- style="background: #eee;" align="center"
| 0x10
| Sky
| 0x40
| Iron
| 0x70
| Icicle
|- style="background: #ddd;" align="center"
| 0x18
| Toxic
| 0x48
| Flame
| 0x78
| Draco
|- style="background: #eee;" align="center"
| 0x20
| Earth
| 0x50
| Splash
| 0x80
| Dread
|- style="background: #ddd;" align="center"
| 0x28
| Stone
| 0x58
| Meadow
| 0x4C
| Curse
|}
== Encounter Types ==
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Value
! Country
|- style="background: #eee;" align="center"
| 0x0
| Pal Park, Egg, Hatched, Special Event
|- style="background: #ddd;" align="center"
| 0x2
| Tall Grass
|- style="background: #eee;" align="center"
| 0x4
| Dialga/Palkia In-Game Event
|- style="background: #ddd;" align="center"
| 0x5
| Cave, Hall of Origin
|- style="background: #eee;" align="center"
| 0x7
| Surfing, Fishing
|- style="background: #ddd;" align="center"
| 0x9
| Building
|- style="background: #eee;" align="center"
| 0xA
| Great Marsh (Safari Zone)
|- style="background: #ddd;" align="center"
| 0xC
| Starter, Fossil, Gift (Eevee)
|}

== Ribbons ==
Diamond, Pearl, and Platinum store the ribbon information as [[Bitfields|bitfields]] in 1-byte words. Given below are the bytewise representation of the ribbon bitfields.

=== Sinnoh Ribbon Set 1 ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x24 & 0x01
| Sinnoh Champ Ribbon
|- style="background: #ddd;" align="center"
| 0x24 & 0x02
| Ability Ribbon
|- style="background: #eee;" align="center"
| 0x24 & 0x04
| Great Ability Ribbon
|- style="background: #ddd;" align="center"
| 0x24 & 0x08
| Double Ability Ribbon
|- style="background: #eee;" align="center"
| 0x24 & 0x10
| Multi Ability Ribbon
|- style="background: #ddd;" align="center"
| 0x24 & 0x20
| Pair Ability Ribbon
|- style="background: #eee;" align="center"
| 0x24 & 0x40
| World Ability Ribbon
|- style="background: #ddd;" align="center"
| 0x24 & 0x80
| Alert Ribbon
|- style="background: #eee;" align="center"
| 0x25 & 0x01
| Shock Ribbon
|- style="background: #ddd;" align="center"
| 0x25 & 0x02
| Downcast Ribbon
|- style="background: #eee;" align="center"
| 0x25 & 0x04
| Careless Ribbon
|- style="background: #ddd;" align="center"
| 0x25 & 0x08
| Relax Ribbon
|- style="background: #eee;" align="center"
| 0x25 & 0x10
| Snooze Ribbon
|- style="background: #ddd;" align="center"
| 0x25 & 0x20
| Smile Ribbon
|- style="background: #eee;" align="center"
| 0x25 & 0x40
| Gorgeous Ribbon
|- style="background: #ddd;" align="center"
| 0x25 & 0x80
| Royal Ribbon
|}

=== Sinnoh Ribbon Set 2 ===

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x26 & 0x01
| Gorgeous Royal Ribbon
|- style="background: #ddd;" align="center"
| 0x26 & 0x02
| Footprint Ribbon
|- style="background: #eee;" align="center"
| 0x26 & 0x04
| Record Ribbon
|- style="background: #ddd;" align="center"
| 0x26 & 0x08
| History Ribbon
|- style="background: #eee;" align="center"
| 0x26 & 0x10
| Legend Ribbon
|- style="background: #ddd;" align="center"
| 0x26 & 0x20
| Red Ribbon
|- style="background: #eee;" align="center"
| 0x26 & 0x40
| Green Ribbon
|- style="background: #ddd;" align="center"
| 0x26 & 0x80
| Blue Ribbon
|- style="background: #eee;" align="center"
| 0x27 & 0x01
| Festival Ribbon
|- style="background: #ddd;" align="center"
| 0x27 & 0x02
| Carnival Ribbon
|- style="background: #eee;" align="center"
| 0x27 & 0x04
| Classic Ribbon
|- style="background: #ddd;" align="center"
| 0x27 & 0x08
| Premier Ribbon
|}

=== Sinnoh Ribbon Set 3 ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x60 & 0x01
| Cool Ribbon
|- style="background: #ddd;" align="center"
| 0x60 & 0x02
| Cool Ribbon Great
|- style="background: #eee;" align="center"
| 0x60 & 0x04
| Cool Ribbon Ultra
|- style="background: #ddd;" align="center"
| 0x60 & 0x08
| Cool Ribbon Master
|- style="background: #eee;" align="center"
| 0x60 & 0x10
| Beauty Ribbon
|- style="background: #ddd;" align="center"
| 0x60 & 0x20
| Beauty Ribbon Great
|- style="background: #eee;" align="center"
| 0x60 & 0x40
| Beauty Ribbon Ultra
|- style="background: #ddd;" align="center"
| 0x60 & 0x80
| Beauty Ribbon Master
|- style="background: #eee;" align="center"
| 0x61 & 0x01
| Cute Ribbon
|- style="background: #ddd;" align="center"
| 0x61 & 0x02
| Cute Ribbon Great
|- style="background: #eee;" align="center"
| 0x61 & 0x04
| Cute Ribbon Ultra
|- style="background: #ddd;" align="center"
| 0x61 & 0x08
| Cute Ribbon Master
|- style="background: #eee;" align="center"
| 0x61 & 0x10
| Smart Ribbon
|- style="background: #ddd;" align="center"
| 0x61 & 0x20
| Smart Ribbon Great
|- style="background: #eee;" align="center"
| 0x61 & 0x40
| Smart Ribbon Ultra
|- style="background: #ddd;" align="center"
| 0x61 & 0x80
| Smart Ribbon Master
|}

=== Sinnoh Ribbon Set 4 ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x62 & 0x01
| Tough Ribbon
|- style="background: #ddd;" align="center"
| 0x62 & 0x02
| Tough Ribbon Great
|- style="background: #eee;" align="center"
| 0x62 & 0x04
| Tough Ribbon Ultra
|- style="background: #ddd;" align="center"
| 0x62 & 0x08
| Tough Ribbon Master
|}

=== Hoenn Ribbon Set 1 ===

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x3C & 0x01
| Cool Ribbon
|- style="background: #ddd;" align="center"
| 0x3C & 0x02
| Cool Ribbon Super
|- style="background: #eee;" align="center"
| 0x3C & 0x04
| Cool Ribbon Hyper
|- style="background: #ddd;" align="center"
| 0x3C & 0x08
| Cool Ribbon Master
|- style="background: #eee;" align="center"
| 0x3C & 0x10
| Beauty Ribbon
|- style="background: #ddd;" align="center"
| 0x3C & 0x20
| Beauty Ribbon Super
|- style="background: #eee;" align="center"
| 0x3C & 0x40
| Beauty Ribbon Hyper
|- style="background: #ddd;" align="center"
| 0x3C & 0x80
| Beauty Ribbon Master
|- style="background: #eee;" align="center"
| 0x3D & 0x01
| Cute Ribbon
|- style="background: #ddd;" align="center"
| 0x3D & 0x02
| Cute Ribbon Super
|- style="background: #eee;" align="center"
| 0x3D & 0x04
| Cute Ribbon Hyper
|- style="background: #ddd;" align="center"
| 0x3D & 0x08
| Cute Ribbon Master
|- style="background: #eee;" align="center"
| 0x3D & 0x10
| Smart Ribbon
|- style="background: #ddd;" align="center"
| 0x3D & 0x20
| Smart Ribbon Super
|- style="background: #eee;" align="center"
| 0x3D & 0x40
| Smart Ribbon Hyper
|- style="background: #ddd;" align="center"
| 0x3D & 0x80
| Smart Ribbon Master
|}

=== Hoenn Ribbon Set 2 ===

{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
! Bit
! Ribbon
|- style="background: #eee;" align="center"
| 0x3F & 0x01
| Tough Ribbon
|- style="background: #ddd;" align="center"
| 0x3F & 0x02
| Tough Ribbon Super
|- style="background: #eee;" align="center"
| 0x3F & 0x04
| Tough Ribbon Hyper
|- style="background: #ddd;" align="center"
| 0x3F & 0x08
| Tough Ribbon Master
|- style="background: #eee;" align="center"
| 0x3F & 0x10
| Champion Ribbon
|- style="background: #ddd;" align="center"
| 0x3F & 0x20
| Winning Ribbon
|- style="background: #eee;" align="center"
| 0x3F & 0x40
| Victory Ribbon
|- style="background: #ddd;" align="center"
| 0x3F & 0x80
| Artist Ribbon
|- style="background: #eee;" align="center"
| 0x3E & 0x01
| Effort Ribbon
|- style="background: #ddd;" align="center"
| 0x3E & 0x02
| Marine Ribbon
|- style="background: #eee;" align="center"
| 0x3E & 0x04
| Land Ribbon
|- style="background: #ddd;" align="center"
| 0x3E & 0x08
| Sky Ribbon
|- style="background: #eee;" align="center"
| 0x3E & 0x10
| Country Ribbon
|- style="background: #ddd;" align="center"
| 0x3E & 0x20
| National Ribbon
|- style="background: #eee;" align="center"
| 0x3E & 0x40
| Earth Ribbon
|- style="background: #ddd;" align="center"
| 0x3E & 0x80
| World Ribbon
|}

== Save File Location ==
The party Pokémon are stored in the [[Pokémon NDS Save File Structure|save file]] beginning at offset 0x00098 for the first small block, and 0x40098 for the second small block.

In the first small save block, the first Daycare Pokémon is located at 0x0141C, and the second is located at 0x01508. In the second small block, the first Daycare Pokémon is located at 0x4141C, and the second is located at 0x41508.

In the first small save block, the Pal Park Pokémon are stored beginning at 0x0BA28. In the second small save block, the Pal Park Pokémon are stored beginning at 0x4BA28.

Each party, Daycare, and Pal Park Pokémon is 236 bytes in size.

The PC storage Pokémon are stored in the save file from Box 1 to Box 18. The offset starts at 0x0C104 for the first big block and 0x4C104 for the second big block. Each PC stored Pokémon is 136 bytes in size.

[[Category:Structures]]
[[Category:Game Mechanics]]
[[Category:ROM Research]]

GTS protocol

2010-03-21T03:57:17Z

イーブイ: clarify setProfile

The following is '''wild conjecture''' based on LordLandon's [http://projectpokemon.org/forums/showthread.php?780-GTC-website-research&p=67086&viewfull=1#post67086 sendpkm.py].

Communication with the GTS is done over regular HTTP with http://gamestats2.gs.nintendowifi.net/. The same protocol is used for all five Gen IV games.

==HTTP headers==

The games don't seem to care about these at all. The GTS sends back a bunch of boilerplate response headers, but the game happily accepts a response with only a Content-Length.

==Protocol==

All requests to the server are GET requests of the form <code><var>page</var>.asp?pid=<var>pid</var>&hash=<var>hash</var>&data=<var>data</var></code>.

===pid===

The pid is an unsigned 32-bit integer that appears to uniquely identify a game cartridge. When the pid is obtained and whether the pid has any relation to the Pal Pad friend code are unknown.

For the mathematically inclined: Eevee's Platinum pid is 192615460 (0x0b7b1424) and his Pal Pad code is 0904 2026 4621.

===Challenge/response===

Before each "real" request, the game sends a request of the form <code><var>page</var>.asp?pid=<var>pid</var></code> and the server responds with a 32-byte hex challenge token. The game computes <code>sha1("sAdeqWo3voLeC5r16DYv" + token)</code> and uses that as the <var>hash</var> value which it sends to the server. The <var>data</var> parameter is encrypted with an unknown algorithm.

That is, each request looks like the following:

# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var></code>
# Server responds with <var>token</var>
# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var>&hash=<var>sha1(...)</var>&data=<var>data</var></code>
# Server responds with payload

Unfortunately, this means that the exact details of the game's requests are currently not known.

==Conversation==

The first request the game makes is to <code>/pokemondpds/worldexchange/info.asp</code>. The server responds with 0x0001.

Platinum, Heart Gold, and Soul Silver will then make a request to <code>/pokemondpds/common/setProfile.asp</code>. The server responds with eight NULs (0x00000000 0x00000000).

After the above step(s) or '''performing any of the tasks below''', the game makes a request to <code>/pokemondpds/worldexchange/result.asp</code>. If the game has had a Pokémon sent to it (via a successful trade?), the server responds with the entire encrypted [[Pokemon NDS Structure|Pokémon save struct]]. If there is a Pokémon uploaded to the GTS, it responds with 0x0004. Otherwise, it responds with 0x0005.

===Receiving a Pokémon===

If the game receives a Pokémon from a successful trade as a response from <code>result.asp</code>, it next requests <code>/pokemondpds/worldexchange/delete.asp</code>. The server responds with 0x0001.

====A note on sendpkm.py====

After doing the above, some Platinum, Heart Gold, and Soul Silver games will report a communication error and dump the player back to the title screen. The Pokémon is still successfully received. At least one person with HG/SS has received a Pokémon from a fake server without getting the error, and Diamond/Pearl have never been reported to have the problem. It's possible that the server should respond with something other than 0x0001.

===Offering a Pokémon===

Pokémon are offered on the GTS by requesting <code>/pokemondpds/worldexchange/post.asp</code>, followed by <code>/pokemondpds/worldexchange/post_finish.asp</code>.

===Retrieving an offered Pokémon===

Checking on the currently offered Pokémon is apparently done by <code>/pokemondpds/worldexchange/get.asp</code>. The response appears to be a [[Pokemon NDS Structure|Pokémon save struct]].

Retrieving the currently offered Pokémon is done by <code>/pokemondpds/worldexchange/return.asp</code>. The response is merely 0x0001; the actual Pokémon data is taken from the <code>get.asp</code> request.

GTS protocol

2010-03-21T02:33:17Z

イーブイ: flesh out the protocol and "commands" a bit, based on mine and LL's sniffing

The following is '''wild conjecture''' based on LordLandon's [http://projectpokemon.org/forums/showthread.php?780-GTC-website-research&p=67086&viewfull=1#post67086 sendpkm.py].

Communication with the GTS is done over regular HTTP with http://gamestats2.gs.nintendowifi.net/. The same protocol is used for all five Gen IV games.

=HTTP headers=

The games don't seem to care about these at all. The GTS sends back a bunch of boilerplate response headers, but the game happily accepts a response with only a Content-Length.

=Protocol=

All requests to the server are GET requests of the form <code><var>page</var>.asp?pid=<var>pid</var>&hash=<var>hash</var>&data=<var>data</var></code>.

==pid==

The pid is an unsigned 32-bit integer that appears to uniquely identify a game cartridge. When the pid is obtained and whether the pid has any relation to the Pal Pad friend code are unknown.

For the mathematically inclined: Eevee's Platinum pid is 192615460 (0x0b7b1424) and his Pal Pad code is 0904 2026 4621.

==Challenge/response==

Before each "real" request, the game sends a request of the form <code><var>page</var>.asp?pid=<var>pid</var></code> and the server responds with a 32-byte hex challenge token. The game computes <code>sha1("sAdeqWo3voLeC5r16DYv" + token)</code> and uses that as the <var>hash</var> value which it sends to the server. The <var>data</var> parameter is encrypted with an unknown algorithm.

That is, each request looks like the following:

# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var></code>
# Server responds with <var>token</var>
# Game requests <code>GET /pokemondpds/<var>page</var>.asp?pid=<var>pid</var>&hash=<var>sha1(...)</var>&data=<var>data</var></code>
# Server responds with payload

Unfortunately, this means that the exact details of the game's requests are currently not known.

=Conversation=

The first request the game makes is to <code>/pokemondpds/worldexchange/info.asp</code>. The server responds with 0x0001.

''Sometimes'', the game will make a request to <code>/pokemondpds/common/setProfile.asp</code>. The server responds with eight NULs (0x00000000 0x00000000). When this occurs and why is unknown; it happened with Eevee's Platinum game but not LordLandon's Diamond/Pearl.

After the above step(s) or '''performing any of the tasks below''', the game makes a request to <code>/pokemondpds/worldexchange/result.asp</code>. If the game has had a Pokémon sent to it (via a successful trade?), the server responds with the entire encrypted [[Pokemon NDS Structure|Pokémon save struct]]. If there is a Pokémon uploaded to the GTS, it responds with 0x0004. Otherwise, it responds with 0x0005.

==Receiving a Pokémon==

If the game receives a Pokémon from a successful trade as a response from <code>result.asp</code>, it next requests <code>/pokemondpds/worldexchange/delete.asp</code>. The server responds with 0x0001.

===A note on sendpkm.py===

After doing the above, some Platinum, Heart Gold, and Soul Silver games will report a communication error and dump the player back to the title screen. The Pokémon is still successfully received. At least one person with HG/SS has received a Pokémon from a fake server without getting the error, and Diamond/Pearl have never been reported to have the problem. It's possible that the server should respond with something other than 0x0001.

==Offering a Pokémon==

Pokémon are offered on the GTS by requesting <code>/pokemondpds/worldexchange/post.asp</code>, followed by <code>/pokemondpds/worldexchange/post_finish.asp</code>.

==Retrieving an offered Pokémon==

Checking on the currently offered Pokémon is apparently done by <code>/pokemondpds/worldexchange/get.asp</code>. The response appears to be a [[Pokemon NDS Structure|Pokémon save struct]].

Retrieving the currently offered Pokémon is done by <code>/pokemondpds/worldexchange/return.asp</code>. The response is merely 0x0001; the actual Pokémon data is taken from the <code>get.asp</code> request.

GTS protocol

2010-03-21T01:18:19Z

イーブイ: http headers

GTS protocol

2010-03-21T01:00:22Z

イーブイ: creatin page, worthless atm