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:
* Decrypted Save files (1MB/Cyber Save 0x65600/0x76000 Bytes)
* Individual entity files (232/260 bytes)
* Wondercard gifts for Event Pokemon and Event based Items.
* Obsoleted: Unencrypted Network Packets containing entity files.

Data is then displayed in a meaningful view, and can be edited and saved back to binary data.
For loaded save files, saving an edited copy is possible and all hashes will be fixed.
Since save data uses an AES MAC that cannot be emulated without the 3DS's keys, a resigning service is required.

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)

## Building

It can be compiled with any C# compiler.

### IDE

It is easy with MS Visual Studio and [MonoDevelop](http://www.monodevelop.com/).
You can import the project with the .sln 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`.
The project uses System.Deployment, unfortunately - even with version 4.0 - [it is not implemented in Mono](https://stackoverflow.com/questions/9112460/mono-develop-assembly-system-deployment-not-found).
There is the same problem with [System.Data.SqlServerCe (SQL Server Compact Edition)](https://stackoverflow.com/questions/2644464/can-i-use-sql-server-compact-edition-ce-on-mono) (that could be replaced by [SQLite](https://en.wikipedia.org/wiki/SQLite), that is free/libre cross-platform [RDBMS](https://en.wikipedia.org/wiki/Relational_database_management_system) to avoid the problem).
At least in 2015, GNU/Linux is not the main OS of developers of this program, so there are bugs, but 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 2014-06-28 22:08:40 +00:00			`Supports binary file loading of:`
Explaining how building a binary 2015-07-20 22:25:20 +00:00			`* Decrypted Save files (1MB/Cyber Save 0x65600/0x76000 Bytes)`
			`* Individual entity files (232/260 bytes)`
			`* Wondercard gifts for Event Pokemon and Event based Items.`
			`* Obsoleted: Unencrypted Network Packets containing entity files.`
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 Mentioning Cyber Save Editor updates. 2014-08-13 00:12:43 +00:00			`For loaded save files, saving an edited copy is possible and all hashes will be fixed.`
			`Since save data uses an AES MAC that cannot be emulated without the 3DS's keys, a resigning service is required.`
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
			`## Building`

			`It can be compiled with any C# compiler.`

			`### IDE`

			`It is easy with MS Visual Studio and [MonoDevelop](http://www.monodevelop.com/).`
			`You can import the project with the .sln 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`.
			`The project uses System.Deployment, unfortunately - even with version 4.0 - [it is not implemented in Mono](https://stackoverflow.com/questions/9112460/mono-develop-assembly-system-deployment-not-found).`
			`There is the same problem with [System.Data.SqlServerCe (SQL Server Compact Edition)](https://stackoverflow.com/questions/2644464/can-i-use-sql-server-compact-edition-ce-on-mono) (that could be replaced by [SQLite](https://en.wikipedia.org/wiki/SQLite), that is free/libre cross-platform [RDBMS](https://en.wikipedia.org/wiki/Relational_database_management_system) to avoid the problem).`
			`At least in 2015, GNU/Linux is not the main OS of developers of this program, so there are bugs, but 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).`