Top Related Projects
Database project of box and inventory sprites from the Pokémon core series games
Quick Overview
PKHeX is a Pokémon save file editor and manipulation tool. It allows users to modify and manage save files from various Pokémon games across different platforms. PKHeX provides a user-friendly interface for editing Pokémon data, items, and other game-related information.
Pros
- Supports a wide range of Pokémon games from multiple generations
- Offers a comprehensive set of editing features for Pokémon, items, and game data
- Regularly updated to support new game releases and features
- Open-source project with an active community
Cons
- Can be used to create illegitimate Pokémon, potentially impacting competitive play
- Requires some knowledge of Pokémon game mechanics to use effectively
- May void warranty or violate terms of service for online features if used improperly
- Learning curve for advanced features and functionality
Code Examples
// Load a save file
var sav = SaveUtil.GetVariantSAV(File.ReadAllBytes("path/to/save.sav"));
// Get the first Pokémon in the party
var pokemon = sav.GetPartySlot(0);
// Modify the Pokémon's level
pokemon.CurrentLevel = 50;
// Save changes back to the file
File.WriteAllBytes("path/to/modified_save.sav", sav.Write());
// Create a new Pokémon
var pk = sav.BlankPKM;
pk.Species = (int)Species.Pikachu;
pk.Move1 = (int)Move.ThunderBolt;
pk.Gender = 0; // Male
// Add the Pokémon to the first empty box slot
sav.SetBoxSlot(pk, 0, 0);
// Modify player information
sav.OT = "New Trainer Name";
sav.TID = 12345;
sav.SID = 54321;
// Add items to the bag
sav.SetInventoryPouch(InventoryType.Items, new[] { new InventoryItem(1, 99) }); // 99 Poké Balls
Getting Started
To use PKHeX in your C# project:
- Clone the repository:
git clone https://github.com/kwsch/PKHeX.git
- Open the solution in Visual Studio
- Build the project
- Reference the PKHeX.Core dll in your project
- Use the following namespaces:
using PKHeX.Core;
using System.IO;
// Your code here
var sav = SaveUtil.GetVariantSAV(File.ReadAllBytes("path/to/save.sav"));
// Continue with save file manipulation
Competitor Comparisons
Database project of box and inventory sprites from the Pokémon core series games
Pros of pokesprite
- Focused specifically on Pokémon sprites and icons
- Lightweight and easy to integrate into web projects
- Includes a wide variety of Pokémon forms and variations
Cons of pokesprite
- Limited functionality compared to PKHeX's comprehensive features
- Not designed for save file editing or game data manipulation
- Less frequent updates and smaller community support
Code Comparison
PKHeX (C#):
public class PKM
{
public int Species { get; set; }
public int Form { get; set; }
public bool IsShiny { get; set; }
}
pokesprite (JavaScript):
const pokesprite = require('pokesprite');
const sprite = pokesprite.getPokemon('pikachu', {gender: 'female'});
console.log(sprite.path);
Summary
PKHeX is a comprehensive Pokémon save file editor with extensive features for game data manipulation. It's written in C# and has a large, active community.
pokesprite, on the other hand, is a lightweight JavaScript library focused on providing Pokémon sprites and icons for web projects. It offers easy integration but has limited functionality compared to PKHeX.
While PKHeX is ideal for advanced Pokémon game editing, pokesprite is better suited for developers looking to add Pokémon imagery to their web applications quickly and easily.
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
PKHeX
Pokémon core series save editor, programmed in C#.
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, save_manager, 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
Building
PKHeX is a Windows Forms application which requires .NET 9.0.
The executable can be built with any compiler that supports C# 13.
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, which is licensed under the MIT license.
PKHeX's shiny sprite collection is taken from pokesprite, which is licensed under the MIT license.
PKHeX's Pokémon Legends: Arceus sprite collection is taken from the National Pokédex - Icon Dex project and its abundance of collaborators and contributors.
IDE
PKHeX can be opened with IDEs such as Visual Studio by opening the .sln or .csproj file.
Top Related Projects
Database project of box and inventory sprites from the Pokémon core series games
Convert
designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot