SERVER SAVE SYNC

Palworld Server Save Sync

Use palbeacon-cli to connect a self-hosted Palworld world save to PalBeacon. The client checks source files read-only on the server host, parses a safe copy, and sends only the sanitized inventory data required by the console.

Why the console needs save sync

PalBeacon does not pull inventory through a game-server control interface. A sync device brings current player, guild, and Pal facts into the console so inventory, data status, and breeding routes use one snapshot.

Create a sync device in your account, then copy its one-time pairing code.
Device status shows the latest check, last upload, and whether authorization remains valid.
After the first sync, players can claim their in-game character by nickname.

Install and initialize palbeacon-cli

The current npm package supports Linux x64 and Windows x64 and requires Node.js 22 or later. Both platforms use the same install command, and the package selects its bundled parser automatically.

npm install -g palbeacon-cli

palbeacon init

palbeacon init validates the platform and path, pairs the device, and saves per-user configuration; it does not perform the first sync.
The client does not download or compile a parser at runtime and needs no Python, compiler, or extra runtime.

Choose the correct world directory

Enter the target world directory containing Level.sav and Players/, or a parent that contains only one world. The client searches to a controlled depth for one Level.sav and rejects symlinks and paths that are too broad.

Paths may contain spaces or Unicode, and Windows drive-letter paths are supported.
If several worlds are found, the client asks you to narrow the path instead of guessing.
Browser uploads, macOS, other architectures, and local single-player saves are not currently supported.

Start synchronization and check status

palbeacon run is a foreground process. It syncs immediately on startup, then checks for save changes every 300 seconds by default; keep it running for continued updates.

palbeacon run

When the save is unchanged, the client sends a device heartbeat without parsing or uploading inventory again.
A temporary network or parser failure affects only that cycle; revoked device access stops the process and asks you to pair again.
After publication, check sync status in the console and select your nickname from the unclaimed characters.

Source save, temporary copy, and upload boundary

Every cycle checks that source files are stable, copies Level.sav and character saves from Players/ into a per-user temporary directory, and gives only that copy to the parser. Temporary files are removed afterward.

The client never modifies the real save and never runs save, restart, or other server control commands.
The complete save is never uploaded to PalBeacon; parsing happens on the safe copy on your server host.
Uploads are limited to player, guild, Pal, passive, gender, owner, and location facts required by inventory and breeding.
World, player, guild, Pal instance, and location identifiers are hashed before upload, and raw parser metadata is removed.

FAQ

Save sync questions

Which machine should run the sync client?

Run it on a Linux x64 or Windows x64 host that can read the target server world save, with Node.js 22 or later installed.

Does palbeacon init upload the save immediately?

No. init validates the platform and directory, pairs the device, and saves configuration. The first sync starts immediately when you run palbeacon run.

What if one directory contains several worlds?

Point the client at the world containing the target Level.sav and Players/. It stops when several worlds are found and never chooses one for you.

Does PalBeacon upload the complete Level.sav?

No. Level.sav and character saves are copied only to a local temporary directory for parsing. The cloud receives sanitized data needed by inventory and breeding features.

Will a failed sync repair or modify the game save?

No. A failure affects only that sync cycle. The client never writes back, repairs the save, or controls the game server.

KEEP EXPLORING

Related ways to use PalBeacon

Back to the PalBeacon home pageRead this guide Guild inventory collaborationRead this guide Save-based breeding planningRead this guide

NEXT STEP

Ready to connect your server?

Sign in to create a sync device and copy its one-time pairing code, then initialize the client on the host that stores your world save.