DOCUMENTATION / v0.18.4

Installation guide

Choose where you play, then follow that installation route. Your computer and a remote server need separate setup.

Supported setup

Windows game client; Linux x86_64 dedicated servers use the matching package. These mods do not support Windows dedicated servers. Support for real guests joining a local host is not guaranteed.

Package reviewed: 0.18.4; game reference: Palworld v1.0.5.102999. If your downloaded version differs, check its included instructions first.

01 · Client, single player and local hosting

Exit the game and back up the save you will use. Subscribe to this mod on Workshop and wait for Steam to finish downloading.
Also subscribe to UE4SS Experimental (Palworld). Each mod is independent; PalSchema and the other mods on this site are not required.
Enable both the mod and its dependency in the game’s mod manager. Fully exit and restart; returning to the title screen is not enough.
Enter a backed-up world and follow Verify in game below. Do not load both manual and Workshop copies. Disable an older manual copy using its own instructions.

Open this mod on Workshop ↗UE4SS dependency ↗

If you join someone else’s server, install the client mod and send this guide to its administrator. World rules and server components need installation on that server; your subscription does not install them remotely. Local hosting loads the mod locally, but does not guarantee every guest scenario works.

02 · Linux dedicated server installation

Get the correct package

On the computer where Steam downloaded your subscription, open this folder inside your Steam library. Your library may be on another drive; the item ID is the number after id= in the Workshop URL.

steamapps/workshop/content/1623730/3811768120/

Upload the entire mod directory to a location outside the game directory. It must include Server, Linux/runtime and the installer. Client Scripts alone, or just the installer, are incomplete.

The installation directory must contain the files below. If the version or contents differ, check the Workshop release notes or comment on this project with the version number to confirm the complete Linux package. Do not substitute Windows DLLs, Info.json or client Scripts.

install-linux.sh
install-linux.py
package.json
SHA256SUMS.txt
Server/Scripts/
Linux/runtime/

Stop, back up and check the environment

Ask players to disconnect, stop the server normally and pause automatic restarts in your panel, systemd or other supervisor.
Back up Pal/Saved after shutdown. Record the launch command, arguments, account and working directory. The installer’s file backup is not a complete save backup.
Check for Linux x86_64, Python 3.9+ and fuser (usually from psmisc). Use the existing game account with write access to the game directory.
The game root must contain Pal/Binaries/Linux/PalServer-Linux-Shipping. Use real absolute paths without symlinks; replace the example paths below.

uname -m
python3 --version
command -v fuser

Preview the changes, then install

cd /path/to/package
sh install-linux.sh --game-root /path/to/game --dry-run

Review the result and proposed changes before running the next command. Resolve a running server, failed checksum or runtime conflict instead of bypassing the checks.

sh install-linux.sh --game-root /path/to/game

Keep the reported backup location. The installer preserves other mod entries, does not change ports, firewall rules or service configuration, and does not restart the server. It does not need your Steam password.

Installed script directory:

Pal/Binaries/Linux/Mods/AxPalboxQuickFavoriteServer/Scripts/

Connect it to your launch setup

Keep an existing working UE4SS launch entry. For a first installation, the installer generates the script below. Run it from the game root with your existing launch arguments.

AxPalboxQuickFavoriteServer.sh

In your panel or systemd service, adjust only the launch entry as needed. Preserve the account, working directory, port and bind address. Multiple mods share one UE4SS launch setup; do not start a server per mod. The installer does not edit your panel or service unit.

Containers and hosted panels require the administrator to use the actual mounted paths. If you cannot stop the server, manage files or change its launch entry, ask your host. Installing a mod does not require extra public ports.

03 · Verify loading, then gameplay

Installation success only confirms file placement. After starting, check Pal/Binaries/Linux/UE4SS.log for this mod’s loading messages and errors, then join with a matching client and verify its behavior.

[AxPalboxQuickFavoriteServer] LOADED v0.18.0

This package’s server component identifier can differ from its client version. That alone does not mean the installation is wrong.

What to check for this mod

Linux uses AxPalboxQuickFavoriteServer and needs both the client and service. Star filtering requires a compatible service at 0.18.0 or later; an older service rejects unsupported conditions rather than ignoring them. The current log identifier remains 0.18.0; this does not require downgrading the client.

Open your own Palbox, choose Quick Favorite, preview a narrow filter and review pending, unchanged and locked counts before confirming the target favorite level. It scans personal storage, not your party or base workers. Testing with one familiar Pal first is sensible, but is not a mandatory unlock step.

Continue to this mod’s usage guide →

04 · Updates, disabling and recovery

Client update: fully exit, let Steam finish updating, then restart. Linux update: notify players → stop and pause automatic restarts → back up saves and the old package → extract outside the game directory → dry-run → install → launch through UE4SS → verify logs and behavior. Use compatible client versions. Subscribing does not update a remote Linux installation.

Handle extra slots, structures or queues as described above before disabling. Disable the client mod and fully restart. On Linux, stop the server and run this from the matching package directory:

sh install-linux.sh --game-root /path/to/game --disable

Disable this mod only; keep UE4SS when other mods use it. To enable it again, stop and repeat normal installation. File rollback or disabling does not undo saved favorites, investments, buildings or processing results.

Restore installation files

This installer supports --restore. Use the actual backup path reported during installation. Stop, preview, then omit --dry-run after reviewing. If shared files have changed, compare differences instead of forcing an overwrite.

sh install-linux.sh --game-root /path/to/game --restore /path/to/backup --dry-run

Restoring the whole Pal/Saved directory also rolls back game progress. Preserve the current state before deciding whether a save restore is necessary.

Troubleshooting

install-linux.sh is missing: Check that you uploaded the complete directory, not a client-only copy.
The server is still running: Check whether a panel or supervisor restarted it. Retry after shutdown.
Checksum or runtime conflict: Get an intact package and check the existing runtime and other mod dependencies. Do not alter checksums or delete an unknown library to bypass validation.
Installed, but no effect: Check the UE4SS launch entry, Mods/mods.txt, module directory and both versions, then inspect the objects in this guide. One random drop or an old box is not a complete test.

Comment below with game and mod versions, server type or single-player setup, steps, full error and logs from the same time. Remove accounts, private paths and addresses; passwords are not needed.

Official documentation describes Workshop folders and server loading; these Linux steps use the bundled installer. Palworld server documentation ↗

← 返回项目Updated 2026-10-16