ProjectPokemon Wiki - User contributions [en]

GTS protocol

2011-03-16T01:58:50Z

Icehawk78: /* pid */

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></code> followed by <code><var>page</var>.asp?pid=<var>pid</var>&hash=<var>hash</var>&data=<var>data</var></code>. The hash variable in the latter, is a hash of the string returned by the former, as described bellow.

===pid===

The pid is an unsigned 32-bit integer that appears to uniquely identify a game cartridge. Although this has not been confirmed entirely:
Your PID is generated when you get your friendcode for the first time and is set to: friendcode & 0x7fffffff

When you change the device and are forced to change your friendcode with it, your PID doesn't change but you get a new friendcode. Your new Friend Code appears to be set by appending a random byte (likely sent from Nintendo's servers) to the end of your PID. For example, nicholas's Soul Silver PID is 258303618 (0x8266650f)and his Friend Code is 4297 5503 3218 (0xf8266650f64) taking endianness into account.

===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 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, as explained further down.

For 5th gen GTS, the hash is instead, generated by <code>sha1("HZEdGCzcGGLvguqUEKQN" + token)</code>

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

==Data==

The data sent to the server consists of a '''checksum''', your '''pid''', and a '''payload'''. The 5th gen GTS also adds the length of the payload, after the pid.

===Checksum===

The checksum is a 32-bit integer, computed by simply taking the sum of every byte of the pid and payload.

It is the first four bytes of the data, xor-ed with <code>0x4a3b2c1d</code> (<code>0x2db842b2</code> for 5th gen) and packed in network byte order (big-endian).

===Payload===
The pid (, length) and payload are encrypted with a [http://en.wikipedia.org/wiki/Stream_cipher stream cipher] in for the 4th gen protocol.

This encryption algorithm, like others used in the game, uses a [http://en.wikipedia.org/wiki/Linear_congruential_generator Linear Congruential Generator] (not a very strong choice). The multiplicative constant is <code>0x45</code>, and the additive constant is <code>0x1111</code>. It appears that the game uses a signed dword to store the seed, which doesn't really matter; it shouldn't affect anything. (It means that the modulus is effectively <code>0x80000000</code>.)

GRNG[n+1] = (GRNG[n] * 0x45 + 0x1111) & 0x7fffffff

The GRNG is seeded with the <var>checksum</var>, like so:

GRNG[0] = <var>checksum</var> | (<var>checksum</var> << 16)

The keystream is composed of the lower byte of the high word of successive GRNG values.

keystream[n] = (GRNG[n] >> 16) & 0xff

<code>Xor</code> the keystream with the plaintext to get the ciphertext. <code>Xor</code> the keystream with the ciphertext to get the plaintext.

The entire data string is then encoded with [http://en.wikipedia.org/wiki/Base64#URL_applications urlsafe-base64].

==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''' other than searching, 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 trade, the server responds with the entire encrypted [[Pokemon NDS Structure|Pokémon save struct]]. Otherwise, if there is a Pokémon deposited in the GTS, it responds with 0x0004; if not, it responds with 0x0005.

===Receiving a traded 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.

===Depositing a Pokémon===

Pokémon are offered on the GTS by requesting <code>/pokemondpds/worldexchange/post.asp</code>. The sent data is 300 bytes long, and includes the Pokémon struct. If the Pokémon is rejected by the server, the response is 0x000c; otherwise, if the deposit is successful, 0x0001.

The game then saves. After the save is complete, it issues a request to <code>/pokemondpds/worldexchange/post_finish.asp</code>.

===Retrieving the deposited Pokémon===

Checking on the deposited 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 deposited 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.

===Searching===

Searching is done through <code>/pokemondpds/worldexchange/search.asp</code>. The sent data is either 15 or 16 bytes long.

The server responds with a full 292-byte Pokémon struct for each result. If there are <var>n</var> results, the response will be 292 * <var>n</var> bytes long. If there are no results, the server will give an empty response (0 bytes).

==Pokémon struct==

The Pokémon data for the Generation IV GTS is 292 bytes—56 bytes larger than a party Pokémon struct. The extra 56 bytes are GTS-specific data, such as the player's name & country, and what Pokémon they are requesting. In Generation IV, the trainer name is encoded with the Pokémon character table, while in Generation V, the trainer name is Unicode encoded.

They are as follows:

=== Generation IV Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| Timestamp - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| Timestamp - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x2F
| Trainer's Name
|- style="background: #eee;" align="center"
| 0x30-0x31
| Trainer's OT ID
|- style="background: #ddd;" align="center"
| 0x32
| Country
|- style="background: #eee;" align="center"
| 0x33
| City
|- style="background: #ddd;" align="center"
| 0x34
| Trainer's Sprite
|- style="background: #eee;" align="center"
| 0x35
| Is Exchanged Flag
|- style="background: #ddd;" align="center"
| 0x36
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x37
| [[Pokemon NDS Structure#Original Language|Language]]
|}

The data for the Generation V GTS is 296 bytes and adds the trainer's secret ID, an additional two unknown bytes at the end, and shifts the position of the trainer name to after the trainer and secret IDs.

=== Generation V Encrypted Bytes ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Nat. Dex ID
|- style="background: #ddd;" align="center"
| 0x02
| [[#Pokémon Gender|Gender]]
|- style="background: #eee;" align="center"
| 0x03
| Level
|- style="background: #ddd;" align="center"
| 0x04-0x05
| Requested Nat. Dex ID
|- style="background: #eee;" align="center"
| 0x06
| [[#Pokémon Gender|Requested Gender]]
|- style="background: #ddd;" align="center"
| 0x07
| Requested Min Level
|- style="background: #eee;" align="center"
| 0x08
| Requested Max Level
|- style="background: #ddd;" align="center"
| 0x09
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0A
| [[#Trainer Gender|Trainer's Gender]]
|- style="background: #ddd;" align="center"
| 0x0B
| ''Unknown'' - always 0?
|- style="background: #eee;" align="center"
| 0x0C-0x13
| [[#Timestamp Format|Timestamp]] - deposited time
|- style="background: #ddd;" align="center"
| 0x14-0x1B
| [[#Timestamp Format|Timestamp]] - time traded?
|- style="background: #eee;" align="center"
| 0x1C-0x1F
| PID
|- style="background: #ddd;" align="center"
| 0x20-0x21
| Trainer's OT ID
|- style="background: #eee;" align="center"
| 0x22-0x23
| Trainer's Secret ID
|- style="background: #ddd;" align="center"
| 0x24-0x33
| Trainer's Name
|- style="background: #ddd;" align="center"
| 0x34
| Country
|- style="background: #eee;" align="center"
| 0x35
| City
|- style="background: #ddd;" align="center"
| 0x36
| Trainer's Sprite
|- style="background: #eee;" align="center"
| 0x37
| [[#Alternate Form|Alternate Form]]
|- style="background: #ddd;" align="center"
| 0x38
| [[#Game Version|Game Version]]
|- style="background: #eee;" align="center"
| 0x39
| [[Pokemon Black/White NDS Structure#Original Language|Language]]
|- style="background: #ddd;" align="center"
| 0x3A-0x3B
| ''Unknown'' - always 0?
|}

=== Pokémon Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x01
| Male
|- style="background: #ddd;" align="center"
| 0x02
| Female
|- style="background: #eee;" align="center"
| 0x03
| Either/neither
|}

=== Trainer Gender ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Type
|- style="background: #eee;" align="center"
| 0x00
| Male
|- style="background: #ddd;" align="center"
| 0x01
| Female
|}

=== Timestamp Format ===
The timestamps are set by the server, and are always PST (UTC-8).
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Offset
! Contents
|- style="background: #eee;" align="center"
| 0x00-0x01
| Year
|- style="background: #ddd;" align="center"
| 0x02
| Month
|- style="background: #eee;" align="center"
| 0x03
| Day
|- style="background: #ddd;" align="center"
| 0x04
| Hour
|- style="background: #eee;" align="center"
| 0x05
| Minute
|- style="background: #ddd;" align="center"
| 0x06
| Second
|- style="background: #eee;" align="center"
| 0x07
| ''Unknown'' - always 0?
|}

=== Alternate Form ===
The normal/default form is 0x01; if it is another form, this byte will correspond to the appropriate [[Pokemon Black/White NDS Structure#Alternate Forms|Pokémon structure alternate form]].

=== Game Version ===
{| border="1" style="border: 1px solid #999; border-collapse: collapse;"
|- style="background: #ccc;" align="center"
! Value
! Version
|- style="background: #eee;" align="center"
| 0x0A
| Diamond
|- style="background: #ddd;" align="center"
| 0x0B
| Pearl
|- style="background: #eee;" align="center"
| 0x0C
| Platinum
|- style="background: #ddd;" align="center"
| 0x07
| HeartGold
|- style="background: #eee;" align="center"
| 0x08
| SoulSilver
|- style="background: #ddd;" align="center"
| 0x15
| Black
|- style="background: #eee;" align="center"
| 0x14
| White
|}

Pokemon Black/White Save Structure

2011-03-10T15:50:13Z

Icehawk78: Reverted edits by Icehawk78 (talk) to last revision by Kaphotics

Pokémon in the games Pokémon [[Pokémon Black|Black]] and [[Pokemon White|White]] are stored in a 136 byte or 220 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 ==

<Placeholder>

== Block Shuffling ==

<Placeholder>

== Encryption ==

<Placeholder>

== 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
| Nature
|- style="background: #eee;" align="center"
| 0x42
| HasDreamWorldAbility Flag
|- style="background: #ddd;" align="center"
| 0x43
| ''Unused''
|- style="background: #eee;" align="center"
| 0x44-0x45
| ''Deleted / Unused''
|- style="background: #ddd;" align="center"
| 0x46-0x47
| ''Deleted / Unused''
|}

=== 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 ==

Encounter types are not used in Black and White. Pokeshifted Pokemon keep their Encounter Type hex.

{| 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 and Daycare Pokémon is 220 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]]

Pokemon Black/White Save Structure

2011-03-10T15:37:48Z

Icehawk78: /* Block A */

GTS protocol

2010-09-25T13:54:41Z

Icehawk78: /* Protocol */

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===

(4th Gen)

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 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, as explained further down.

(5th gen)

The process is mostly the same, except that the response hash is <code>sha1("HZEdGCzcGGLvguqUEKQN" + token)</code>

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

The exact details of the game's requests are not currently known, but we are working on it!

===Checksum===

A 32-bit checksum of the data is used as the key for the encryption. The checksum is simply the sum of every byte of the data.

The first 4 bytes of the sent data are the checksum, <code>xor</code>ed with <code>0x4a3b2c1d</code>, and sent in network byte order (big-endian).

===Encryption===

The data sent to the server is encrypted with a [http://en.wikipedia.org/wiki/Stream_cipher stream cipher], and [http://en.wikipedia.org/wiki/Base64#URL_applications urlsafe-base64]-encoded.

This encryption algorithm, like others used in the game, uses a [http://en.wikipedia.org/wiki/Linear_congruential_generator Linear Congruential Generator] (not a very strong choice). The multiplicative constant is <code>0x45</code>, and the additive constant is <code>0x1111</code>. It appears that the game uses a signed dword to store the seed, which doesn't really matter; it shouldn't affect anything. (It means that the modulus is effectively <code>0x80000000</code>.)

GRNG[n+1] = (GRNG[n] * 0x45 + 0x1111) & 0x7fffffff

The GRNG is seeded with the <var>checksum</var>, like so:

GRNG[0] = <var>checksum</var> | (<var>checksum</var> << 16)

The keystream is composed of the lower byte of the high word of successive GRNG values.

keystream[n] = (GRNG[n] >> 16) & 0xff

<code>Xor</code> the keystream with the plaintext to get the ciphertext. <code>Xor</code> the keystream with the ciphertext to get the plaintext.

==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''' other than searching, 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 trade, the server responds with the entire encrypted [[Pokemon NDS Structure|Pokémon save struct]]. Otherwise, if there is a Pokémon deposited in the GTS, it responds with 0x0004; if not, it responds with 0x0005.

===Receiving a traded 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.

===Depositing a Pokémon===

Pokémon are offered on the GTS by requesting <code>/pokemondpds/worldexchange/post.asp</code>. The sent data is 300 bytes long, and includes the Pokémon struct. If the Pokémon is rejected by the server, the response is 0x000c; otherwise, if the deposit is successful, 0x0001.

The game then saves. After the save is complete, it issues a request to <code>/pokemondpds/worldexchange/post_finish.asp</code>.

===Retrieving the deposited Pokémon===

Checking on the deposited 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 deposited 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.

===Searching===

Searching is done through <code>/pokemondpds/worldexchange/search.asp</code>. The sent data is either 15 or 16 bytes long.

The server responds with a full 292-byte Pokémon struct for each result. If there are <var>n</var> results, the response will be 292 * <var>n</var> bytes long. If there are no results, the server will give an empty response (0 bytes).

==Pokémon struct==

The Pokémon data for the GTS is 292 bytes—56 bytes larger than a party Pokémon struct. The extra 56 bytes are GTS-specific data, such as the player's name & country, and what Pokémon they are requesting.

They are as follows:

<pre>
0x00-0x01 Current Pokémon
0x02 Gender 1=male; 2=female; 3=either/neither
0x03 Level
0x04-0x05 Requested Pokémon
0x06 Gender
0x07 Min level
0x08 Max level
0x09 always 0?
0x0A Trainer Gender 0=male; 1=female
0x0B always 0?
0x0C-0x13 Timestamp - Deposited time
0x14-0x1B Timestamp - Time traded away?
0x1c-0x1F pid - also 0x4c in the sav
0x20-0x2F Trainer Name
0x30-0x31 Trainer ID
0x32 Country
0x33 City
0x34 Trainer Sprite
0x35 Exchanged flag
0x36 Version 0x0A=Diamond; 0x0B=Pearl; ...
0x37 Language 1=jp; 2=en; 3=fr; ...
</pre>

The timestamps are set by the server, and are always PST (UTC-8). Timestamp format:
<pre>
0x00-0x01 Year
0x02 Month
0x03 Day
0x04 Hour
0x05 Minute
0x06 Second
0x07 always 0?
</pre>

List of Diamond, Pearl, Platinum, HeartGold and SoulSilver Items by Index Number

2009-12-13T18:32:56Z

Icehawk78: /* HeartGold and SoulSilver Exclusive Key Items */

===Balls===

{{main|Pokéballs}}

: 0x0001 = Master Ball
: 0x0002 = Ultra Ball
: 0x0003 = Great Ball
: 0x0004 = Poké Ball
: 0x0005 = Safari Ball
: 0x0006 = Net Ball
: 0x0007 = Dive Ball
: 0x0008 = Nest Ball
: 0x0009 = Repeat Ball
: 0x000A = Timer Ball
: 0x000B = Luxury Ball
: 0x000C = Premier Ball
: 0x000D = Dusk Ball
: 0x000E = Heal Ball
: 0x000F = Quick Ball
: 0x0010 = Cherish Ball

===Medicine===

{{main|Medicine}}

: 0x0011 = Potion
: 0x0012 = Antidote
: 0x0013 = Burn Heal
: 0x0014 = Ice Heal
: 0x0015 = Awakening
: 0x0016 = Parlyz Heal
: 0x0017 = Full Restore
: 0x0018 = Max Potion
: 0x0019 = Hyper Potion
: 0x001A = Super Potion
: 0x001B = Full Heal
: 0x001C = Revive
: 0x001D = Max Revive
: 0x001E = Fresh Water
: 0x001F = Soda Pop
: 0x0020 = Lemonade
: 0x0021 = Moomoo Milk
: 0x0022 = EnergyPowder
: 0x0023 = Energy Root
: 0x0024 = Heal Powder
: 0x0025 = Revival Herb
: 0x0026 = Ether
: 0x0027 = Max Ether
: 0x0028 = Elixir
: 0x0029 = Max Elixir
: 0x002A = Lava Cookie
: 0x002B = Berry Juice
: 0x002C = Sacred Ash
: 0x002D = HP Up
: 0x002E = Protein
: 0x002F = Iron
: 0x0030 = Carbos
: 0x0031 = Calcium
: 0x0032 = Rare Candy
: 0x0033 = PP Up
: 0x0034 = Zinc
: 0x0035 = PP Max
: 0x0036 = Old Gateau

===Battle Items===

{{main|Battle items}}

: 0x0037 = Guard Spec.
: 0x0038 = Dire Hit
: 0x0039 = X Attack
: 0x003A = X Defend
: 0x003B = X Speed
: 0x003C = X Accuracy
: 0x003D = X Special
: 0x003E = X Sp. Def
: 0x003F = Poké Doll
: 0x0040 = Fluffy Tail
: 0x0041 = Blue Flute
: 0x0042 = Yellow Flute
: 0x0043 = Red Flute
: 0x0044 = Black Flute
: 0x0045 = White Flute

===General Items 1===

{{main|Other items}}

: 0x0046 = Shoal Salt
: 0x0047 = Shoal Shell
: 0x0048 = Red Shard
: 0x0049 = Blue Shard
: 0x004A = Yellow Shard
: 0x004B = Green Shard
: 0x004C = Super Repel
: 0x004D = Max Repel
: 0x004E = Escape Rope
: 0x004F = Repel
: 0x0050 = Sun Stone
: 0x0051 = Moon Stone
: 0x0052 = Fire Stone
: 0x0053 = Thunderstone
: 0x0054 = Water Stone
: 0x0055 = Leaf Stone
: 0x0056 = TinyMushroom
: 0x0057 = Big Mushroom
: 0x0058 = Pearl
: 0x0059 = Big Pearl
: 0x005A = Stardust
: 0x005B = Star Piece
: 0x005C = Nugget
: 0x005D = Heart Scale
: 0x005E = Honey
: 0x005F = Growth Mulch
: 0x0060 = Damp Mulch
: 0x0061 = Stable Mulch
: 0x0062 = Gooey Mulch
: 0x0063 = Root Fossil
: 0x0064 = Claw Fossil
: 0x0065 = Helix Fossil
: 0x0066 = Dome Fossil
: 0x0067 = Old Amber
: 0x0068 = Armor Fossil
: 0x0069 = Skull Fossil
: 0x006A = Rare Bone
: 0x006B = Shiny Stone
: 0x006C = Dusk Stone
: 0x006D = Dawn Stone
: 0x006E = Oval Stone
: 0x006F = Odd Keystone
: 0x0070 = Griseous Orb ([[Platinum]] only)
: 0x0087 = Adamant Orb
: 0x0088 = Lustrous Orb

===Mail===

{{main|Mail}}

: 0x0089 = Grass Mail
: 0x008A = Flame Mail
: 0x008B = Bubble Mail
: 0x008C = Bloom Mail
: 0x008D = Tunnel Mail
: 0x008E = Steel Mail
: 0x008F = Heart Mail
: 0x0090 = Snow Mail
: 0x0091 = Space Mail
: 0x0092 = Air Mail
: 0x0093 = Mosaic Mail
: 0x0094 = Brick Mail

===Berries===

{{main|Berries}}

: 0x0095 = Cheri Berry
: 0x0096 = Chesto Berry
: 0x0097 = Pecha Berry
: 0x0098 = Rawst Berry
: 0x0099 = Aspear Berry
: 0x009A = Leppa Berry
: 0x009B = Oran Berry
: 0x009C = Persim Berry
: 0x009D = Lum Berry
: 0x009E = Sitrus Berry
: 0x009F = Figy Berry
: 0x00A0 = Wiki Berry
: 0x00A1 = Mago Berry
: 0x00A2 = Aguav Berry
: 0x00A3 = Iapapa Berry
: 0x00A4 = Razz Berry
: 0x00A5 = Bluk Berry
: 0x00A6 = Nanab Berry
: 0x00A7 = Wepear Berry
: 0x00A8 = Pinap Berry
: 0x00A9 = Pomeg Berry
: 0x00AA = Kelpsy Berry
: 0x00AB = Qualot Berry
: 0x00AC = Hondew Berry
: 0x00AD = Grepa Berry
: 0x00AE = Tamato Berry
: 0x00AF = Cornn Berry
: 0x00B0 = Magost Berry
: 0x00B1 = Rabuta Berry
: 0x00B2 = Nomel Berry
: 0x00B3 = Spelon Berry
: 0x00B4 = Pamtre Berry
: 0x00B5 = Watmel Berry
: 0x00B6 = Durin Berry
: 0x00B7 = Belue Berry
: 0x00B8 = Occa Berry
: 0x00B9 = Passho Berry
: 0x00BA = Wacan Berry
: 0x00BB = Rindo Berry
: 0x00BC = Yache Berry
: 0x00BD = Chople Berry
: 0x00BE = Kebia Berry
: 0x00BF = Shuca Berry
: 0x00C0 = Coba Berry
: 0x00C1 = Payapa Berry
: 0x00C2 = Tanga Berry
: 0x00C3 = Charti Berry
: 0x00C4 = Kasib Berry
: 0x00C5 = Haban Berry
: 0x00C6 = Colbur Berry
: 0x00C7 = Babiri Berry
: 0x00C8 = Chilan Berry
: 0x00C9 = Liechi Berry
: 0x00CA = Ganlon Berry
: 0x00CB = Salac Berry
: 0x00CC = Petaya Berry
: 0x00CD = Apicot Berry
: 0x00CE = Lansat Berry
: 0x00CF = Starf Berry
: 0x00D0 = Enigma Berry
: 0x00D1 = Micle Berry
: 0x00D2 = Custap Berry
: 0x00D3 = Jaboca Berry
: 0x00D4 = Rowap Berry

===General Items 2 (Held Items)===

{{main|Hold items}}

: 0x00D5 = BrightPowder
: 0x00D6 = White Herb
: 0x00D7 = Macho Brace
: 0x00D8 = Exp. Share
: 0x00D9 = Quick Claw
: 0x00DA = Soothe Bell
: 0x00DB = Mental Herb
: 0x00DC = Choice Band
: 0x00DD = King's Rock
: 0x00DE = SilverPowder
: 0x00DF = Amulet Coin
: 0x00E0 = Cleanse Tag
: 0x00E1 = Soul Dew
: 0x00E2 = DeepSeaTooth
: 0x00E3 = DeepSeaScale
: 0x00E4 = Smoke Ball
: 0x00E5 = Everstone
: 0x00E6 = Focus Band
: 0x00E7 = Lucky Egg
: 0x00E8 = Scope Lens
: 0x00E9 = Metal Coat
: 0x00EA = Leftovers
: 0x00EB = Dragon Scale
: 0x00EC = Light Ball
: 0x00ED = Soft Sand
: 0x00EE = Hard Stone
: 0x00EF = Miracle Seed
: 0x00F0 = BlackGlasses
: 0x00F1 = Black Belt
: 0x00F2 = Magnet
: 0x00F3 = Mystic Water
: 0x00F4 = Sharp Beak
: 0x00F5 = Poison Barb
: 0x00F6 = NeverMeltIce
: 0x00F7 = Spell Tag
: 0x00F8 = TwistedSpoon
: 0x00F9 = Charcoal
: 0x00FA = Dragon Fang
: 0x00FB = Silk Scarf
: 0x00FC = Up-Grade
: 0x00FD = Shell Bell
: 0x00FE = Sea Incense
: 0x00FF = Lax Incense
: 0x0100 = Lucky Punch
: 0x0101 = Metal Powder
: 0x0102 = Thick Club
: 0x0103 = Stick
: 0x0104 = Red Scarf
: 0x0105 = Blue Scarf
: 0x0106 = Pink Scarf
: 0x0107 = Green Scarf
: 0x0108 = Yellow Scarf
: 0x0109 = Wide Lens
: 0x010A = Muscle Band
: 0x010B = Wise Glasses
: 0x010C = Expert Belt
: 0x010D = Light Clay
: 0x010E = Life Orb
: 0x010F = Power Herb
: 0x0110 = Toxic Orb
: 0x0111 = Flame Orb
: 0x0112 = Quick Powder
: 0x0113 = Focus Sash
: 0x0114 = Zoom Lens
: 0x0115 = Metronome
: 0x0116 = Iron Ball
: 0x0117 = Lagging Tail
: 0x0118 = Destiny Knot
: 0x0119 = Black Sludge
: 0x011A = Icy Rock
: 0x011B = Smooth Rock
: 0x011C = Heat Rock
: 0x011D = Damp Rock
: 0x011E = Grip Claw
: 0x011F = Choice Scarf
: 0x0120 = Sticky Barb
: 0x0121 = Power Bracer
: 0x0122 = Power Belt
: 0x0123 = Power Lens
: 0x0124 = Power Band
: 0x0125 = Power Anklet
: 0x0126 = Power Weight
: 0x0127 = Shed Shell
: 0x0128 = Big Root
: 0x0129 = Choice Specs
: 0x012A = Flame Plate
: 0x012B = Splash Plate
: 0x012C = Zap Plate
: 0x012D = Meadow Plate
: 0x012E = Icicle Plate
: 0x012F = Fist Plate
: 0x0130 = Toxic Plate
: 0x0131 = Earth Plate
: 0x0132 = Sky Plate
: 0x0133 = Mind Plate
: 0x0134 = Insect Plate
: 0x0135 = Stone Plate
: 0x0136 = Spooky Plate
: 0x0137 = Draco Plate
: 0x0138 = Dread Plate
: 0x0139 = Iron Plate
: 0x013A = Odd Incense
: 0x013B = Rock Incense
: 0x013C = Full Incense
: 0x013D = Wave Incense
: 0x013E = Rose Incense
: 0x013F = Luck Incense
: 0x0140 = Pure Incense
: 0x0141 = Protector
: 0x0142 = Electirizer
: 0x0143 = Magmarizer
: 0x0144 = Dubious Disc
: 0x0145 = Reaper Cloth
: 0x0146 = Razor Claw
: 0x0147 = Razor Fang

===TMs & HMs===

{{main|TMs and HMs}}

: 0x0148 = TM01
: 0x0149 = TM02
: 0x014A = TM03
: 0x014B = TM04
: 0x014C = TM05
: 0x014D = TM06
: 0x014E = TM07
: 0x014F = TM08
: 0x0150 = TM09
: 0x0151 = TM10
: 0x0152 = TM11
: 0x0153 = TM12
: 0x0154 = TM13
: 0x0155 = TM14
: 0x0156 = TM15
: 0x0157 = TM16
: 0x0158 = TM17
: 0x0159 = TM18
: 0x015A = TM19
: 0x015B = TM20
: 0x015C = TM21
: 0x015D = TM22
: 0x015E = TM23
: 0x015F = TM24
: 0x0160 = TM25
: 0x0161 = TM26
: 0x0162 = TM27
: 0x0163 = TM28
: 0x0164 = TM29
: 0x0165 = TM30
: 0x0166 = TM31
: 0x0167 = TM32
: 0x0168 = TM33
: 0x0169 = TM34
: 0x016A = TM35
: 0x016B = TM36
: 0x016C = TM37
: 0x016D = TM38
: 0x016E = TM39
: 0x016F = TM40
: 0x0170 = TM41
: 0x0171 = TM42
: 0x0172 = TM43
: 0x0173 = TM44
: 0x0174 = TM45
: 0x0175 = TM46
: 0x0176 = TM47
: 0x0177 = TM48
: 0x0178 = TM49
: 0x0179 = TM50
: 0x017A = TM51
: 0x017B = TM52
: 0x017C = TM53
: 0x017D = TM54
: 0x017E = TM55
: 0x017F = TM56
: 0x0180 = TM57
: 0x0181 = TM58
: 0x0182 = TM59
: 0x0183 = TM60
: 0x0184 = TM61
: 0x0185 = TM62
: 0x0186 = TM63
: 0x0187 = TM64
: 0x0188 = TM65
: 0x0189 = TM66
: 0x018A = TM67
: 0x018B = TM68
: 0x018C = TM69
: 0x018D = TM70
: 0x018E = TM71
: 0x018F = TM72
: 0x0190 = TM73
: 0x0191 = TM74
: 0x0192 = TM75
: 0x0193 = TM76
: 0x0194 = TM77
: 0x0195 = TM78
: 0x0196 = TM79
: 0x0197 = TM80
: 0x0198 = TM81
: 0x0199 = TM82
: 0x019A = TM83
: 0x019B = TM84
: 0x019C = TM85
: 0x019D = TM86
: 0x019E = TM87
: 0x019F = TM88
: 0x01A0 = TM89
: 0x01A1 = TM90
: 0x01A2 = TM91
: 0x01A3 = TM92
: 0x01A4 = HM01
: 0x01A5 = HM02
: 0x01A6 = HM03
: 0x01A7 = HM04
: 0x01A8 = HM05
: 0x01A9 = HM06
: 0x01AA = HM07
: 0x01AB = HM08

===Key Items===

{{main|Key items}}

: 0x01AC = Explorer Kit
: 0x01AD = Loot Sack
: 0x01AE = Rule Book
: 0x01AF = Poké Radar
: 0x01B0 = Point Card
: 0x01B1 = Journal
: 0x01B2 = Seal Case
: 0x01B3 = Fashion Case
: 0x01B4 = Seal Bag
: 0x01B5 = Pal Pad
: 0x01B6 = Works Key
: 0x01B7 = Old Charm
: 0x01B8 = Galactic Key
: 0x01B9 = Red Chain
: 0x01BA = Town Map
: 0x01BB = Vs. Seeker
: 0x01BC = Coin Case
: 0x01BD = Old Rod
: 0x01BE = Good Rod
: 0x01BF = Super Rod
: 0x01C0 = Sprayduck
: 0x01C1 = Poffin Case
: 0x01C2 = Bicycle
: 0x01C3 = Suite Key
: 0x01C4 = Oak's Letter
: 0x01C5 = Lunar Wing
: 0x01C6 = Member Card
: 0x01C7 = Azure Flute
: 0x01C8 = S.S. Ticket
: 0x01C9 = Contest Pass
: 0x01CA = Magma Stone
: 0x01CB = Parcel
: 0x01CC = Coupon 1
: 0x01CD = Coupon 2
: 0x01CE = Coupon 3
: 0x01CF = Storage Key
: 0x01D0 = SecretPotion
: 0x01D1 = Vs. Recorder ([[Platinum]] only)
: 0x01D2 = Gracidea Flower (Platinum only)
: 0x01D3 = Secret Key (Platinum only)

===HeartGold and SoulSilver Exclusive Balls===

{{main|Pokéballs}}

: 0x01EC = Fast Ball
: 0x01ED = Level Ball
: 0x01EE = Lure Ball
: 0x01EF = Heavy Ball
: 0x01F0 = Love Ball
: 0x01F1 = Friend Ball
: 0x01F2 = Moon Ball
: 0x01F3 = Competition Ball
: 0x01F4 = Park Ball

=== HeartGold and SoulSilver Exclusive Key Items ===

{{main|Key items}}

: 0x01D4 = ぼんぐりケース (Apricorn Case)
: 0x01D5 = アンノーンノート (Unown Notebook)
: 0x01D6 = きのみプランター (Berry Planter)
: 0x01D7 = ダウジングマシン (Dowsing Machine)
: 0x01D8 = ブルーカード (Blue Card)
: 0x01D9 = おいしいシッポ (Slowpoke Tail)
: 0x01DA = とうめいなスズ (Clear Bell)
: 0x01DB = カードキー (Card Key)
: 0x01DC = ちかのかぎ (Basement Key)
: 0x01DD = ゼニガメじょうろ (Squirtbottle)
: 0x01DE = あかいウロコ (Red Scale)
: 0x01DF = おとしもの (Lost Property)
: 0x01E0 = リニアパス (Linear Pass)
: 0x01E1 = きかいのぶひん (Weird Part)
: 0x01E2 = ぎんいろのはね (Silver Wing)
: 0x01E3 = にじいろのはね (Rainbow Wing)
: 0x01E4 = ふしぎなタマゴ (Mystery Egg)
: 0x01E5 = Red Apricorn
: 0x01E6 = Yellow Apricorn
: 0x01E7 = Blue Apricorn
: 0x01E8 = Green Apricorn
: 0x01E9 = Pink Apricorn
: 0x01EA = White Apricorn
: 0x01EB = Black Apricorn
: 0x01F5 = フォトアルバム (Photo Album)
: 0x01F6 = ＧＢプレイヤー (GB Player)
: 0x01F7 = うみなりのスズ (Sea Bell)
: 0x01F8 = いかりまんじゅう (Manju Anchor?)
: 0x01F9 = データカード０１ (Date Card 01)
: 0x01FA = データカード０２ (Date Card 02)
: 0x01FB = データカード０３ (Date Card 03)
: 0x01FC = データカード０４ (Date Card 04)
: 0x01FD = データカード０５ (Date Card 05)
: 0x01FE = データカード０６ (Date Card 06)
: 0x01FF = データカード０７ (Date Card 07)
: 0x0200 = データカード０８ (Date Card 08)
: 0x0201 = データカード０９ (Date Card 09)
: 0x0202 = データカード１０ (Date Card 10)
: 0x0203 = データカード１１ (Date Card 11)
: 0x0204 = データカード１２ (Date Card 12)
: 0x0205 = データカード１３ (Date Card 13)
: 0x0206 = データカード１４ (Date Card 14)
: 0x0207 = データカード１５ (Date Card 15)
: 0x0208 = データカード１６ (Date Card 16)
: 0x0209 = データカード１７ (Date Card 17)
: 0x020A = データカード１８ (Date Card 18)
: 0x020B = データカード１９ (Date Card 19)
: 0x020C = データカード２０ (Date Card 20)
: 0x020D = データカード２１ (Date Card 21)
: 0x020E = データカード２２ (Date Card 22)
: 0x020F = データカード２３ (Date Card 23)
: 0x0210 = データカード２４ (Date Card 24)
: 0x0211 = データカード２５ (Date Card 25)
: 0x0212 = データカード２６ (Date Card 26)
: 0x0213 = データカード２７ (Date Card 27)
: 0x0214 = もえぎいろのたま (Green Orb)
: 0x0215 = ロックカプセル (Rock Capsule)
: 0x0216 = べにいろのたま (Red Orb)
: 0x0217 = あいいろのたま (Blue Orb)
: 0x0218 = なぞのすいしょう (Crystal Puzzle)

Pokemon Save Structure

2009-12-13T16:12:10Z

Icehawk78: /* Unencrypted bytes */

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 this table:

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

Honey Tree

2009-02-26T04:44:56Z

Icehawk78:

==Game mechanics==
Once [[Honey]] is placed on a honey tree and at least 12 hours have passed, a Pokémon will appear on the tree. If a tree is left unchecked for 24 hours, both the honey and the Pokémon will be gone.

The location of the honey tree does not affect which Pokémon will appear. The amount of Honey applied and the amount of time passed before checking a tree will also not affect the resulting Pokémon.

Saving the game, resetting, and re-checking a tree after a Pokémon has appeared will not change the Pokémon, but its [[level]], [[gender]], [[nature]], [[individual values|IVs]], and other random values will change. This is helpful for finding a male or female [[Burmy]], which will have different [[evolution|evolutions]] depending on their gender, or [[Combee]], which only evolves if female.

If used in tall grass, a cave, or in water, the Honey will activate a [[Sweet Scent]] effect, immediately initiating battle with a Pokémon if possible.

==Technical mechanics==
Each of the 21 Honey trees throughout the game occupy 8 bytes in the save file starting from 0x72E4.

<code>0000000000000000</code>

The red value represents the countdown timer of playing time. This value starts at 1440 minutes and when it reaches 720 minutes, the Pokémon will be on the tree. Once the countdown timer gets to 0, the player must put more honey on the tree and time has expired. The counter decreases by 1 every minute while playing the game.

The light blue value represents the column for which Pokémon will appear.

The dark blue value represents the row for which the Pokémon will appear.

The green value represents how the next Pokémon will be determined.

The yellow value represents how much the tree will shake when the Pokémon is on it. This value is determined by the weight of the Pokémon. Some Pokémon such as [[Wurmple]] will not shake the tree at all, and the value will be 0. Other Pokémon such as [[Heracross]] will shake the tree quite a bit, and the value will be 2.

===Determining the Pokémon===
The Pokémon is determined by calling the game's [[PRNG in Pokémon|pseudo-random number generator]] twice, once for the column and once for the row. The PRNG result is put into the following calculation:

Let ''R'' be the result of the PRNG.
Let ''P'' be the percentage as a result of the equation:
''P = ( R >> 16 ) % 100''

For the column, if the number ''P'' is between 0 and 10, a Pokémon from list 1 will be chosen. If the number is between 11 and 30, [[Munchlax]] will be chosen. If the number is between 31 and 100, a Pokémon from list 2 will be chosen.

For the row, if the number ''P'' is between 0 and 5, row 6 is used. If the number is between 6 and 10, row 5 is used. If the number is between 11 and 20, row 4 is used. If the number is between 21 and 40, row 3 is used. If the number is between 41 and 60, row 2 is used. If the number is between 61 and 100, row 1 is used.

This table displays the percentage chance for each row and column separately, as used by the game to determine which Pokémon will be on the Honey Tree.

{| border=1 align="left" style="background: #fff; border:1px solid #000; border-collapse:collapse;"
!
! colspan="3" | Diamond/Pearl
! colspan="3" | Platinum
|- style="background: #C0C0FF;"
! Freq.
! List 1 (10%)
! List 2 (70%)
! List 3 (20%)
! List 1 (10%)
! List 2 (70%)
! List 3 (20%)
|- align="center"
| Pokémon 1 (5%)
| Wurmple
| Combee
| Munchlax
| Combee
| Burmy
| Munchlax
|- align="center"
| Pokémon 2 (5%)
| Silcoon/Cascoon
| Burmy
| Munchlax
| Wurmple
| Cherubi
| Munchlax
|- align="center"
| Pokémon 3 (10%)
| Combee
| Cherubi
| Munchlax
| Burmy
| Combee
| Munchlax
|- align="center"
| Pokemon 4 (20%)
| Burmy
| Aipom
| Munchlax
| Cherubi
| Aipom
| Munchlax
|- align="center"
| Pokemon 5 (20%)
| Cherubi
| Heracross
| Munchlax
| Aipom
| Aipom
| Munchlax
|- align="center"
| Pokemon 6 (40%)
| Aipom
| Wurmple
| Munchlax
| Aipom
| Heracross
| Munchlax
|}

=== Locations ===

=== Pokemon ===

=== References ===