Tools for converting Palworld .sav files to JSON and back
Project description
palworld-save-tools
Tools for converting Palworld .sav files to JSON and back.
This tool currently supports additional parsing of the following data in the Level.sav
not handled by uesave
or other non-Palworld aware Unreal save editors, emcompassing almost all known data structures as of Palworld v0.1.4.0:
GroupSaveDataMap
- Groups such as in-game organizations and guilds
CharacterSaveParameterMap
- Characters such as players and pals
MapObjectSaveData
ItemContainerSaveData
CharacterContainerSaveData
DynamicItemSaveData
FoliageGridSaveDataMap
BaseCampSaveData
WorkSaveData
Instructions
[!IMPORTANT] Converting
Level.sav
files to JSON will result in very large files, and may require significant amounts of RAM to process. Use a modern text editor such as Visual Studio Code or a Jetbrains IDE to open these files.
Prerequisites
- Python 3.9 or newer.
- Windows users: You can install Python 3.12 from the Microsoft Store or from python.org
Windows GUI steps
- Download the latest release from [https://github.com/cheahjs/palworld-save-tools/releases/latest].
- Unzip the file into a folder.
- Drag and drop your
.sav
file (for Steam on Windows, these are located at%LOCALAPPDATA%\Pal\Saved\SaveGames\<SteamID>\<SaveID>
) ontoconvert.cmd
to convert the file into JSON. - To convert the
.sav.json
file back into a.sav
file, drag and drop your.sav.json
file ontoconvert.cmd
.
[!NOTE] In the event that the
convert.cmd
fails to function correctly, try to disable Python's app execution aliases ("Manage app execution aliases"), or failing that, please use the Terminal instructions below
Terminal
- Download the latest release from [https://github.com/cheahjs/palworld-save-tools/releases/latest].
- Unzip the file into a folder.
- Open a terminal in the folder you just unzipped.
- Depending on how Python is installed, the next steps should use either
python
,python3
, orpy
. - Run
python convert.py <path to .sav file>
to convert the.sav
file to a.sav.json
file. - Run
python convert.py <path to .json file>
to convert the.sav.json
file to a.sav
file.
[!NOTE] On Windows, you can drag and drop the
convert.py
file and the.sav
/.sav.json
file to avoid typing out the path.
Additional command line arguments:
--to-json
: Force SAV to JSON conversion regardless of file extension--from-json
: Force JSON to SAV conversion regardless of file extension--output
: Override the default output path--minify-json
: Minify output JSON to help speed up processing by other tools consuming JSON--force
: Overwrite output files if they exist without prompting--custom-properties
: Comma-separated list of paths from paltypes.py to decode. This can be used to ignore processing of types that are not of interest. For example--custom-properties .worldSaveData.GroupSaveDataMap,.worldSaveData.CharacterSaveParameterMap.Value.RawData
will only parse guild data and character data.
Developers
This library is available on PyPi, and can be installed with
pip install palworld-save-tools
[!NOTE] Due to ongoing rapid development and the potential for breaking changes, the recommendation is to pin to a specific version, and take updates as necessary.
Roadmap
- Parse all known blobs of data
- Optimize CPU and memory usage
Development philosophy
- No additional dependencies. Scripts should run with a default install of Python. Distributing binary builds of Python is laden with AV false positives.
- Optional dependencies are allowed, for example switching out the stdlib's JSON library for something more performant.
- Correctness of the conversion process is more important than performance. SAV > JSON > SAV should yield bit-for-bit identical files (pre-compression).
Projects that make use of palworld-save-tools
[!NOTE] This does not serve as an endorsement of any of these projects, use at your own risk.
- xNul/palworld-host-save-fix - Migrating save data between player IDs (eg, converting coop saves to dedicated server saves)
- PalEdit - GUI for editing Pals
- palworld-server-tool - Managing dedicated servers via RCON and SAV file parsing
- palworld-server-toolkit - Assorted set of SAV file manipulations
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_save_tools-0.21.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 224ba3009e193af4b6ee85697874e005c25f47f18edf308c22808b29ff280835 |
|
MD5 | 0dcaa0f5f5a31e42b0808d0034a61b5b |
|
BLAKE2b-256 | 7a3dc695c2e370f68e5dad96e4036a7c4776611bd9fb86b9d8c73b08584ff0c9 |
Hashes for palworld_save_tools-0.21.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae4ed34dd2f29f97bbe9890f890802c508a897fea91c2973426853f003274688 |
|
MD5 | faa38e8cf73cf8895032a1178d996480 |
|
BLAKE2b-256 | 410874f97a5bafc89ef774914087ccec5716ca8efc97e859cf35b90a3e2c9a79 |