PKHeX/README.md

PKHeX
=====

Pokémon GBA/NDS/3DS save editor, programmed in [C#](https://en.wikipedia.org/wiki/C_Sharp_%28programming_language%29).

Supports the following files originating from the Nintendo GBA, NDS, & 3DS:
* Save files ("main", .sav)
* Individual Pokémon entity files (.pk*)
* Mystery Gift files (.pgt, .pcd, .pgf, .wc6) including conversion to .pk*
* Importing teams from Decrypted Battle Videos (X/Y/OR/AS only)
* Transferring of previous generation entities (.pkm) to future generation formats and save files

Data is displayed in a view which can be edited and saved.
The interface can be translated with resource/external text files so that different languages can be supported.

Pokémon Showdown sets can be imported/exported in addition to QR codes.

Nintendo 3DS savedata containers use an AES MAC that cannot be emulated without the 3DS's keys, thus a resigning service is required (svdt, save_manager, or SaveDataFiler).

## Screenshots

![Main Window](http://i.imgur.com/GBub4le.png)

### License

PKHeX is licensed under GPLv3. Refer to LICENSE.md for more information.

## Building

PKHeX can be compiled with any compiler that supports C# 6.0.

### IDE

PKHeX can be opened with MS Visual Studio and [MonoDevelop](http://www.monodevelop.com/) by importing the project with the .sln or .csproj file.

### Command Line

You can use [xbuild of Mono](http://mono-framework.com/Microsoft.Build): `xbuild PKHeX.sln`.

### GNU/Linux

On Debian, you can install MonoDevelop and [Mono](http://www.mono-project.com/) runtime with `sudo apt-get install monodevelop`. GNU/Linux is not the main Operating System of developers of this program so there may be bugs; some may come from non GNU/Linux specific code of Mono (so developers using *BSD, Windows and OS X should be able to reproduce them).
Create README.md 2014-06-28 22:07:46 +00:00			`PKHeX`
			`=====`

Add gba save editing ref to readme #179 2016-08-13 00:18:05 +00:00			`Pokémon GBA/NDS/3DS save editor, programmed in [C#](https://en.wikipedia.org/wiki/C_Sharp_%28programming_language%29).`
Explaining how building a binary 2015-07-20 22:25:20 +00:00
Add gba save editing ref to readme #179 2016-08-13 00:18:05 +00:00			`Supports the following files originating from the Nintendo GBA, NDS, & 3DS:`
Update readme Reflect multiple generation support 2016-06-22 04:54:14 +00:00			`* Save files ("main", .sav)`
			`* Individual Pokémon entity files (.pk*)`
			`* Mystery Gift files (.pgt, .pcd, .pgf, .wc6) including conversion to .pk*`
			`* Importing teams from Decrypted Battle Videos (X/Y/OR/AS only)`
			`* Transferring of previous generation entities (.pkm) to future generation formats and save files`
Update README.md 2014-06-28 22:08:40 +00:00
Update readme Reflect multiple generation support 2016-06-22 04:54:14 +00:00			`Data is displayed in a view which can be edited and saved.`
			`The interface can be translated with resource/external text files so that different languages can be supported.`
Create README.md 2014-06-28 22:07:46 +00:00
Update readme Reflect multiple generation support 2016-06-22 04:54:14 +00:00			`Pokémon Showdown sets can be imported/exported in addition to QR codes.`

			`Nintendo 3DS savedata containers use an AES MAC that cannot be emulated without the 3DS's keys, thus a resigning service is required (svdt, save_manager, or SaveDataFiler).`
Create README.md 2014-06-28 22:07:46 +00:00
Explaining how building a binary 2015-07-20 22:25:20 +00:00			`## Screenshots`

Update readme Reflect multiple generation support 2016-06-22 04:54:14 +00:00			`![Main Window](http://i.imgur.com/GBub4le.png)`
Explaining how building a binary 2015-07-20 22:25:20 +00:00
Add license. 2015-07-21 03:54:07 +00:00			`### License`

			`PKHeX is licensed under GPLv3. Refer to LICENSE.md for more information.`

Explaining how building a binary 2015-07-20 22:25:20 +00:00			`## Building`

Update README.md Updated description to resolve confusion with Issue #70 2016-02-02 04:04:57 +00:00			`PKHeX can be compiled with any compiler that supports C# 6.0.`
Explaining how building a binary 2015-07-20 22:25:20 +00:00
			`### IDE`

Update README.md 2016-01-03 23:35:19 +00:00			`PKHeX can be opened with MS Visual Studio and [MonoDevelop](http://www.monodevelop.com/) by importing the project with the .sln or .csproj file.`
Explaining how building a binary 2015-07-20 22:25:20 +00:00
Update README.md 2016-01-03 23:35:19 +00:00			`### Command Line`
Explaining how building a binary 2015-07-20 22:25:20 +00:00
			You can use [xbuild of Mono](http://mono-framework.com/Microsoft.Build): `xbuild PKHeX.sln`.

			`### GNU/Linux`

Update README.md 2016-01-03 23:35:19 +00:00			On Debian, you can install MonoDevelop and [Mono](http://www.mono-project.com/) runtime with `sudo apt-get install monodevelop`. GNU/Linux is not the main Operating System of developers of this program so there may be bugs; some may come from non GNU/Linux specific code of Mono (so developers using *BSD, Windows and OS X should be able to reproduce them).