===================================================================================

============
README FILE FOR POKÉMON MYSTERY GIFT EDITOR
===================================================================================
============

-----------------------------------------------------------------------------------
------------
Table of Contents
-----------------------------------------------------------------------------------
------------
1. General Information
2. Changelog
3. Requirements
4. How To Use
a. Save Files
b. Mystery Gifts (Gen IV)
c. Mystery Gifts (Gen V)
d. Error Messages
e. Action Replay
f. Outdated OS or computer
g. Japanese Characters Support
5. Research and Development
6. Thanks
7. Contact

-----------------------------------------------------------------------------------
------------
1. General Information
-----------------------------------------------------------------------------------
------------
Please view this Readme without word wrap enabled.

This program is created by Grovyle91 and is intended to be used with Pokémon

Diamond, Pearl,
Platinum, HeartGold, SoulSilver, Black and White save files.
You are able to edit the Mystery Gifts, import and export Gifts (PGT files) and
Wonder Cards
(PCD) and there's also some basic Pokémon editing available.
For Black and White saves, Mystery Gifts in PGF and PGA format are supported as
well.

-----------------------------------------------------------------------------------
------------
2. Changelog
-----------------------------------------------------------------------------------
------------
v1.4.3 (October 21, 2010)
- SURPRISE! This version supports B/W save files!
You can now edit and save your B/W saves directly in PMGE without needing any
other tools.
- Introducing new file type: PGA, this stands for Pokémon Mystery Gift Album, but
it's not
the same as the old PGA which is now rebranded as PGF. PGA can hold 12 Mystery
Gifts from
Black/White and some other settings regarding the Mystery Gifts in B/W.
Technical information: PGA is the decrypted version of the Mystery Gift Block
in B/W saves.
- Added a feature to add a menu item in context menus of certain file extensions
(requires
installer version).
- Added a feature to create new Mystery Gifts.
- Restored the warning message at start-up for Windows XP users.
- Fixed a display bug when importing PCDs or PGTs in save files.
- Fixed a crash when trying to save settings in a read-only directory.
- Dropping a PGF file on the executable opens the file now.
- Reprogrammed save file support in order to support B/W saves.

v1.4.2 (October 19, 2010)

- Added a beta version of an hex editor for B/W Mystery Gifts.
- Updated B/W Mystery Gift values.
- Some minor and major GUI changes and/or bug fixes, including:
- Windows XP users should have a better GUI rendering now, as well as Vista and
7 users.
- Bug in B/W MG editing solved when editing a byte value (value was seen as
ushort instead
of byte, causing overwriting the next byte which shouldn't happen in any
case).
- When a file size doesn't match it correct size, PMGE will now trim the file
in order to
correct it.
- Added *.dsv, *.0 and *.dat to the list of supported save files.
- Updated some outdated information in the readme file.
- From now on two versions: Setup and Portable.

v1.4.1 (October 12, 2010)

- This version has been delayed too much! I'm very sorry!! :'(
- The program is now written in C# WPF instead of C# WinForms.
- From now on .NET Framework 4.0 is required to run this program!
- GUI has been changed drastically, everything should be readable now on every
computer
without deactivating the background.
- Custom styles for almost every control.
- New design for editing Mystery Gifts only.
- Tabbed editing.
- Updated HGSS compatibility for Action Replay.
- Added basic B/W Mystery Gift editing.
- Kazumi's font updated and moved inside the program.
- Light version of Japanese characters added for the MG Previewer (for non-
Japanese games).

v1.4 beta 3 (March 9, 2010)

- Fixed an "index out of range" error that occured when editing something in the
MG related
editor in a D/P save
- Fixed a problem when dropping a save file on the executable

v1.4 beta 2 (February 14, 2010)

- Fixed the corrupted PNG export in the WC Previewer which occurred on some
computers
- The textboxes Card Title/Comment are wider now so that everything in it is
visible now
- Some other controls are wider now as well to compensate the old Win98 look
- Fixed Korean character mapping in the WC Previewer
- Fixed Pokémon icon positions in the WC Previewer
v1.4 beta (February 6, 2010)
- Added experimental Action Replay DS Code export support
- Changed the Pokemon fonts to kazumi's
- Wonder Cards should now be exactly the same as in-game (thanks to kazumi)
- Added the feature to create a Gift from a Wonder Card
- Added Korean and Dutch (unofficial) language support for the Wonder Card
Previewer
- Added keyboard shortcuts for the Wonder Card Previewer
- You can now drop PGT and PCD files on the window as well, the program will ask
if you want
to overwrite the current Gift/WC
- Changed the numeric controls to dropdown boxes where you can select the current
Gift and/or
Wonder Card
- Raised the maximum value of the Wonder Card IDs up to 2046 since this is
supported in the
save file
- Moved the character table inside the code
- Changed some HGSS exclusive items to their English equalivants, according to
Serebii.net
- Fixed a bug that prevented the checkbox for active Gift/WC in DP save files
from working
correctly

v1.3 (January 21, 2010)

- Code optimization for easier implementation of more save file editing
- Added 256 KB save file support
- Added more Mystery Gift related editing functions (Mystery Gift enabling, used
Wonder Card
IDs)
- Added some more Pokémon editing functions
- Added the Symbol Inserter
- Added the Wonder Card Previewer (Japanese not fully supported, Korean not
implemented yet)
- Fixed bug that will prevent the program loading a Wonder Card when its
distribution amount
is unlimited
- More detailed error messages
- File mismatch: files which aren't Pokémon save files will now throw this
exception
- File size mismatch: files which doesn't equals its correct size won't be
loaded/imported
anymore (which was still possible at certain circumstances)
- Unknown error messages will have a trace from now on, this will help me to
find the bug
easier when reported (just CTRL+C the window to copy the text)

v1.2c (January 12, 2010)

- Fixed bug that prevents the program from determining the active block in
Pt/HG/SS

v1.2b (January 11, 2010)

- Fixed bug that was causing the wrong block shuffling with certain Pokémon when
importing
unencrypted PKM files
- The forgotten Gift PKM import is now also allowed to import unencrypted PKM
files

v1.2a (January 11, 2010)

 - Fixed the "not saving" bug when there's already a backup file
- Fixed the messages which appear when switching to a Pokémon Gift Type without
actually a
Pokémon imported
- Fixed the icon in the window in the Windows 7 taskbar
- The button to change the edit mode is disabled now after dropping a save file
on the
window

v1.2 (January 10, 2010)

- Added unencrypted PKM file support
- Added first PKM editing basics (read-only: editing is not possible yet)
- Added Pokémon icons
- Program is asking now to save the changes when saving the save file if it
hasn't been
saved already

v1.1 (January 6, 2010)

- Internal code optimization
- Added the possibility to edit a PGT or PCD file only (without loading a save
file first)
- Switching between the PGTs or PCDs will not longer revert the changes if they
were not
saved
- Added the option to disable the automatic save file backup
- Fixed Card Value byte (was not updating when the Gift Type was changed)
- User settings are now saved in a *.ini file, instead of a big XML file
- Uses now the game icon(s), instead of text for showing which game the save file
is from
- Program icon changed

v1.0 (January 4, 2010)

- Initial release

-----------------------------------------------------------------------------------
------------
3. Requirements
-----------------------------------------------------------------------------------
------------
In order to run this program, .NET Framework 4.0 or higher must be installed on the
machine
(Windows XP SP3 or higher).

-----------------------------------------------------------------------------------
------------
4. How To Use
-----------------------------------------------------------------------------------
------------
To load a file, you can not only use the Open button, but you can also drop a file
on the
executable or program window.
It will automatically detect if it's a D/P, Pt or HG/SS save or a PGT, PCD or PGF
gift file.
Depending on the file, there will be more or less options available for you to
edit.
-----------------------------------------------------------------------------------
----------
4a. Save Files

-----------------------------------------------------------------------------------
----------
Currently, PMGE supports all Gen IV (D/P, Pt, HG/SS) and Gen V (B/W) saves.
For Generation IV saves it's able to import, export and edit PGT and PCD files.
For Generation V saves it's able to import, export and edit PGA and PGF files.

-----------------------------------------------------------------------------------
----------
4b. Mystery Gifts (Gen IV)

-----------------------------------------------------------------------------------
----------
All Mystery Gifts from the 4th generation games are supported, meaning PCD and PGT
files.

-----------------------------------------------------------------------------------
----------
4c. Mystery Gifts (Gen V)

-----------------------------------------------------------------------------------
----------
Mystery Gifts from the 5th generation games are supported, but limited. Currently,
the
structure of the PGF files is still being researched. Depending on which version of
PMGE you
use, some values may not be available for edit. Please always use the latest
version.

Since version 1.4.3 PMGE introduces the PGA file type, this file can hold 12
Mystery Gifts and
some other settings regarding the Mystery Gift in Gen V games. Basically it's the
decrypted
version of the Mystery Gift Block in the saves. This means you won't be using it
that much,
but when you need to export and import many Gifts at once, it will be easy from now
on ^^.
Please keep in mind while importing it will overwrite all existing Gifts.

-----------------------------------------------------------------------------------
----------
4d. Error Messages

-----------------------------------------------------------------------------------
----------
I've encountered many posts and PMs from people who encoutered an error message.
Mostly this
error message give a detailed description what's causing the error. Please try to
figure out
the problem yourself. If you can't, please report it with FULL details.

-----------------------------------------------------------------------------------
----------
4e. Action Replay

-----------------------------------------------------------------------------------
----------
Since version 1.4 Action Replay export is supported. Although this is just
experimental for
now, it should work in the most cases.

-----------------------------------------------------------------------------------
----------
4f. Outdated OS or computer

-----------------------------------------------------------------------------------
----------
PMGE requires .NET Framework 4.0 and Windows XP SP3 or higher in order to run.
Please keep in
mind that some minor GUI errors may occur when using Windows XP. Windows Vista or
higher
shouldn't have such problems. If, however, it does, you can temporary disable the
custom style
in the settings. Please report the bug as well.

-----------------------------------------------------------------------------------
----------
4g. Japanese Character Support

-----------------------------------------------------------------------------------
----------
It is safe to use any character from a foreign language, as long as it's supported
by the game,
in other words, if it's exist in the character table. If it doesn't, the program
will prevent
from adding it.
If foreign characters are not recognizable (mostly Windows XP), try to enable East
Asian
Language Support in Control Panel -> Date, Time, Language and Regional Options ->
Regional and
Lanuage Options -> Languages.

-----------------------------------------------------------------------------------
------------
5. Research and Development
-----------------------------------------------------------------------------------
------------
- There will be a PKM editor when I've enough spare time.
- If someone knows more Gift Types, please share them with me so I can import it
in this
program.
0x00: (none)
0x01: Pokémon
0x02: Pokémon Egg
0x03: Item
0x04: Rule
0x05: Seal
0x06: Accessory
 0x07: Manaphy Egg
0x08: Member Card
0x09: Oak's Letter
0x0A: Azure Flute
0x0B: Pokétch App
0x0C: Secret Key
0x0D: (unknown)
0x0E: Pokéwalker Area
>=0x0F: (unknown)
- Please also share the Pokéwalker Areas, I might import them in a later version.
- I need someone who can extract and build lists of the Seals, Accessories,
Pokétch Apps
and Pokéwalker Areas. Or someone who has it already.

-----------------------------------------------------------------------------------
------------
6. Thanks
-----------------------------------------------------------------------------------
------------
Without the research of these people, I could possibly not make this program, so
thank you all!

- Jiggy-Ninja, codemonkey85 and mostly kazumi213 who created the character table.
- Sabresite for writing the C# algorithm of the checksum of the save file on the
wiki.
- kazumi213 for the Pokemon DPPt TTF, Poryhack for pointing to it.
- kazumi213 for the various sheets of the Pokemon fonts which helped me creating
Wonder Card
previews that look exactly as the cards in-game.
- codemonkey85 for various suggestions and helping me out in some ways.
- All people who figured out the new B/W Mystery Gifts.
- Bulbapedia for the lists.

I'll also thank the developers of PPSE, without the source being online, it
would've taken much
more time to figure out the encryption and decryption of the PKM files.

And of course I'll thank projectpokemon.org for being such a great site and
everyone who uses
this program!

-----------------------------------------------------------------------------------
------------
7. Contact
-----------------------------------------------------------------------------------
------------
If you want to report a bug, request a feature or something else with this program,
you can
contact me at projectpokemon.org forums under the name Grovyle91, or go directly to
the thread:
http://www.projectpokemon.org/forums/showthread.php?t=6524