Skip to main content
PKHeX.Core is a comprehensive Pokémon data manipulation library for C# that supports all Pokémon generations and formats.

Prerequisites

Before installing PKHeX.Core, ensure you have:
  • .NET 10 SDK or later installed
  • A C# project targeting .NET 10 or higher
  • Basic knowledge of C# programming
PKHeX.Core targets .NET 10 (net10.0). Make sure your project is compatible with this framework version.

Installation Methods

1
Install via NuGet Package Manager
2
The easiest way to install PKHeX.Core is through NuGet:
3
.NET CLI
dotnet add package PKHeX.Core
Package Manager Console
Install-Package PKHeX.Core
Manual .csproj Edit
<ItemGroup>
  <PackageReference Include="PKHeX.Core" Version="*" />
</ItemGroup>
4
Verify Installation
5
After installation, verify that PKHeX.Core is properly referenced in your project:
6
dotnet list package
7
You should see PKHeX.Core listed in your project dependencies.
8
Create Your First Project
9
Create a new console application to test PKHeX.Core:
10
dotnet new console -n MyPKHeXApp
cd MyPKHeXApp
dotnet add package PKHeX.Core

Project Configuration

Minimum .csproj Setup

Ensure your project file (.csproj) targets the correct framework:
<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net10.0</TargetFramework>
    <LangVersion>latest</LangVersion>
    <Nullable>enable</Nullable>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="PKHeX.Core" Version="*" />
  </ItemGroup>
</Project>

Import the Namespace

In your C# files, import the PKHeX.Core namespace:
using PKHeX.Core;

Package Information

Package ID

PKHeX.Core

License

GPL-3.0-or-later

Target Framework

.NET 10.0

Repository

PKHeX.Core is licensed under GPL-3.0-or-later. Make sure your project complies with the license terms, especially if you’re distributing your application.

Troubleshooting

Common Installation Issues

If you encounter errors about framework versions, ensure your project targets .NET 10 or later:
<TargetFramework>net10.0</TargetFramework>
Make sure you have the latest NuGet sources configured:
dotnet nuget list source
dotnet restore
Clean and rebuild your project:
dotnet clean
dotnet build

Next Steps

Quick Start

Learn the basics with a quick start tutorial

Core Concepts

Understand save files and Pokémon data structures

Build docs developers (and LLMs) love