PKHeX/README.md

PKHeX
=====

Pokémon X/Y/OR/AS SAV/PKX file editor, programmed in [C#](https://en.wikipedia.org/wiki/C_Sharp_%28programming_language%29).

Supports binary file loading of the following files originating from the Nintendo 3DS:
* Decrypted Save files (1MB/Cyber Save 0x65600/0x76000 Bytes)
* Individual entity files (232/260 bytes), saved as .pk6 and .ek6
* Conversion of Event Gift files (.wc6) to .pk6
* Decrypted Battle Videos
 
The following files from previous generations of games are supported:
* Transferring of previous generation entities (.pkm) to .pk6
* Conversion of Event Files (.pgt, .pcd, .pgf) to .pk6

Data is then displayed in a meaningful view, and can be edited and saved back to binary data.
Since the Nintendo 3DS savedata containers use an AES MAC that cannot be emulated without the 3DS's keys, a resigning service is required (svdt, save_manager, or SaveDataFiler).

The interface is translatable with resource/external text files so that different languages can be supported.

## Screenshots

![Main Window](http://i.snag.gy/dGdB4.jpg?raw=true)

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

Explaining how building a binary 2015-07-20 22:25:20 +00:00			`Pokémon X/Y/OR/AS SAV/PKX file editor, programmed in [C#](https://en.wikipedia.org/wiki/C_Sharp_%28programming_language%29).`

Update README.md 2016-01-03 23:35:19 +00:00			`Supports binary file loading of the following files originating from the Nintendo 3DS:`
Explaining how building a binary 2015-07-20 22:25:20 +00:00			`* Decrypted Save files (1MB/Cyber Save 0x65600/0x76000 Bytes)`
Update README.md 2016-01-03 23:35:19 +00:00			`* Individual entity files (232/260 bytes), saved as .pk6 and .ek6`
			`* Conversion of Event Gift files (.wc6) to .pk6`
			`* Decrypted Battle Videos`

			`The following files from previous generations of games are supported:`
			`* Transferring of previous generation entities (.pkm) to .pk6`
			`* Conversion of Event Files (.pgt, .pcd, .pgf) to .pk6`
Update README.md 2014-06-28 22:08:40 +00:00
Explaining how building a binary 2015-07-20 22:25:20 +00:00			`Data is then displayed in a meaningful view, and can be edited and saved back to binary data.`
Update README.md 2016-01-03 23:35:19 +00:00			`Since the Nintendo 3DS savedata containers use an AES MAC that cannot be emulated without the 3DS's keys, a resigning service is required (svdt, save_manager, or SaveDataFiler).`
Create README.md 2014-06-28 22:07:46 +00:00
			`The interface is translatable with resource/external text files so that different languages can be supported.`

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

Update README.md 2014-12-12 06:42:36 +00:00			`![Main Window](http://i.snag.gy/dGdB4.jpg?raw=true)`
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).