Manage your Palworld dedicated server through a visual interface and REST API, using SAV file parsing and RCON functionalities.
And it took a long and boring time to i18n...
The current mobile adaptation is good, you can view Function Screenshot
Of course, the dark mode is also arranged no problem ~
Features based on parsing of Level.sav save files:
- Complete player data
- Player Palworld data
- Guild data
Features implemented using official RCON commands (available only for servers):
- Retrieve server information
- Online player list
- Kick/ban players
- In-game broadcasting
- Smooth server shutdown with broadcast message
Additional features provided by the tool:
- Whitelist management
- Defines and executes the RCON command
This tool uses bbolt for single file storage, fetching and saving data from RCON and Level.sav files via scheduled tasks. It provides a simple visual interface and REST API for easy management and development.
Due to limited maintenance and development staff, we welcome front-end, back-end developers, and even data engineers to submit PRs!
pal-en.mp4
 |
 |
Caution
In version v0.1.5.0 of the game server, RCONPort and RCONEnable in PalWorldSettings.ini do not take effect
Please add -RCONPort=25575 after ./PalServer.sh (Linux) or PalServer.exe (Windows) to enable
You need to enable RCON functionality on your server. If your private server tutorial includes this, great. If not, modify the PalWorldSettings.ini file.
This is the file where various in-game multipliers and probabilities are set. At the end of the file, you'll find:
AdminPassword=...,...,RCONEnabled=true,RCONPort=25575
Please shut down the server before making modifications. Set an AdminPassword, and fill in RCONEnabled and RCONPort as shown above. Then restart the server.
Make sure RCON first How to Enable RCON for Private Servers
The task of parsing
Level.savrequires some system memory (often 1GB-3GB) in a short period (<20s) , this portion of memory is released after the parsing task is completed. Ensure your server has enough memory.
Rimer believes that by putting the pst tool and the game server on the same physical machine, there are some situations where you might not want to deploy them on the same machine:
- Must be deployed separately on another server
- Only need to deploy on a local PC
- The game server performance is weak and not satisfied, using one of the above two schemes
Please refer to pst-agent deployment tutorial or Synchronizing Archives from k8s-pod
Download the latest executable files at:
# Download pst_{version}_{platform}_{arch}.tar.gz and extract to the pst directory
mkdir -p pst && tar -xzf pst_v0.5.7_linux_x86_64.tar.gz -C pst-
Open the directory and allow execution
cd pst chmod +x pst sav_cli -
Find the
config.yamlfile and modify it as per the instructions.For
decode_path, it's usually the pst directory plussav_cli. If unsure about the absolute path, executepwdin the terminal.# WebUI Config web: # WebUI Admin Password password: "" # WebUI Port port: 8080 # Enable TLS tls: false # TLS Cert File Path if Enable TLS cert_path: "" # TLS Key File Path if Enable TLS key_path: "" # TLS url for sav_cli to communicate eg. https://yourdomain.com public_url: "" # RCON Config rcon: # RCON Address Port address: "127.0.0.1:25575" # Server AdminPassword password: "" # RCON Timeout Sec timeout: 5 # RCON Communication Interval Sec sync_interval: 60 # sav_cli Config save: # Sav File Path path: "/path/to/your/Pal/Saved" # Sav_cli Path decode_path: "/path/to/your/sav_cli" # Sav Decode Interval Sec sync_interval: 120 # Automation Config manage: # Auto Kick non-whitelisted kick_non_whitelist: false
./pst2024/01/31 - 22:39:20 | INFO | palworld-server-tool/main.go:75 | Starting PalWorld Server Tool...
2024/01/31 - 22:39:20 | INFO | palworld-server-tool/main.go:76 | Version: Develop
2024/01/31 - 22:39:20 | INFO | palworld-server-tool/main.go:77 | Listening on http://127.0.0.1:8080 or http://192.168.1.66:8080
2024/01/31 - 22:39:20 | INFO | palworld-server-tool/main.go:78 | Swagger on http://127.0.0.1:8080/swagger/index.html
For background operation (running after SSH window is closed):
# Run in the background and save the log in server.log
nohup ./pst > server.log 2>&1 &
# To view logs
tail -f server.logkill $(ps aux | grep 'pst' | awk '{print $2}') | head -n 1Access via browser at http://127.0.0.1:8080 or http://{Local Network IP}:8080
Access at http://{Server IP}:8080 after opening firewall and security group in cloud servers.
Warning
If you open the file for the first time, nothing will be displayed. Please wait until the first sav archive synchronization is complete
If your server configuration is sufficient and performance is good, you can try to make save.sync_interval shorter.
Extract pst_v0.5.7_windows_x86_64.zip to any directory (recommend naming the folder pst).
Find the config.yaml file in the extracted directory and modify it according to the instructions.
For decode_path, it's typically the pst directory plus sav_cli.exe.
You can also right-click - "Properties", view the path and file name, and then concatenate them. (Same for archive file path and tool path)
Warning
Instead of pasting the copied path directly into config.yaml, add another '\' in front of all '\', as shown below
It is also important to make sure that the config.yaml file is ANSI encoded, other encoding formats will cause problems such as path errors!!
# WebUI Config
web:
# WebUI Admin Password
password: ""
# WebUI Port
port: 8080
# Enable TLS
tls: false
# TLS Cert File Path if Enable TLS
cert_path: ""
# TLS Key File Path if Enable TLS
key_path: ""
# TLS url for sav_cli to communicate eg. https://yourdomain.com
public_url: ""
# RCON Config
rcon:
# RCON Address Port
address: "127.0.0.1:25575"
# Server AdminPassword
password: ""
# RCON Timeout Sec
timeout: 5
# RCON Communication Interval Sec
sync_interval: 60
# sav_cli Config
save:
# Sav File Path
path: "C:\\path\\to\\your\\Pal\\Saved"
# Sav_cli Path
decode_path: "C:\\path\\to\\your\\sav_cli.exe"
# Sav Decode Interval Sec
sync_interval: 120
# Automation Config
manage:
# Auto Kick non-whitelisted
kick_non_whitelist: falseTwo ways to run on Windows:
-
start.bat (Recommended)
Find and double-click the
start.batfile in the extracted directory. -
Press
Win + R, enterpowershellto open Powershell, navigate to the directory of the downloaded executable file using thecdcommand..\pst.exe
2024/01/31 - 22:39:20 | INFO | palworld-server-tool/main.go:75 | Starting PalWorld Server Tool...
2024/01/31 - 22:39:20 | INFO | palworld-server-tool/main.go:76 | Version: Develop
2024/01/31 - 22:39:20 | INFO | palworld-server-tool/main.go:77 | Listening on http://127.0.0.1:8080 or http://192.168.31.214:8080
2024/01/31 - 22:39:20 | INFO | palworld-server-tool/main.go:78 | Swagger on http://127.0.0.1:8080/swagger/index.html
If you see the preceding interface, it indicates that the operation is successful. Keep the window open.
Access via browser at http://127.0.0.1:8080 or http://{Local Network IP}:8080
Access at http://{Server IP}:8080 after opening firewall and security group in cloud servers.
Warning
If you open the file for the first time, nothing will be displayed. Please wait until the first sav archive synchronization is complete
If your server configuration is sufficient and performance is good, you can try to make save.sync_interval shorter.
Only one container is needed. Map the game's save directory to the container's internal directory, running on the same physical host as the game server.
Note: Using swap partitions may cause a decrease in program performance.Do not use it when your server has enough memory.
docker run -d --name pst \
-p 8080:8080 \
-m 256M --memory-swap=4G `# optional limit memory to 256M and memory-swap to 4G` \
-v /path/to/your/Pal/Saved:/game \
-e WEB__PASSWORD="your password" \
-e RCON__ADDRESS="172.17.0.1:25575" \
-e RCON__PASSWORD="your password" \
-e SAVE__PATH="/game" \
-e SAVE__SYNC_INTERVAL=120 \
jokerwho/palworld-server-tool:latestMost importantly, use -v to map the game's save file (Level.sav) directory to the container's /game directory.
If you need to persist the pst.db file:
# Create the file first to prevent it from being recognized as a directory
touch pst.dbThen add -v ./pst.db:/app/pst.db in docker run -v.
Set various environment variables, similar to those in config.yaml. The table below lists them:
Warning
Pay attention to the distinction between single and multiple underscores. It's best to copy the variable names from the table below for modifications!
| Variable Name | Default Value | Type | Description |
|---|---|---|---|
| WEB__PASSWORD | "" | Text | Password for Web interface admin mode |
| WEB__PORT | 8080 | Number | Changing the container mapping port is recommended instead of modifying this |
| RCON__ADDRESS | "127.0.0.1:25575" | Text | RCON service address, can use container network 172.17.0.1:25575 |
| RCON__PASSWORD | "" | Text | AdminPassword in the server configuration file |
| RCON__TIMEOUT | 5 | Number | Timeout for individual RCON service requests |
| RCON__SYNC_INTERVAL | 60 | Number | Interval for requesting RCON server to sync player online data |
| SAVE__PATH | "" | Text | Game save path be sure to fill in the path inside the container |
| SAVE__DECODE_PATH | "/app/sav_cli" | Text | |
| SAVE__SYNC_INTERVAL | 600 | Number | Interval for syncing player save data |
| MANAGE__KICK_NON_WHITELIST | false | 布尔 | Automatically kicked out when it detects that a player is not whitelisted but is online |
Two containers are required: palworld-server-tool and palworld-server-tool-agent.
Applicable for:
- Separate deployment on other servers.
- Deployment only on a local personal computer.
- If the game server's performance is weak and does not meet the requirements, use one of the above two schemes.
docker run -d --name pst-agent \
-p 8081:8081 \
-v /path/to/your/Pal/Saved:/game \
-e SAV_FILE="/game" \
jokerwho/palworld-server-tool-agent:latestYou need to -v to the directory where the game save file (Level.sav) is located, mapping it to the /game directory in the container.
| Variable Name | Default Value | Type | Description |
|---|---|---|---|
| SAV_FILE | "" | Text | Game save path be sure to fill in the path inside the container |
docker run -d --name pst \
-p 8080:8080 \
-e WEB__PASSWORD="your password" \
-e RCON__ADDRESS="Game server IP:25575" \
-e RCON__PASSWORD="your password" \
-e SAVE__PATH="http://Game server IP:Agent port/sync" \
-e SAVE__SYNC_INTERVAL=120 \
jokerwho/palworld-server-tool:latestIf you need to persist the pst.db file:
# Create the file first to prevent it from being recognized as a directory
touch pst.dbThen add -v ./pst.db:/app/pst.db in docker run -v.
Warning
Pay attention to the distinction between single and multiple underscores. It's best to copy the variable names from the table below for modifications!
| Variable Name | Default Value | Type | Description |
|---|---|---|---|
| WEB__PASSWORD | "" | Text | Password for Web interface admin mode |
| WEB__PORT | 8080 | Number | It's recommended to change the container mapping port instead of modifying this |
| RCON__ADDRESS | "127.0.0.1:25575" | Text | RCON service address, typically Game server IP:25575 |
| RCON__PASSWORD | "" | Text | AdminPassword in the server configuration file |
| RCON__TIMEOUT | 5 | Number | Timeout for individual RCON service requests |
| RCON__SYNC_INTERVAL | 60 | Number | Interval for requesting RCON server to sync player online data |
| SAVE__PATH | "" | Text | pst-agent service address, format as http://{Game server IP}:{Agent port}/sync |
| SAVE__DECODE_PATH | "/app/sav_cli" | Text | |
| SAVE__SYNC_INTERVAL | 600 | Number | Interval for syncing player save data |
| MANAGE__KICK_NON_WHITELIST | false | 布尔 | Automatically kicked out when it detects that a player is not whitelisted but is online |
Starting from v0.5.3, it is supported to synchronize game server archives within a cluster without the need for an agent.
Make sure that the serviceaccount used by pst has "pods/exec" permissions!
You only need to change the SAVE__PATH environment variable, in the following format:
SAVE__PATH="k8s://<namespace>/<podname>/<container>:<Game Archive Directory>"For example:
SAVE__PATH="k8s://default/palworld-server-0/palworld-server:/palworld/Pal/Saved"Since the time and location (including HASH) of the Level.sav file created by the game server are uncertain at the first instance, you only need to point to the Saved directory level, and the program will automatically scan.
When pst and the game server are in the same namespace, you can omit it:
SAVE__PATH="k8s://palworld-server-0/palworld-server:/palworld/Pal/Saved"Starting from v0.5.3, it is supported to synchronize game server archives inside a container without the need for an agent.
When your pst application is deployed through running a binary file, you just need to modify the save.path in config.yaml:
save:
path: "docker://<container_name_or_id>:<game_save_directory>"For example:
save:
path: docker://palworld-server:/palworld/Pal/Saved
# or
save:
path: docker://04b0a9af4288:/palworld/Pal/SavedIf the pst application is deployed as a Docker single container, then you need to modify the SAVE__PATH environment variable and mount the Docker daemon inside the pst container.
- Mount the daemon
In the original docker run command, add the line -v /var/run/docker.sock:/var/run/docker.sock.
- Modify the environment variable
Change the SAVE__PATH environment variable as follows:
SAVE__PATH="docker://<container_name_or_id>:<game_save_directory>"For example:
SAVE__PATH="docker://palworld-server:/palworld/Pal/Saved"
#or
SAVE__PATH="docker://04b0a9af4288:/palworld/Pal/Saved"Warning
If you see an error like Error response from daemon: client version 1.44 is too new. Maximum supported API version is 1.43 after running, it is because the Docker API version used by your current docker engine is too low. In this case, please add another environment variable:
-e DOCKER_API_VERSION="1.43" (your API version)
Since the time and location (including HASH) of the Level.sav file created by the game server are uncertain at the first instance, you only need to point to the Saved directory level, and the program will automatically scan.
- palworld-save-tools for providing save file parsing tool implementation
- palworld-server-toolkit for providing high performance save file parsing
- PalEdit for providing the initial conceptualization and logic for data processing
- gorcon for providing the basic ability to send/receive RCON requests
According to the Apache2.0 LICENSE authorization, any reprints please indicate in the README and document section! Any commercial behavior must be informed!