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, \*.dsv, \*.dat, \*.gci)
* GameCube Memory Card files (\*.raw, \*.bin) containing GC Pokémon savegames.
* Individual Pokémon entity files (.pk\*, \*.ck3, \*.xk3, \*.bk4)
* 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 ([Checkpoint](https://github.com/BernardoGiordano/Checkpoint/), save_manager, [JKSM](https://github.com/J-D-K/JKSM), or SaveDataFiler).

**We do not support or condone cheating at the expense of others. Do not use significantly hacked Pokémon in battle or in trades with those who are unaware hacked Pokémon are in use.**

## Screenshots

![Main Window](https://i.imgur.com/36FpRop.png)

## Building

PKHeX is a Windows Forms application which requires [.NET Framework v4.6](https://www.microsoft.com/en-us/download/details.aspx?id=48137).

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

### 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](http://www.monodevelop.com/) and [Mono Runtime](http://www.mono-project.com/) 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 macOS 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.md it supports dsv too 2017-02-25 14:52:15 +00:00			`* Save files ("main", \.sav, \.dsv, \.dat, \.gci)`
Update formats included in README.md 2017-05-18 20:20:43 +00:00			`* GameCube Memory Card files (\.raw, \.bin) containing GC Pokémon savegames.`
			`* Individual Pokémon entity files (.pk\, \.ck3, \.xk3, \.bk4)`
			`* Mystery Gift files (\.pgt, \.pcd, \.pgf, .wc\) including conversion to .pk\*`
Update README.md 2017-02-01 03:44:29 +00:00			`* 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
Update README.md Update screenshot switch svdt recommendation for Checkpoint 2017-11-17 03:34:44 +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 ([Checkpoint](https://github.com/BernardoGiordano/Checkpoint/), save_manager, [JKSM](https://github.com/J-D-K/JKSM), or SaveDataFiler).`
Create README.md 2014-06-28 22:07:46 +00:00
Add disclaimer for cheating 2017-02-24 19:48:40 +00:00			`We do not support or condone cheating at the expense of others. Do not use significantly hacked Pokémon in battle or in trades with those who are unaware hacked Pokémon are in use.`

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

Update README.md Update screenshot switch svdt recommendation for Checkpoint 2017-11-17 03:34:44 +00:00			`![Main Window](https://i.imgur.com/36FpRop.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-27 23:05:16 +00:00			`PKHeX is a Windows Forms application which requires [.NET Framework v4.6](https://www.microsoft.com/en-us/download/details.aspx?id=48137).`
Explaining how building a binary 2015-07-20 22:25:20 +00:00
Update README.md reflects C# 7 requirements 2017-05-13 04:18:14 +00:00			`The executable can be built with any compiler that supports C# 7.`
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 OS X to macOS macOS is the new official name for OS X 2017-05-22 15:04:19 +00:00			Install [MonoDevelop](http://www.monodevelop.com/) and [Mono Runtime](http://www.mono-project.com/) 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 macOS should be able to reproduce them).