Skip to content

Repository files navigation

Pal Buddy

Pal Buddy is an offline desktop companion for Palworld breeding, collection planning, and reference data. It combines the current breeding matrix with searchable Pal, work, mount, move, passive-skill, and Partner Skill data in one Windows application.

The bundled dataset targets Palworld 1.0.3 / Steam build 24575825 and currently contains:

  • 298 visible Pal records (297 breedable)
  • 44,253 unordered breeding pairs
  • 160 fixed or special combinations
  • 298 work-suitability records
  • 298 Partner Skills
  • 128 mounts and Pal gliders
  • 328 active skills
  • 115 passive skills

Contents

Install

Windows installer

  1. Open the latest GitHub release.
  2. Download Pal-Buddy-Setup-<version>.exe.
  3. Optionally verify the file against the release's SHA256SUMS.txt.
  4. Run the installer and choose an installation directory. Setup creates desktop and Start menu shortcuts.

Pal Buddy currently publishes an unsigned Windows installer. Windows SmartScreen may display an unknown-publisher warning. Confirm that the installer came from this repository's release page and that its SHA-256 checksum matches the release before continuing.

System requirements

  • Windows 10 or Windows 11, x64
  • Approximately 375 MiB installed, plus temporary space while setup runs
  • No Palworld installation or network connection is required to use the bundled reference data

Quick start

  1. Launch Pal Buddy.
  2. Choose a workflow from the dashboard or left sidebar.
  3. Search for Pals by name in any selector.
  4. Click any Pal portrait to open its complete information popup.
  5. Use Breeding Calc for a direct pair, Reverse Lookup to find parents for a target, or Pathfinder for a multi-generation route.

Selectors update results automatically where possible. Keyboard users can type to filter a selector, move through matches with Arrow Up/Down, Home, or End, choose with Enter, and dismiss the list with Escape. Longer path searches use an explicit Find button.

Application preview

Select any preview to open the full-resolution screenshot.

Pathfinder

Pal Buddy Pathfinder showing a three-step breeding route

Pal details

Pal Buddy Pal details popup showing breeding, Partner Skill, work, mount, and move information

Mounts and Pal gliders

Pal Buddy Mounts and Pal Gliders reference page

Moves

Pal Buddy Moves reference page with filters, power, cooldown, and descriptions

Features

Dashboard

The dashboard summarizes the bundled roster, fixed combinations, and your locally saved Pals. Quick actions link to the most common breeding and reference workflows. It also displays the exact data version and Steam build bundled with the app.

Breeding Calculator

Choose two parents to see every supported deterministic offspring result for Palworld 1.0.3. Results include:

  • Offspring species and elements
  • Combi Rank calculation
  • Gender requirements for gender-specific combinations
  • Fixed-special-combination labels
  • Palworld 1.0 mutation and breeding-cake reference notes

Reverse Lookup

Choose a target Pal to list every parent combination that can produce it. Results can be sorted by combined parent Combi Rank or by parent name and include any required genders.

One Parent Mode

Choose a Pal you already have and a desired offspring. Pal Buddy lists every valid second parent, including gender requirements and Combi Ranks. Results can be sorted by power or name.

Breeding Chain

Build a gendered list of Pals you own, choose a target, and search for an executable breeding plan of up to five steps. Owned Pals are saved locally between launches. Bred intermediate species may be re-hatched as either gender for later steps.

Pathfinder

Choose any starting species and target species to find up to ten shortest breeding paths within five steps. Each path shows both parents, required genders, and the offspring produced at every step. Pathfinder is species-based and does not use the owned-Pal list.

Combos

Browse the supported fixed and same-species-only combinations. Search by any parent or result and filter by:

  • Cross-species combinations
  • Same-species-only combinations
  • Gender-specific combinations

Paldex + Crossover

Browse all bundled Pal records in a sortable table. Search by name, filter by element, and sort by name or Combi Rank. Each row shows Paldex number, elements, gender ratio, breedability, and Combi Rank.

Work Suitability

Compare all 12 base work types across the roster. Search by Pal, filter by work type and minimum level, or sort by a selected work level. Bundled base levels range from 0 to 8; in-game upgrades can raise levels further.

Mounts & Pal Gliders

Search and filter ground, flying, swimming, and glider records. Entries show saddle technology level, travel mode, run/sprint or swim speeds where comparable, stamina, and the current Partner Skill effect.

Moves

Browse active skills by name, description, element, power, cooldown, or exclusivity. Exclusive skills identify the Pal species that can use them.

Passive Skills

Search all 115 player-visible passive skills by name or effect, and filter the list by in-game rank. Each entry identifies whether random inheritance is allowed by the current game data.

Partner Skills

Search all Partner Skills by Pal name, skill name, description, or element. The list includes the Palworld 1.0 Partner Skill reworks bundled with this release.

Pal details popup

Every Pal portrait in the title bar, selectors, calculators, path results, and reference tables is interactive. Click a portrait, or focus it and press Enter or Space, to open a compact information popup containing all related data available to Pal Buddy:

  • Paldex identity and elements
  • Breedability, Combi Rank, priority, and gender ratio
  • Partner Skill and description
  • Non-zero work suitability levels
  • Mount modes, saddle level, stamina, speeds, and mounted effect
  • Exclusive moves with power and cooldown
  • Fixed breeding relationships as a parent or result
  • Internal record identifiers used by the bundled data

Close the popup with its close button, Escape, or the shaded backdrop. Keyboard focus returns to the portrait that opened it.

How breeding results work

For ordinary combinations, Pal Buddy calculates the target rank as:

floor((Parent 1 Combi Rank + Parent 2 Combi Rank + 1) / 2)

It then uses the bundled full pair-result matrix rather than guessing solely from the nearest visible rank. This matters because fixed combinations, same-species rules, gender-specific outcomes, non-breedable records, and internal duplicate priorities can override a simple nearest-rank calculation.

The deterministic matrix does not attempt to predict random mutation outcomes. Mutation may produce a stronger species than the normal matrix result in Palworld 1.0.

Local data and privacy

Pal Buddy is designed to work offline. Production code makes no runtime web requests and includes no telemetry or analytics.

The only user-maintained data is the gendered owned-Pal list used by Breeding Chain. Electron stores it as owned-pals.json inside the operating system's Pal Buddy user-data directory. On Windows this is normally below %APPDATA%. Changes are validated and written through an atomic file replacement. If saving fails, the app restores the previous list, keeps the last valid file intact, and displays an error instead of reporting success.

The Electron window uses context isolation, process sandboxing, and disabled Node integration. Renderer access to Pal data, breeding operations, storage, and window controls is limited to the preload bridge and accepted only from the active main frame. Packaged builds deny child windows, block navigation away from the bundled renderer, and use an offline-only Content Security Policy.

Data scope and sources

The exact generated-data provenance, source hashes, counts, game executable hash, game version, and Steam build are recorded in:

src/shared/data/generated/manifest.json

Bundled data was assembled from PalCalc v27 game-table exports and current PalDB records for breeding, mounts, passive skills, Partner Skills, and active skills. The manifest also records the relevant official Palworld and SteamDB release references.

Game updates can make offline data stale. Check the version shown on the dashboard before relying on a result after a Palworld patch.

Development

Prerequisites

  • Node.js 22.15.0 or newer and npm
  • Windows for the supported NSIS installer target
  • Python only when regenerating game data with the maintenance scripts

Setup

git clone https://github.com/ItMeDiaTech/Pal-Buddy.git
cd Pal-Buddy
npm ci
npm run dev

npm run dev runs the Electron main-process watcher and renderer development server. After the initial development build completes, launch npm start in a second terminal. The development build connects to port 8080 and opens Electron DevTools automatically.

Project layout

src/main/                 Electron lifecycle, IPC handlers, local storage
src/preload/              Context-isolated renderer API
src/renderer/             Vue application, routes, views, and styles
src/shared/               Types, breeding engine, and data adapters
src/shared/data/generated Versioned generated game datasets and provenance
public/images/pals/       Bundled Pal portrait assets
tests/                    Data, breeding, popup, and UI-contract checks
scripts/                  Data and icon maintenance utilities
build/                    Installer icons required by Electron Builder

Commands

Command Purpose
npm run dev Run the main-process watcher and renderer development server; launch npm start separately
npm run build Build production Electron main, preload, and renderer bundles
npm test Build, validate all generated data, and run UI contract tests
npm run verify:data Compile and validate breeding/data/popup aggregation contracts
npm run verify:ui Run source-level application-shell and accessibility contracts
npm start Launch the current files under dist/
npm run package:win Generate icons, build, and create the x64 NSIS installer

Do not edit files under src/shared/data/generated/ casually. Regenerate them with the maintenance pipeline and preserve the manifest's provenance hashes and counts.

Build a Windows installer

npm ci
npm test
npm run package:win

Electron Builder writes the installer, blockmap, updater metadata, and unpacked application to release/. Build outputs and installers are intentionally excluded from Git; published installers belong in GitHub Releases.

The Windows package uses an assisted x64 NSIS installer that allows the user to choose an installation directory and creates optional desktop and Start menu shortcuts.

Security and release verification

Each GitHub release should include:

  • The Windows installer
  • SHA256SUMS.txt
  • VIRUS-SCAN.txt when a local scanner is available
  • Electron updater metadata and blockmap

Verify a downloaded installer in PowerShell:

Get-FileHash ".\Pal-Buddy-Setup-<version>.exe" -Algorithm SHA256

Compare the output with SHA256SUMS.txt from the same release. A local antivirus scan is useful evidence but is not a guarantee that software is safe. Source review, reproducible builds, checksums, code signing, and multiple independent scanners provide stronger assurance together. This project does not currently code-sign its Windows installer.

Troubleshooting

Windows SmartScreen warns about the installer

The installer is not code-signed. Download it only from this repository's release page and verify its SHA-256 checksum before deciding whether to run it.

A Pal icon is missing

The app hides a broken portrait but keeps the record usable. Reinstall from a verified release or rebuild to restore copied assets.

No breeding path is found

  • Breeding Chain searches only from the gendered owned copies you entered.
  • Add more owned species or the missing opposite gender.
  • Both Breeding Chain and Pathfinder stop after five steps.
  • Some records are not breedable.

Owned Pals disappeared or are invalid

The owned list is stored locally in Electron's user-data directory. A damaged or manually edited owned-pals.json is treated as an empty list. Re-add entries through Breeding Chain.

Data does not match the current game patch

Check the dashboard's Palworld version and Steam build. Use a release with updated generated data or regenerate the datasets before building.

Contributing

  1. Create a focused branch.
  2. Add or update tests before changing behavior.
  3. Run npm test and require a clean result.
  4. Keep generated data changes tied to source provenance and updated manifest hashes.
  5. Do not commit dependencies, builds, installers, logs, credentials, local app state, or AI-agent workspace files.

License and disclaimer

Pal Buddy source code is available under the MIT License.

Pal Buddy is an independent fan-made utility. It is not affiliated with, endorsed by, or sponsored by Pocketpair. Palworld names, game data, and related assets belong to their respective owners.

About

Offline Palworld breeding calculator, pathfinder, Paldex, and reference companion.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages