Pal Breeding Planner

English | 日本語

An in-game breeding lookup mod for Palworld. Open the planner without leaving the game, choose a target Pal, and view every direct parent combination that can produce it.

Install from Steam Workshop

Status: Active development

The current release focuses on reliable one-generation lookups. More advanced filtering, collection-aware recommendations, and multi-generation routes are planned for future updates.

Why This Mod Exists

Breeding references are usually opened in a separate browser or spreadsheet. Pal Breeding Planner keeps the lookup inside Palworld so that a player can check combinations without interrupting gameplay.

The project combines a Lua runtime layer with an Unreal Engine interface. Its breeding dataset is generated from a versioned game-data snapshot and packaged with integrity manifests so that releases can be reproduced and checked.

Current Features

• Open or close the planner in game with F8
• Search for a target Pal by name
• View all direct parent combinations for the selected target
• Display required parent genders and special breeding combinations
• Remove duplicate results and return them in a stable order
• Display Pal names in the game's current language, with English fallback names
• Run entirely from bundled data without an external web service

How to Use

1. Install the Workshop version of UE4SS.
2. Subscribe to Pal Breeding Planner on Steam Workshop.
3. Start Palworld and load a world.
4. Press F8 to open the planner.
5. Search for and select the Pal you want to breed.
6. Review the available parent combinations and gender requirements.

Press F8 again to close the interface.

Compatibility and Data Coverage

Item	Current source snapshot
Mod version	0.1.0
Palworld version	v1.0.1
Steam build ID	24181527
Runtime dependency	Workshop UE4SS (UE4SSExperimentalPW)
Pals	288
Target buckets	286
Breeding recipes	41,617
Special recipes	184

Because breeding data is tied to a specific game build, compatibility and results should be revalidated after Palworld updates.

Current Scope

The planner currently performs reverse lookup for a single target and returns direct, one-generation recipes. It does not yet read the player's Pal collection or calculate recursive breeding chains.

The F8 shortcut is currently fixed. The interface requires the mod actor to be available in the loaded map.

Architecture

flowchart LR
    Snapshot[Frozen CSV snapshot] --> Generator[Python validator and generator]
    Generator --> Data[Deterministic Lua dataset]
    Data --> Query[Lua query layer]
    Query --> Bridge[UE4SS runtime bridge]
    Bridge --> UI[Unreal Engine UI]

Loading

• The Python generator validates IDs, references, gender values, special-recipe flags, and duplicate records before producing the runtime dataset.
• Source and generated-file SHA-256 values are stored in a manifest for reproducibility.
• Lua handles runtime integration, recipe lookup, deduplication, and stable ordering.
• Unreal Engine assets provide the in-game interface and are tracked through an asset integrity manifest.
• The development packaging script verifies generated data before combining the Lua runtime and cooked LogicMod package.

Project Structure

src/lua/                         # Runtime entry point and query logic
data/release/<steam-build-id>/   # Frozen release data snapshots
generated/lua/                   # Generated runtime data and integrity manifest
unreal/Content/Mods/             # Project-owned Unreal Engine assets
scripts/                         # Data generation, asset sync, and packaging tools
workshop/                        # Steam Workshop metadata template

Large Unreal Engine assets are tracked with Git LFS. The Palworld Modding Kit, third-party tools, cooked packages, and local Workshop metadata are intentionally not committed.

Development

Requirements

• Python 3.10 or later
• PowerShell
• Git LFS
• Palworld Modding Kit
• Workshop version of UE4SS for runtime testing

Regenerate the Runtime Dataset

python scripts/generate_lua_breeding_data.py

The generator reads the frozen release snapshot, performs structural and reference validation, and rewrites both the Lua dataset and its SHA-256 manifest deterministically.

Synchronize Unreal Assets

Set PAL_MODDING_KIT_ROOT or pass -ModdingKitRoot to the synchronization scripts.

./scripts/sync_to_moddingkit.ps1
./scripts/sync_from_moddingkit.ps1

sync_to_moddingkit.ps1 restores the repository-owned assets to a local Modding Kit project after verifying their hashes. sync_from_moddingkit.ps1 imports updated project-owned assets and refreshes the asset manifest.

Assemble a Development Package

After cooking the LogicMod package with the external Modding Kit toolchain:

./scripts/build_dev_package.ps1 -LogicModPath <path-to-cooked-pak>

This creates a local development package and records the size and SHA-256 value of every included file. Formal Steam Workshop publishing remains a separate release step.

Roadmap

• Add advanced filters and user-selectable result ordering
• Prioritize combinations that use Pals already owned by the player
• Calculate two- and three-generation breeding routes
• Keep the bundled breeding snapshot synchronized with supported Palworld releases

The roadmap describes intended work and does not guarantee release dates or compatibility with unreleased game versions.

License and Disclaimer

The original source code and project-owned assets are released under the MIT License. You may use, modify, and redistribute them under its terms.

Pal Breeding Planner is an unofficial community project and is not affiliated with or endorsed by Pocketpair, Inc. Palworld and related names, trademarks, game data, and third-party assets belong to their respective rights holders and are not covered by this license.