pooneyy
/
1Panel-Appstore
mirror of https://gitlink.org.cn/pooneyy/1Panel-Appstore
1
0
Fork 0
Code
1Panel-Appstore/palworld-server-tool/README_en.md

40 lines
2.0 KiB
Markdown
Raw Normal View History

docs: Add English README (#2676)
2024-12-04 21:08:28 +08:00
# Palworld Server Management Tool
**Manage dedicated Palworld servers with a visual interface and REST API.**
Features and Roadmap Based on `Level.sav` Save File Parsing:
- [x] Complete player data
- [x] Player Pal data
- [x] Guild data
Features Based on Official RCON Commands (Server-Only):
- [x] Retrieve server information
- [x] View online player list
- [x] Kick/ban players
- [x] In-game broadcasting
- [x] Smoothly shut down the server with broadcasted messages
This tool uses **bbolt** single-file storage to periodically fetch and store data from RCON and `Level.sav` files.
It provides a simple visual interface and REST API, making management and development easier.
fix: update Palworld and Palworld Server Tool settings (#2875) * fix: update Palworld and Palworld Server Tool settings 1.Adjust the default version 1.2.2 documentation link on the Palworld installation instructions page to correspond to the appropriate mirror link, with added explanations for the mirror version. 2.Modify the Palworld docker-compose file and data configuration file to include port mapping for the new REST API feature and environment variables for the manual configuration file modification feature. Added server description configurations, and revised the port mapping logic. 3.Update the Palworld Server Tool's docker-compose file and data configuration file to include new features from the latest version. Adjusted the save path mapping for compatibility with server. 1. 将palworld安装说明页面的默认版本1.2.2对应的文档链接调整为对应镜像的链接，增加了对镜像版本的说明。 2. 修改palworld的docker-compose文件和data配置文件，加入新功能rest api的端口映射和手动修改配置文件功能的环境变量，增加了服务器描述的配置，修改了端口映射的逻辑。 3. 修改palworld-server-tool的docker-compose文件和data配置文件，加入最近版本的新功能，修改了存档路径的映射可以直接配套服务器使用。 * fix: Configuration Setting Optimization
2024-12-31 13:09:39 +08:00
When deploying with Docker, you need to configure the external save path for the Palworld server. During installation, you must provide the corresponding external save path for the Palworld server.
docs: Add English README (#2676)
2024-12-04 21:08:28 +08:00
Ensure that private server RCON is enabled by following the instructions in the [official guide](https://github.com/zaigie/palworld-server-tool?tab=readme-ov-file#%E5%A6%82%E4%BD%95%E5%BC%80%E5%90%AF%E7%A7%81%E6%9C%8D-rcon).
---
Notes on Save File Parsing
> Parsing the `Level.sav` save file temporarily requires a certain amount of system memory (1GB~3GB) for short periods (<20s). The memory is released after the task is completed. Ensure your server has sufficient memory. If not, consider the following alternatives:
1. Deploy the tool on a separate server.
2. Use a local personal computer for deployment.
3. Opt for either of the above when the game server's performance is insufficient.
By default, the **PST tool and the game server are assumed to run on the same physical machine**. For separate deployments, refer to the following resources:
- [PST-Agent Deployment Guide](https://github.com/zaigie/palworld-server-tool/blob/main/README.agent.md)
- [Sync Save Files from k8s Pod](https://github.com/zaigie/palworld-server-tool?tab=readme-ov-file#%E4%BB%8E-k8s-pod-%E5%90%8C%E6%AD%A5%E5%AD%98%E6%A1%A3)