$ show kwsch/PKHeX
PKHeX is a comprehensive Pokémon save file editor and legality checker for Windows. It supports the entire main series of Pokémon games from Generation 1 through Generation 9, including recent titles like Pokémon Scarlet/Violet and Pokémon Legends: Z-A. The application allows users to view, edit, and manage Pokémon data, items, and save file structures with a high degree of accuracy derived from extensive reverse engineering of game mechanics. The codebase is structured as a core library (`PKHeX.Core`) with a Windows Forms GUI (`PKHeX.WinForms`). The core library is a masterclass in data-driven design and reverse engineering, featuring a sophisticated legality verification engine, encounter matching algorithms, RNG seed correlation, and move learning verification. It employs clean architectural patterns such as the Verifier pattern, SaveBlock accessor pattern, and extensive use of interfaces for cross-generation polymorphism. While the domain logic is tightly coupled to Pokémon game mechanics, the architectural patterns (Verifier, Encounter Generator, SaveBlock, LearnSource) are highly reusable templates for any project requiring complex, versioned data validation. The codebase demonstrates exceptional craftsmanship in handling binary data, implementing RNG algorithms, and managing localization across 10+ languages. The primary caveat is the use of a custom C# transpiler dialect, which introduces a dependency on a non-standard toolchain, and the massive scale of hardcoded game data required by the domain.
The LLM identified 4 files worth highlighting for reuse:
Defines an abstract base class (`Verifier`) with a `Verify` method that takes a `LegalityAnalysis` context. Concrete subclasses implement specific checks (e.g., ball, gender, ribbons). This is a textbook Strategy/Template Method pattern that allows the legality checking pipeline to be easily extended without modifying existing checks. Highly reusable for any validation-heavy domain.
Provides self-contained implementations of the pseudo-random number generators used by Pokémon games (LCRNG, Xoroshiro128+, MRNG, etc.). Includes forward and reverse stepping, seed correlation, and bounded random generation. These are clean, isolated algorithm implementations that can be extracted and used in any project requiring these specific PRNGs.
A generic base class (`SaveBlock<TSAV>`) that provides structured, type-safe access to a slice of binary data. Subclasses define specific fields with offsets, sizes, and endianness. This pattern is a highly reusable solution for parsing and manipulating binary file formats, save data, or network packets.
Implements the `IEncounterGenerator` interface to determine if a given Pokémon could have been encountered in a specific game generation. The dispatcher selects the correct generator based on game version. Each generator encapsulates complex game mechanics (wild encounters, eggs, trades, gifts). This Strategy pattern cleanly separates encounter logic per generation.