This repo is your control plane for a local Windows Palworld dedicated server. Current baseline uses UE4SS experimental/prerelease builds.
- Keep the actual server install in:
C:\Program Files (x86)\Steam\steamapps\common\PalServer - Keep your mod folders and automation here.
scripts/Deploy-All.ps1: One-command deploy for config overlay + all mod systems.scripts/Deploy-PalServerMods.ps1: Copies mod folders into serverMods/Workshopand rewritesMods/PalModSettings.ini.scripts/Deploy-UE4SSRuntime.ps1: Copies UE4SS runtime using new layout (Win64\dwmapi.dll+Win64\ue4ss\...) with backups and legacy cleanup.scripts/Deploy-UE4SSMods.ps1: Copies UE4SS mod folders intoPal\Binaries\Win64\ue4ss\Mods.scripts/Deploy-PalDefender.ps1: Copies PalDefender package files intoPal\Binaries\Win64with automatic backups.scripts/Start-PalServerLocalOnly.ps1: Starts dedicated server without-publiclobby(direct IP only).scripts/Set-PalServerLoopbackOnly.ps1: Optional firewall hardening to block inbound UDP from network peers.scripts/Sync-DevReferenceDocs.ps1: Downloads modding docs snapshots intodocs/dev-reference/upstream/for local agent reference.mods/workshop/: Put one subfolder per mod. Each folder must containInfo.jsonat its root.mods/ue4ss-runtime/package/: Put UE4SS runtime package files here before deploy.mods/ue4ss/: Put one subfolder per UE4SS script mod (example:PalZones). Keep your managedmods.txthere.mods/paldefender/package/: Put PalDefender binaries/package files here before deploy.config/overlay/: Server-root-relative config files to enforce during global deploy.docs/dev-reference/: Curated modding references and downloaded upstream snapshots.
- Launch
Palworld Dedicated Serveronce from Steam, then stop it. - Verify these exist under your server folder:
PalServer.exeMods/PalModSettings.ini(auto-created on first run)Pal/Saved/Config/WindowsServer/PalWorldSettings.ini(or copy from default)
Place each server-compatible mod in:
mods/workshop/<any-folder-name>/Info.json
Important:
PackageNameinInfo.jsonis what gets added toActiveModList.- Folder name does not have to match
PackageName. - Mods must be server-compatible (
InstallRulesinclude server install behavior).
.\scripts\Deploy-All.ps1This deploys, in order:
- config overlay (
config/overlay-> server root) - UE4SS runtime
- UE4SS mods (if any found)
- PalDefender
- official server mods (if any found)
Useful skip flags:
.\scripts\Deploy-All.ps1 -SkipUE4SSMods -SkipOfficialModsConfig overlay is a file-level merge copy (it does not replace whole directories).
.\scripts\Deploy-PalServerMods.ps1Optional custom paths:
.\scripts\Deploy-PalServerMods.ps1 `
-PalServerRoot "C:\Program Files (x86)\Steam\steamapps\common\PalServer" `
-SourceWorkshopDir ".\mods\workshop"Put files in:
mods/ue4ss-runtime/package
Expected package layout:
mods/ue4ss-runtime/package/dwmapi.dllmods/ue4ss-runtime/package/ue4ss/...mods/ue4ss-runtime/package/ue4ss/MemberVariableLayout.ini(required for current Palworld experimental compatibility)
Source for UE4SS runtime (use compatible prerelease/experimental build):
- https://github.com/UE4SS-RE/RE-UE4SS/releases
- https://github.com/Okaetsu/RE-UE4SS/releases/tag/experimental-palworld
.\scripts\Deploy-UE4SSRuntime.ps1This script backs up replaced files to:
Pal\Binaries\Win64\palworld-mod-backups\ue4ss-runtime-<timestamp>
.\scripts\Deploy-UE4SSMods.ps1mods/ue4ss/mods.txt is copied to the target UE4SS mods folder each deploy.
Optional custom source:
.\scripts\Deploy-UE4SSMods.ps1 -SourceUE4SSModsDir ".\mods\ue4ss"Put files in:
mods/paldefender/package
.\scripts\Deploy-PalDefender.ps1This script backs up replaced files to:
Pal\Binaries\Win64\palworld-mod-backups\paldefender-<timestamp>
.\scripts\Start-PalServerLocalOnly.ps1Connect from the same machine with:
127.0.0.1:8211
.\scripts\Set-PalServerLoopbackOnly.ps1 -Port 8211This creates a block rule for inbound UDP on the server port to reduce accidental LAN reachability.
.\scripts\Sync-DevReferenceDocs.ps1This pulls current official/community docs into docs/dev-reference/upstream/ and writes manifest.json with URLs and fetch status.
- Do not use
-publiclobbyfor private local setup. - Do not add router port forwarding.
- Restart server after deploying/updating mods.
- If
Program Files (x86)writes fail, run PowerShell as Administrator.