PKHeX/README.md

PKHeX
=====
![License](https://img.shields.io/badge/License-GPLv3-blue.svg)

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

Supports the following files:
* Save files ("main", .sav)
* Individual Pokémon entity files (.pk*)
* Mystery Gift files (.pgt, .pcd, .pgf, .wc*) including conversion to .pk*
* Importing teams from Decrypted 3DS Battle Videos
* Transferring from one generation to another, converting formats along the way.

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 and QR codes can be imported/exported to assist in sharing.

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/QT3IxpR.png)

## Building

PKHeX is a Windows Forms application which requires .NET Framework v4.6.

The executable can be built with any compiler that supports C# 6.0.

### Build Configurations

Use the Debug or Release build configurations when building using the .NET Framework.  Use the Mono-Debug or Mono-Release build configurations when building using Mono.

## Dependencies

PKHeX's QR code generation code is taken from [QRCoder](https://github.com/codebude/QRCoder), which is licensed under [the MIT license](https://github.com/codebude/QRCoder/blob/master/LICENSE.txt).

### IDE

PKHeX can be opened with IDEs such as [Visual Studio](https://www.visualstudio.com/) or [MonoDevelop](http://www.monodevelop.com/) by opening the .sln or .csproj file.

### GNU/Linux

Install MonoDevelop and [Mono](http://www.mono-project.com/) runtime with `flatpak install --user --from https://download.mono-project.com/repo/monodevelop.flatpakref`. 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`
			`=====`
Update README.md 2016-09-17 15:50:34 +00:00			`![License](https://img.shields.io/badge/License-GPLv3-blue.svg)`
Create README.md 2014-06-28 22:07:46 +00:00
Update README.md 2016-09-17 15:50:34 +00:00			`Pokémon core series 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
Update README.md 2016-09-17 15:50:34 +00:00			`Supports the following files:`
Update readme Reflect multiple generation support 2016-06-22 04:54:14 +00:00			`* Save files ("main", .sav)`
			`* Individual Pokémon entity files (.pk*)`
Update README.md 2017-02-01 03:44:29 +00:00			`* Mystery Gift files (.pgt, .pcd, .pgf, .wc) including conversion to .pk`
			`* Importing teams from Decrypted 3DS Battle Videos`
Update README.md 2016-09-17 15:50:34 +00:00			`* Transferring from one generation to another, converting formats along the way.`
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.md 2016-09-17 15:50:34 +00:00			`Pokémon Showdown sets and QR codes can be imported/exported to assist in sharing.`
Update readme Reflect multiple generation support 2016-06-22 04:54:14 +00:00
			`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.md 2016-09-17 15:50:34 +00:00			`![Main Window](http://i.imgur.com/QT3IxpR.png)`
Add license. 2015-07-21 03:54:07 +00:00
Explaining how building a binary 2015-07-20 22:25:20 +00:00			`## Building`

Update README.md 2017-02-01 03:44:29 +00:00			`PKHeX is a Windows Forms application which requires .NET Framework v4.6.`
Explaining how building a binary 2015-07-20 22:25:20 +00:00
Update README.md 2016-09-17 15:50:34 +00:00			`The executable can be built with any compiler that supports C# 6.0.`
Explaining how building a binary 2015-07-20 22:25:20 +00:00
Renamed build configurations to clarify usage Also added the README to the solution and modified it to briefly describe when to use each build configuration. 2016-12-17 14:23:32 +00:00			`### Build Configurations`

Update README.md 2017-02-01 03:44:29 +00:00			`Use the Debug or Release build configurations when building using the .NET Framework. Use the Mono-Debug or Mono-Release build configurations when building using Mono.`
Renamed build configurations to clarify usage Also added the README to the solution and modified it to briefly describe when to use each build configuration. 2016-12-17 14:23:32 +00:00
Preliminary QR code generation support, via QRCoder. 2016-11-16 08:11:41 +00:00			`## Dependencies`

			`PKHeX's QR code generation code is taken from [QRCoder](https://github.com/codebude/QRCoder), which is licensed under [the MIT license](https://github.com/codebude/QRCoder/blob/master/LICENSE.txt).`

Update README.md 2016-09-17 15:50:34 +00:00			`### IDE`
Explaining how building a binary 2015-07-20 22:25:20 +00:00
Update README.md 2016-09-17 15:50:34 +00:00			`PKHeX can be opened with IDEs such as [Visual Studio](https://www.visualstudio.com/) or [MonoDevelop](http://www.monodevelop.com/) by opening the .sln or .csproj file.`
Explaining how building a binary 2015-07-20 22:25:20 +00:00
			`### GNU/Linux`

Update readme GNU/Linux section Revise description to use flatpak instead of Aptitude. Discussed in #387, closes #387. 2016-12-21 01:31:20 +00:00			Install MonoDevelop and [Mono](http://www.mono-project.com/) runtime with `flatpak install --user --from https://download.mono-project.com/repo/monodevelop.flatpakref`. 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).