Palworld Save Pal

⚠️ Backup your save files before using this tool!! ⚠️

Palworld Save Pal is a tool for managing and analyzing save files.

📋 Table of Contents

• Palworld Save Pal
• 📋 Table of Contents
• 🚀 Installation
• 🎮 Usage
• 🦀 Rust backend migration
• 🐳 Docker
• 👨‍💻 Developer Guide
  • Web
  • Desktop App
  • Build Desktop App
• 🔥 Features
  • General
  • Pals
  • Players
  • Guilds
  • Map
  • Tools
  • Servers
  • Extras
• 📜 License
• ➡️ Related Projects
• ☕ Buy me a Coffee

🚀 Installation

Grab the latest release from the releases page and extract it to a folder of your choice.

🎮 Usage

Details for using Palworld Save Pal can be found in the User Guide

🦀 Rust backend migration

The backend is now a single Rust binary (psp-server) — the Python/FastAPI backend is retired. The UI, save-editing features, and WebSocket API are unchanged.

Your existing database (psp.db) is imported automatically. On first start, if a legacy psp.db sits next to the new database file (psp-rs.db) and no new database exists yet, your settings, presets, Universal Pal Storage, and server configs are imported; the legacy file is backed up, never modified, and the import runs only once.

• Desktop: nothing to do — the app finds your existing psp.db.
• Docker: copy your old psp.db into the ./db/ folder (see the Docker section) before first start.

Breaking change: JSON files exported by the old Python tooling (palworld-save-tools convert.py output) can no longer be converted back to .sav via POST /api/convert/json-to-sav or the Raw editor. Re-export the save with this version first — sav → json → sav round-trips are only supported within the same tooling generation.

🐳 Docker

To run Palworld Save Pal using Docker:

1. Clone this repository:

bash git clone https://github.com/oMaN-Rod/palworld-save-pal.git

2. Run the build script based on your environment, these scripts capture the system IP address and set the environment variable for the svelte SPA:

Linux

bash ./scripts/build-docker.sh

Windows

powershell .\scripts\build-docker.ps1

3. Or you can follow these steps:

4. Modify the docker-compose.yml file to set the IP/URL address of your docker host:

   yaml services: backend: build: context: . dockerfile: Dockerfile args: # Change this to the host:port browsers will use to reach the server - PUBLIC_WS_URL=127.0.0.1:5174/ws ports: - "5174:5174" volumes: - ./data:/app/data # Persists psp-rs.db (settings, presets, UPS). To import a legacy # Python psp.db, copy it to ./db/psp.db before first start. - ./db:/app/db

5. Build the docker container:

   bash docker compose up --build -d

👨‍💻 Developer Guide

Desktop (Windows/Linux/Mac) is the primary way Palworld Save Pal ships; Docker/web is also supported. The backend is a Rust workspace at the repo root — see docs/rust-dev-guide.md for the full guide.

Plugin authors should start with the plugin guide. The Plugin API reference covers exact schemas and runtime behavior.

Web

dev:web starts the Vite dev server and the Rust backend together:

cd psp-ui
bun install
bun run dev:web

Then open http://127.0.0.1:5173.

Desktop App

Run the app in dev mode with hot-reload — Tauri starts the Vite dev server for you (requires the Tauri CLI: cargo install tauri-cli --version "^2" --locked):

cd psp-ui && bun install && cd ..
cd psp-desktop
cargo tauri dev

Build Desktop App

Use the platform build script — it builds the UI, runs cargo tauri build, and collects the shipped artifacts into dist/:

# Windows: MSI installer + portable standalone zip
.\scripts\build-desktop.ps1

# macOS (.dmg) / Linux (.deb)
./scripts/build-desktop.sh

🔥 Features

General

• [x] Filter/Sort Pals by name, nickname, character ID, Boss, Lucky, Human, Level, Paldeck #, Predator, Oil Rig, Summon, or Element type
• [x] Gamepass & Steam support (solo/coop/dedicated)
• [x] Localization; supports Deutsch, English, Español, Français, Italiano, 한국어, Português, Русский, 简体中文, and 繁體中文, Español (México), Bahasa Indonesia, Polski, ไทย, Türkçe, and Tiếng Việt
• [x] Supports Desktop for Windows/Mac/Linux, Docker (web), or running from source (web)
• [x] Theme support - Dark, Frontier (Thanks to @CyrixJD115), and Light themes (preference persisted between sessions)

Pals

• [x] Edit Palbox, Base, Dimensional Pal Storage, and Global Pal Storage Pals
• [x] Edit Nickname
• [x] Edit Gender
• [x] Edit Active Skills / Learned Skills
• [x] Edit Passive Skills
• [x] Edit Level
• [x] Edit Rank
• [x] Edit Souls
• [x] Edit Trust
• [x] Set/Unset Lucky
• [x] Set/Unset Boss
• [x] Add/Remove/Clone Pals
• [x] Edit Work Suitability
• [x] Heal Pals - edit health and stomach (Modified pals are automatically healed)
• [x] Create your own Active/Passive Skill presets, making it easy af to apply skills.
• [x] Apply Pal preset on multiple Pals, e.g., max out all Dragon types with a specific profile.

Players

• [x] Edit Name
• [x] Edit Level
• [x] Edit Stats (Health, Stamina, Attack, Work Speed, and Weight)
• [x] Heal Player - edit health and stomach
• [x] Edit Inventory
• [x] Edit Technologies
• [x] Create your own inventory presets/load outs and apply them across players and saves.
• [x] Edit Technology Tree, Technology Points, and Ancient Technology points
• [x] Delete Players (Deletes all map objects, items, and pals)
• [x] Edit Active and Completed Missions

Guilds

• [x] Edit Guild Name
• [x] Edit Guild Chest
• [x] Edit Base Pals
• [x] Edit Base Inventory
• [x] Edit Base Name (Currently only applies in PSP, not exposed in game)
• [x] Edit Lab Research
• [x] Delete Guilds (Deletes all players, map objects, items, and pals)

Map

• [x] Interactive world map - See players, bases, fast travel points, dungeons, effigies, and alpha/predator pals
• [x] Toggle individual fast travel points, or unlock all fast travel points for a player
• [x] Toggle individual effigies, or collect all effigies for a player (with collected/total count)
• [x] Unlock Map (remove fog)

Tools

• [x] Convert save format between Steam and GamePass - convert the loaded save, or convert standalone saves without loading them into the editor
• [x] GamePass save browser - view, inspect, rename, and delete GamePass saves
• [x] Steam ID converter - convert a Steam ID or profile URL to a Palworld UID and NoSteam UID
• [x] Player UID Swap - swap UIDs between two players (useful for co-op to dedicated server migration, platform changes, or UID reassignment)
• [x] Player Transfer - transfer a player between saves, choosing which data to move (character, inventory, pals, technology, appearance) and whether to overwrite an existing player or spawn in a new one
• [x] Raw editor - load a .sav file and edit it directly as JSON in a code editor (with syntax highlighting and format/minify toggle), then save it back to .sav

Servers

• [x] Manage Palworld dedicated servers directly from the app (Windows, native) or with Docker (Windows/Linux/Mac)
• [x] Create and install servers with automatic SteamCMD detection/download and port suggestions
• [x] Start/stop servers, live console output, and player count monitoring
• [x] Edit server settings (PalWorldSettings.ini), including RCON and REST API configuration
• [x] Mod management - install, list, and toggle Steam Workshop mods, including the official PalModSettings.ini mod system for native servers
• [x] Load and manage a server's save file directly in the editor

Extras

• [x] Data Explorer / Debug Mode (Read Only) - browse and filter/sort Pals, Items, Active/Passive Skills, Buildings, and Technologies
• [x] In-app guides and wiki with table of contents and image lightbox
• [x] Preset management - Create and manage Player (Inventory), Pal, Active/Passive Skills, Storage presets.
• [x] Universal Pal Storage (UPS) lets you organize Pals into collections with customizable tags and instantly transfer one, many, or all Pals across any player and any save in a single action.

📜 License

GNU General Public License v3.0. You are free to use, modify, and redistribute this software, provided derivative works are released under the same license and their source is made available.

➡️ Related Projects

These are projects I've found that specifically target Palworld save files, each was helpful in some way during the development of this project:

• PalEdit - PSP was inspired by it.
• uesave-rs - The Rust library the current backend uses to read and write Palworld save files.
• palworld-save-tools - Python library for parsing Palworld saves; PSP's original Python backend was built on it.
• palworld-uesave-rs - An early reference while exploring save parsing.
• Palworld Pal Editor - Also served as a reference for Palworld Save Pal, adopted some of this projects approach.
• PalWorldSaveTools - Has a bunch of useful features for parsing, editing, and converting save files.

☕ Buy me a Coffee