Skip to content

Palworld Pal Editor, the tool for Adding, Deleting, and Modifying Pals (and unlocking Viewing Cage for multiplayer) for Palworld Game Save, supports running on Docker, GUI, WebUI, and Cli.

License

Notifications You must be signed in to change notification settings

KrisCris/Palworld-Pal-Editor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Palworld Pal Editor

English | 简体中文

GitHub Repo Stars  GitHub Release GitHub Repo Downloads 

Python  PyPI - Version  PyPI - Downloads 

Ko-Fi  PayPal    AliPay  WeChat  PayPal 

Discord Server 

Star History Chart 

Supported Language

  • English | 日本語 | 简体中文 | French

What is this?

A Palworld Pal Editor developed by _connlost with ❤️.

(yeah i am just too lazy to change github username)

An old showcase video posted on youtube, the idea should be the same though.

Note

Steam Palworld Local Save Dir: %localappdata%\Pal\Saved\SaveGames

Your Game Save Dir: %localappdata%\Pal\Saved\SaveGames\[Your Steam ID]\[Your GameSave ID]

This tool currently only supports the Steam version of Palworld, if you are playing the Xbox Game Pass version, you can look into these two tools for save format conversion:

There are also some pinned messages in our Discord Server that provide knowledges on this topic.

Be aware that these tools can be outdated.

Important

Always backup your save in case corruption happens. (The tool does backup files for you.)

LET ME KNOW IF ANY BUG PRESENTS.

Screenshot

What This Tool Can Do

  • List Players and Their Pals
  • Show Pal Stats
  • Change Pal Species
  • Add Pal (To your inventory)
  • Delete Pal
  • Duplicate Pal
  • Change Pal Gender
  • Toggle Boss / Rare / Tower / Raid, etc.
  • Change Pal NickName
  • Add / Remove Pal Learned Attacks
  • Add / Remove Pal Equipped Attacks
  • Modify Pal Level / Exp
  • Modify Pal Condenser Level
  • Modify Pal Soul Levels
  • Modify Pal Work Suitabilities
  • Modify Pal Passive Skills
  • Modify Pal IV
  • Heal (and Revive) all pals and remove all negative effects.
  • Allow you to surpass the in-game limit, e.g. IV 255, Souls Level 255, Condenser Level 254; if you have the cheat option ON.
  • Edit Food Buff Timer (Only if the pal has food buff, and cli only)
  • Show / hide pals that are not stored in the player inventory (e.g. Pals in viewing cage, (or taken away by other players, prior Palworld v0.1.5))
  • Show / hide pals that are not displayed in game (Ghost Pals), so you can properly delete them.
  • Unlock Viewing Cage for Selected player (multiplayer server)
  • And More...

Future TODOs (No ETA)

  • Editing player character stats.
  • Unlocking technologies for player characters.
  • User defined skill presets.
  • The player group and pal container implementation overhaul, which enables me to properly label the containers (i.e. the inventory), and group the pals based on that and change pal ownerships.
  • A better UI?

Usage

Option A. Use Pre-Built Binary

Just run the executable, you don't need to install Python.

Note

There is no need for you to read further if your goal is simply downloading the tool and modify your game save.

You can always run the editor in a modern web browser, in case the GUI isn't working properly for you. Also there is an issue ticket that you may found useful.

Alternatively you can find the version that uses Chromium here, which should hopefully fix all the GUI issues.

Option B. Install via pip

  1. Make sure you have Python 3.11+
  2. pip install --upgrade palworld-pal-editor
  3. python -m palworld_pal_editor

Option C. Docker Container

  1. Download the compose file: ./docker/sample-docker-compose.yml.
  2. Rename it to docker-compose.yml, then configure it properly.
  3. Run docker compose up -d.

If you want to manually build it

  1. Clone the code.
  2. Copy ./docker/sample-docker-compose.yml to ./docker/docker-compose.yml, then do necessary modifications.
  3. Run ./build_and_run_docker.sh, or just manually run the commands if you are using Windows.

Option D. Directly Run the Code

  1. Install Python 3.11+ and node.js.
  2. Clone / Download the code
  3. In the project directory, run setup_and_run.ps1 for Windows Powershell, or setup_and_run.sh on Unix-like OS.
  4. In cli mode, You can change language by calling lang($LANG_CODE).

Optional Command-line Args

options:
  -h, --help           show this help message and exit
  --lang LANG          Language for the application. options: en, zh-CN, ja
  --path PATH          Path to the save folder.
  --mode MODE          Running Mode, options: cli, gui, web
  --port PORT          Port used for WebUI mode.
  --password PASSWORD  Password for WebUI.

Config File

Note

  1. There is no need for you to manually modify the config file.
  2. Command line arguments override config, and will be saved.

Default:

// config.json
{
    "i18n": "en",
    "mode": "web",
    "port": 58080,
    "path": null,
    "password": null,
    "JWT_SECRET_KEY": "X2Nvbm5sb3N0"
}

Custom:

// config.json
{
    "i18n": "zh-CN",
    "mode": "gui",
    "port": 12345,
    "path": "/path/to/save/folder",
    "password": "YOUR PASSWORD FOR WEBUI AUTH",
    "JWT_SECRET_KEY": "JUST SOME RANDOM TEXTS"
}

Videos

Note

In case someone is running the macOS build...

Screen.Recording.2025-01-04.at.2.08.46.AM.mov

Important

These videos show you how to run the code (and they are pretty old, but you get the idea). If you are using the pre-built executable, you can skip these parts.

  • DOCKER
2024-03-03.13-29-42.mp4
  • GUI / WEB
Screen.Recording.2024-03-03.at.2.57.13.AM.mp4
  • CLI: (old, but you get the idea)
2024-02-25.14-49-22.mp4

Contribution

  1. If you found a bug, or are looking for a feature, please check Issues first.
  2. If you want to contribute code, please check out the latest branch.
  3. Open a PR so everyone knows what you are working on.

Sponsor

If you like this tool, consider supporting me to help me continue developing and maintaining it.

Ko-Fi  PayPal    AliPay  WeChat 

ko-fi ❤️

PayPal

AliPay WeChat

Thanks


Why?

  1. I made the tool for my friends who spent time playing this game with me ❤.
  2. For practicing my 2-year untouched Python skills.
  3. Fun, I am just too boring these days.
  4. This guy had a really bad time fixing both his corrupted game save, and bugs of a similar tool.