PKHeX/README.md

PKHeX
=====
<div>
  <span>English</span> / <a href=".github/README-es.md">Español</a> / <a href=".github/README-fr.md">Français</a> / <a href=".github/README-de.md">Deutsch</a> / <a href=".github/README-it.md">Italiano</a> / <a href=".github/README-zhHK.md">繁體中文</a> / <a href=".github/README-zh.md">简体中文</a>
</div>

![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, \*.bin)
* GameCube Memory Card files (\*.raw, \*.bin) containing GC Pokémon savegames.
* Individual Pokémon entity files (.pk\*, \*.ck3, \*.xk3, \*.pb7, \*.sk2, \*.bk4, \*.rk4)
* Mystery Gift files (\*.pgt, \*.pcd, \*.pgf, .wc\*) including conversion to .pk\*
* Importing GO Park entities (\*.gp1) including conversion to .pb7
* 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.

PKHeX expects save files that are not encrypted with console-specific keys. Use a savedata manager to import and export savedata from the console ([Checkpoint](https://github.com/FlagBrew/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/HZs37cM.png)

## Building

PKHeX is a Windows Forms application which requires [.NET 8.0](https://dotnet.microsoft.com/download/dotnet/8.0).

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

### Build Configurations

Use the Debug or Release build configurations when building. There isn't any platform specific code to worry about!

## 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).

PKHeX's shiny sprite collection is taken from [pokesprite](https://github.com/msikma/pokesprite), which is licensed under [the MIT license](https://github.com/msikma/pokesprite/blob/master/LICENSE).

PKHeX's Pokémon Legends: Arceus sprite collection is taken from the [National Pokédex - Icon Dex](https://www.deviantart.com/pikafan2000/art/National-Pokedex-Version-Delta-Icon-Dex-824897934) project and its abundance of collaborators and contributors.

### IDE

PKHeX can be opened with IDEs such as [Visual Studio](https://visualstudio.microsoft.com/downloads/) by opening the .sln or .csproj file.
Create README.md 2014-06-28 22:07:46 +00:00			`PKHeX`
			`=====`
Spanish readme (#3218) Add: Spanish README.md in .github folder, accessible from main readme. Co-authored-by: Rodolfo Velázquez <rodolfo.velazquez@mercadolibre.com> 2021-06-15 23:56:25 +00:00			`<div>`
Add README-zh.md (#3723) Add Simplified Chinese version of "README" file 2023-01-14 09:19:49 +00:00			`<span>English</span> / <a href=".github/README-es.md">Español</a> / <a href=".github/README-fr.md">Français</a> / <a href=".github/README-de.md">Deutsch</a> / <a href=".github/README-it.md">Italiano</a> / <a href=".github/README-zhHK.md">繁體中文</a> / <a href=".github/README-zh.md">简体中文</a>`
Spanish readme (#3218) Add: Spanish README.md in .github folder, accessible from main readme. Co-authored-by: Rodolfo Velázquez <rodolfo.velazquez@mercadolibre.com> 2021-06-15 23:56:25 +00:00			`</div>`

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 18.11.16 Update event binaries with latest from the Event Gallery 2018-11-17 01:53:44 +00:00			`* Save files ("main", \.sav, \.dsv, \.dat, \.gci, \*.bin)`
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.`
Expand My Pokémon Ranch Support (#3595) * Add RanchMii for SAV4Ranch * Add RanchToy * Add RanchTrainerMii * Add RanchLevel * Add RanchToy class; make existing RanchToy RanchToyType * Add RanchToy and RanchLevel to SAV4Ranch * Remove incorrect MaxPkmCount entry from RanchLevel * Move code to remove PtHGSS data to a function in G$PKM * Add RK4 for My Pokemon Ranch Pokemon * Add RanchPkOwnershipType * SAV4Ranch updates * Fix PK4/RK4 conversion logic to stop breaking nicknames/OTs * Fix EntityDetection.IsPresent() check tripping on the data end marker for SAV4Ranch * Add .rk4 to README translations * Minor tweaks Fix RK4 TID/SID endianness/order, split Ownership enum into two enums Condense mii classes to get/set properties Make RanchLevel a static class for logic Remove ClearFF for TrainerMii -- the FFFF is the string terminator char for gen4 Make Toy byte enum, with unused alignment bytes Co-authored-by: Kurt <kaphotics@gmail.com> 2022-10-02 20:14:42 +00:00			`* Individual Pokémon entity files (.pk\, \.ck3, \.xk3, \.pb7, \.sk2, \.bk4, \*.rk4)`
Update formats included in README.md 2017-05-18 20:20:43 +00:00			`* Mystery Gift files (\.pgt, \.pcd, \.pgf, .wc\) including conversion to .pk\*`
Add file references for Let's Go 2019-03-12 15:59:06 +00:00			`* Importing GO Park entities (\*.gp1) including conversion to .pb7`
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
Remove explicit mono build, update readme With the FontUtil rewrite removing any platform specific code, there is no need to have two separate builds. Remove the unused ClickOnce target, never implemented. 2019-10-17 03:52:09 +00:00			`PKHeX expects save files that are not encrypted with console-specific keys. Use a savedata manager to import and export savedata from the console ([Checkpoint](https://github.com/FlagBrew/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`

Add support for Indigo Disk (#4111) 2023-12-18 00:41:15 +00:00			`![Main Window](https://i.imgur.com/HZs37cM.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 readmes #4082 2023-12-04 05:25:44 +00:00			`PKHeX is a Windows Forms application which requires [.NET 8.0](https://dotnet.microsoft.com/download/dotnet/8.0).`
Explaining how building a binary 2015-07-20 22:25:20 +00:00
Update readmes #4082 2023-12-04 05:25:44 +00:00			`The executable can be built with any compiler that supports C# 12.`
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`

Remove explicit mono build, update readme With the FontUtil rewrite removing any platform specific code, there is no need to have two separate builds. Remove the unused ClickOnce target, never implemented. 2019-10-17 03:52:09 +00:00			`Use the Debug or Release build configurations when building. There isn't any platform specific code to worry about!`
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).`

Add shiny sprites Thanks @msikma (dada)! Update readme with asset attribution #1735 2018-01-03 01:14:22 +00:00			`PKHeX's shiny sprite collection is taken from [pokesprite](https://github.com/msikma/pokesprite), which is licensed under [the MIT license](https://github.com/msikma/pokesprite/blob/master/LICENSE).`

Add custom sprites for Legends: Arceus species/forms (#3441) * Add custom sprites for Legends: Arceus species/forms * Update READMEs with credit to new sprites source Translations for de/es/fr pending. * Add sprite for Legend Plate Arceus Now no longer falls back to mugshot if forcing sprites. 2022-02-18 01:46:33 +00:00			`PKHeX's Pokémon Legends: Arceus sprite collection is taken from the [National Pokédex - Icon Dex](https://www.deviantart.com/pikafan2000/art/National-Pokedex-Version-Delta-Icon-Dex-824897934) project and its abundance of collaborators and contributors.`

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
Remove explicit mono build, update readme With the FontUtil rewrite removing any platform specific code, there is no need to have two separate builds. Remove the unused ClickOnce target, never implemented. 2019-10-17 03:52:09 +00:00			`PKHeX can be opened with IDEs such as [Visual Studio](https://visualstudio.microsoft.com/downloads/) by opening the .sln or .csproj file.`