Yet Another Palworld Pal Editor.
Project description
Palworld Pal Editor
English | 简体中文
Supported Language
- English | 日本語 | 简体中文
[!NOTE] The UI is hardcoded in English, but there isn't much text, and the emojis should be very easy to understand.
At the end of the day, you can always use Chrome translation, if you are running it in web mode. (You don't need to worry about translation messing up the data we write to the save, we are not using plain text.)
What is this?
A Palworld Pal Editor developed by _connlost with ❤️
(yeah i am just too lazy to change github username)
[!NOTE] 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:
Meanwhile, you are welcomed to submit a xbox game save, so that I can look into.
[!IMPORTANT] Always backup your save in case corruption happens. (The tool does backup files for you.)
LET ME KNOW IF ANY BUG PRESENTS.
- Palworld Pal Editor
What This Tool Can Do
- Spawn Pal
- Duplicate Pal
- Delete Pal
- Show / Hide pals that are not in player pal containers (e.g. Pals in viewing cage, (or taken away by other players, prior Palworld v0.1.5))
- Show (so you can delete them) / hide pals that are not displayed in game (Ghost Pals).
- Unlock Viewing Cage for Selected player (multiplayer server)
- List Players and Pals
- Inspect Pal Stats
- Change Pal Gender
- Toggle BOSS / Rare / Tower
- Change Pal NickName
- Add / Remove Pal Learned Attacks
- Add / Remove Pal Equipped Attacks
- Change Pal Level / Exp
- Change Pal Condenser Level
- Change Pal Soul Levels
- Change CharacterID (Pal Species)
- Change Pal Passive Skills
- Change Pal IV
- Calculate MaxHP
- Remove Pal Sicks
- Revive Pals
- Edit Food Buff Timer (Only if the pal has food buff, and cli only)
Usage
[!NOTE] You can always run the editor in a modern web browser, in case the GUI isn't working properly for you.
Alternatively you can find the version that uses Chromium here, which should hopefully fix all the GUI issues.
Option A. Use Pre-Built Binary
Just run the executable, you don't need to install Python.
- Stable Version:
- Nightly Builds:
Option B. Install via pip
- Make sure you have Python 3.11+
pip install --upgrade palworld-pal-editor
python -m palworld_pal_editor
Option C. Docker Container
- Clone the code.
- Copy
./docker/sample-docker-compose.yml
to./docker/docker-compose.yml
, then do necessary modifications. - Run
./build_and_run_docker.sh
, or just manually run the commands if you are using Windows.
Option D. Directly Run the Code
- Install Python 3.11+ and node.js.
- Clone / Download the code
- In the project directory, run
setup_and_run.ps1
for Windows Powershell, orsetup_and_run.sh
on Unix-like OS. - In
cli
mode, You can change language by callinglang($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]
- There is no need for you to manually modify the config file.
- 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
[!IMPORTANT] These videos show you how to run the code. If you are using the pre-built executable, you can skip these part.
- DOCKER
https://github.com/KrisCris/Palworld-Pal-Editor/assets/38860226/d7008b22-a2ff-4a2c-8903-32bab0922b32
- GUI / WEB
https://github.com/KrisCris/Palworld-Pal-Editor/assets/38860226/66f3cb1e-f1fc-401e-b8a1-987ac3e6b02d
- CLI: (old, but you get the idea)
https://github.com/KrisCris/Palworld-Pal-Editor/assets/38860226/02284dda-f1d7-40af-b12d-6b4ae11d4113
Possible Roadmap? (NO ETA)
- Improve WebUI (I am bad at frontend dev, sorry! Contribution appreciated.)
- Real GUI, or maybe just a Terminal GUI using Textual.
- Move Pal to Different Slots? Change owner? IDK...
- More Stuff...
Star History
Contribution
- If you found a bug, or are looking for a feature, please check Issues first.
- If you want to contribute code, please check out the latest branch.
- Open a PR so everyone knows what you are working on.
Sponsor
Thanks
- Take-Me1010 for Japanese translation.
- Fast game save loading code by MagicBear.
- Save conversion between GVAS and
.sav
by palworld-save-tools. - Inspired by MagicBear's awesome Palworld-Server-Toolkit.
- Inspired by EternalWraith's PalEdit.
Why?
- I made the tool for my friends who spent time playing this game with me ❤.
- For practicing my 2-year untouched Python skills.
- Fun, I am just too boring these days.
- This guy had a really bad time fixing both his corrupted game save, and bugs of a similar tool.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for palworld-pal-editor-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9308350a5d03ccfa7a25a14d4d897e575372800f3a92b76286a5290441c2595 |
|
MD5 | afbd2cbdf3c9790598cc641bd7531dfd |
|
BLAKE2b-256 | e5aaf1c3b955314835a657d154f69773b36e8ed559da3bc3c241d7904a4b6f30 |
Hashes for palworld_pal_editor-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a731e6759644bbbf6fbf2277f737b93a94cadce5824c9c0cb4e97e4c60b1d230 |
|
MD5 | 6da9dd39bbea152e59f8e81df47f7e1f |
|
BLAKE2b-256 | ad11b54ab0474d8721d5064099e805508faa55f61fbce5262438a7ebae07760b |