Skip to main content

Yet Another Palworld Pal Editor.

Project description

Palworld Pal Editor

English | 简体中文

GitHub Repo Stars   GitHub Repo Downloads   Discord Server   Python   Vue.js  

Supported Language

  • English | 日本語 | 简体中文

What is this?

A Palworld Pal Editor developed by _connlost with ❤️

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

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

  • 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 WEB BROWSER, IN CASE THE GUI ISN'T WORKING PROPERLY FOR YOU.

A. Use Pre-Built Binary

Just download from GitHub Release Page or Nexusmods, may not be the latest code.

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

C. Docker Container

  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.

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: Command Line Arguments Override Config

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",
    "JWT_SECRET_KEY": "YOUR SECRETS"
}

Videos

  • 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

Star History Chart

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

ko-fi ❤️

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

palworld-pal-editor-0.3.4.tar.gz (20.0 MB view hashes)

Uploaded Source

Built Distribution

palworld_pal_editor-0.3.4-py3-none-any.whl (20.0 MB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page