thejcpalma/palworld-dedicated-server

Palworld专用服务器Docker镜像

https://github.com/thejcpalma/palworld-dedicated-server-docker/actions/workflows/release.yml/badge.svg](https://github.com/thejcpalma/palworld-dedicated-server-docker/actions/workflows/release.yml) https://github.com/thejcpalma/palworld-dedicated-server-docker/actions/workflows/development.yml/badge.svg](https://github.com/thejcpalma/palworld-dedicated-server-docker/actions/workflows/development.yml) !https://img.shields.io/docker/pulls/thejcpalma/palworld-dedicated-server !https://img.shields.io/docker/stars/thejcpalma/palworld-dedicated-server !https://img.shields.io/docker/image-size/thejcpalma/palworld-dedicated-server/latest https://img.shields.io/badge/readme-dev-blue?link=https%3A%2F%2Fgithub.com%2Fthejcpalma%2Fpalworld-dedicated-server-docker%2Fblob%2Fmain%2FREADME.md](https://github.com/thejcpalma/palworld-dedicated-server-docker?tab=readme-ov-file#palworld-dedicated-server-docker) !https://img.shields.io/***/1206023011011141702?logo=***&label=***&link=https%3A%2F%2F***.gg%2FycanfK9R5B

https://img.shields.io/badge/Docker_Hub-palworld-blue?logo=docker](https://hub.docker.com/r/thejcpalma/palworld-dedicated-server) https://img.shields.io/badge/ghrc.io-palworld-blue?logo=github](https://github.com/thejcpalma/palworld-dedicated-server-docker/pkgs/container/palworld-dedicated-server-docker)

[!TIP] 想与社区交流吗？🧑‍💻

加入我们的*服务器 🚀**

此Docker镜像包含您自己的https://store.steampowered.com/app/***/Palworld/%E4%B8%93%E7%94%A8%E6%9C%8D%E5%8A%A1%E5%99%A8%E3%80%82

该容器已在以下操作系统上测试并可正常工作：

• Linux (Ubuntu/Debian、Arch和Fedora)
• Windows 10、11

[!IMPORTANT] 目前，Xbox GamePass/Xbox主机玩家无法加入专用服务器。

他们需要通过邀请码加入玩家会话，且最多仅限4名玩家。

---

目录

• 开始前的准备工作
• 服务器要求
• 需要支持？请这样做！
• 快速开始
• 环境变量
• Docker-Compose配置
• 特殊功能
  • 【自动】重启和【自动】更新
  • 玩家监控
• 备份管理器
• 运行RCON命令
• *** Webhook集成
  • 支持的事件
• 常见问题(FAQ)
• 使用的软件
• 特别鸣谢
• 许可证

镜像概述和主要用途

本Docker镜像旨在提供一个简单、高效的方式来部署和管理Palworld专用服务器。通过容器化技术，用户可以快速搭建自己的Palworld服务器，同时享受自动备份、更新、重启等便捷功能，无需复杂的手动配置。适用于希望搭建私人或小型社区服务器的玩家，支持Linux和Windows操作系统。

核心功能和特性

• 自动管理：支持服务器自动重启和自动更新，减少人工干预
• 玩家监控：实时跟踪玩家加入和离开事件，并记录相关信息
• 备份管理：提供手动和自动备份功能，支持备份创建、列表查看和清理
• RCON集成：内置RCON客户端，方便执行服务器命令
• 通知：通过Webhook将服务器事件（如启动、停止、玩家活动）发送到频道
• 跨平台支持：兼容Linux和Windows操作系统

使用场景和适用范围

• 个人玩家搭建私人Palworld服务器，与朋友一起游戏
• 小型游戏社区部署专用服务器，提供稳定的游戏环境
• 需要自动化管理服务器的场景，减少人工维护成本
• 希望通过***实时监控服务器状态和玩家活动的社区

服务器要求

请始终参考官方Palworld专用服务器要求获取最准确的信息。

开始前的准备工作

要使用此Docker镜像，您需要：

• 运行https://ubuntu.com/download/desktop%E3%80%81Windows 10或Windows 11的计算机
• 在计算机上安装https://docs.docker.com/get-docker/
• 同时安装https://docs.docker.com/compose/install/
• 基本的端口转发/NAT设置

如果您不熟悉这些概念，提供的链接将指导您完成安装和设置过程。如果仍有困难，欢迎在***中寻求帮助 😉

快速开始

1. 在您的游戏服务器目录中创建一个名为game的新文件夹（例如：/srv/palworld、/home/user/palworld）。
   • 游戏服务器文件（如配置和存档）将存储在此处。
   • 如果使用默认的docker-compose.yml文件，它将在docker-compose.yml文件所在目录创建一个名为palworld的文件夹。
2. 为Docker-Compose文件中提到的端口设置端口转发或NAT。
   • 游戏默认端口为8211，RCON默认端口为25575。
3. 在终端中输入docker pull docker.xuanyuan.run/thejcpalma/palworld-dedicated-server:latest获取最新版本的镜像。
4. 下载/复制https://github.com/thejcpalma/palworld-dedicated-server-docker/blob/main/docker-compose.yml%E5%92%8Chttps://github.com/thejcpalma/palworld-dedicated-server-docker/blob/main/default.env%E6%96%87%E4%BB%B6%E3%80%82
5. 根据需要调整docker-compose.yml和default.env文件。
   • 有关详细信息，请查看环境变量部分。
   • 如果需要自动更新和自动重启功能，但不希望暴露RCON端口，只需删除docker-compose.yml文件中的端口配置。
6. 在终端中输入docker-compose up -d && docker-compose logs -f启动容器。
   • 关注日志。如果没有错误，可以按ctrl+c关闭日志查看。
7. 完成！现在您可以开始游戏了！🎮😉

[!TIP] 如需详细指南，请查看我们的https://github.com/thejcpalma/palworld-dedicated-server-docker/blob/main//docs/INSTALL.md%E3%80%82

环境变量

详细的环境变量列表请查看https://github.com/thejcpalma/palworld-dedicated-server-docker/blob/main//docs/ENV_VARS.md%E6%96%87%E4%BB%B6%E3%80%82%E8%AF%A5%E6%96%87%E4%BB%B6%E5%8C%85%E5%90%AB%E5%8F%AF%E7%94%A8%E4%BA%8E%E8%87%AA%E5%AE%9A%E4%B9%89Palworld%E4%B8%93%E7%94%A8%E6%9C%8D%E5%8A%A1%E5%99%A8%E7%9A%84%E6%89%80%E6%9C%89%E7%8E%AF%E5%A2%83%E5%8F%98%E9%87%8F%E3%80%82

Docker-Compose配置

下载/复制https://github.com/thejcpalma/palworld-dedicated-server-docker/blob/main/docker-compose.yml%E5%92%8Chttps://github.com/thejcpalma/palworld-dedicated-server-docker/blob/main/default.env%E6%96%87%E4%BB%B6%E3%80%82

以下是基本的docker-compose.yml示例：

yaml
version: '3.8'

services:
  palworld:
    image: docker.xuanyuan.run/thejcpalma/palworld-dedicated-server:latest
    container_name: palworld-dedicated-server
    restart: unless-stopped
    stop_grace_period: 30s
    ports:
      - "8211:8211/udp"   # 游戏端口
      - "25575:25575/tcp" # RCON端口
    environment:
      - PUID=1000
      - PGID=1000
      - PORT=8211
      - RCON_PORT=25575
      - RCON_PASSWORD="your-rcon-password"
      - SERVER_NAME="Palworld Server"
      - SERVER_DESCRIPTION="My Palworld Server"
      - ADMIN_PASSWORD="your-admin-password"
      - AUTO_RESTART_ENABLED=true
      - AUTO_UPDATE_ENABLED=true
      - BACKUP_ENABLED=true
    volumes:
      - ./palworld:/palworld
    stdin_open: true
    tty: true

特殊功能

[!WARNING] 这些功能需要启用RCON

有关这些功能的变量详细列表，请查看https://github.com/thejcpalma/palworld-dedicated-server-docker/blob/main//docs/ENV_VARS.md#special-features%E3%80%82

【自动】重启和【自动】更新

您可以通过将AUTO_RESTART_ENABLED和AUTO_UPDATE_ENABLED环境变量设置为true来使用【自动】重启和【自动】更新功能。

这些功能还需要在docker-compose.yml文件中设置以下选项：

• stop_grace_period设置为30秒或更长时间（取决于服务器性能），以允许服务器保存并正常关闭。
• restart_policy设置为unless-stopped，以允许服务器在容器内停止后重启。

[!IMPORTANT] 手动重启或更新服务器不会显示在docker日志中。 如果未指定，将使用默认警告时间（重启 - AUTO_RESTART_WARN_MINUTES；更新 - AUTO_UPDATE_WARN_MINUTES）

您也可以手动重启或更新服务器。

使用方法：docker exec palworld-dedicated-server restart [warn_time] 或 docker exec palworld-dedicated-server update [warn_time]

shell
docker exec palworld-dedicated-server restart 1
>> 在线玩家: 0
> 没有玩家在线。立即重启服务器...
> RCON: 广播: 服务器即将重启！
> RCON: 广播: 00:06:15-5秒后保存
> RCON: 广播: 正在保存世界...
> RCON: 保存完成
> RCON: 广播: 保存完成
> RCON: 广播: 创建备份
> RCON: 广播: 备份完成
>>> 备份 'saved-20240213_000615.tar.gz' 创建成功。
> RCON: 广播: 服务器即将关闭！
> RCON: 服务器将在1秒后关闭。请准备退出游戏。

shell
docker exec palworld-dedicated-server update   
> 服务器已是最新版本！

重启和更新功能在关闭服务器前始终会执行备份。

玩家监控

您可以通过将PLAYER_MONITORING_ENABLED环境变量设置为true来启用玩家监控。

此功能还需要将PLAYER_MONITORING_INTERVAL环境变量设置为所需的秒数间隔。

监控的事件：

• 玩家加入
• 玩家离开

玩家事件会记录在容器日志中，如果启用了webhook，还会发送到webhook。

日志格式为> 玩家 [加入/离开]: 玩家名称 | UID: 玩家UID | Steam ID: 玩家Steam ID。

如果玩家Steam ID无效（当玩家名称中包含特殊字符时，RCON的ShowPlayers命令可能返回16位数字而非17位），它仍会被记录，但会缺少最后一位数字。 发生这种情况时，服务器会在日志中发出警告消息，并列出与加入/离开的玩家相关的所有可能的Steam个人资料。 它通过测试最后一位数字从0到9的所有10种组合来实现（例如："玩家Steam ID" + "3"）。

日志示例：

shell
> 玩家加入: 玩家名称 | UID: 玩家UID | Steam ID: XXXXXXXXXXXXXXXX
>> 无效的Steam ID - 应该有17位数字，但只有16位！
>> 可能的Steam ID:
> 个人资料名称: profile1 | 个人资料链接: https://steamcommunity.com/profiles/XXXXXXXXXXXXXXXX1
> 个人资料名称: ___Profile2___ | 个人资料链接: https://steamcommunity.com/profiles/XXXXXXXXXXXXXXXX3
> 个人资料名称: pROFILe_$%4 | 个人资料链接: https://steamcommunity.com/profiles/XXXXXXXXXXXXXXXX7

[!NOTE] 您可以在webhook消息中使用PLAYER_NAME、PLAYER_UID和PLAYER_STEAM_UID。 当Steam ID无效时，webhook消息将始终包含与玩家相关的可能的Steam个人资料，并将PLAYER_STEAM_UID更改为###INVALID_STEAM_UID###。 有关此集成的更多信息，请https://github.com/thejcpalma/palworld-dedicated-server-docker/blob/main//docs/ENV_VARS.md#--player-join-message%E3%80%82

备份管理器

[!WARNING] 如果禁用RCON，备份管理器将不会通过RCON在创建备份前进行保存。 这意味着备份将基于服务器的最后一次自动保存创建。 这可能导致数据丢失和/或存档损坏。

建议： 使用备份管理器前请确保启用RCON。

使用方法：docker exec palworld-dedicated-server backup [命令] [参数]

示例：

shell
$ docker exec palworld-dedicated-server backup
> 备份 'saved-20240203_032855.tar.gz' 创建成功。

shell
$ docker exec palworld-dedicated-server backup list
> 列出2个备份文件！
2024-02-03 03:28:55 | saved-20240203_032855.tar.gz
2024-02-03 03:28:00 | saved-20240203_032800.tar.gz

shell
$ docker exec palworld-dedicated-server backup clean 3
> 已清理1个备份，保留2个备份。

shell
$ docker exec palworld-dedicated-server backup list 1
> 列出1个备份文件。
2024-02-03 03:30:00 | saved-20240203_033000.tar.gz

运行RCON命令

[!NOTE] 请在官方来源上研究RCON命令：[***]

使用方法：docker exec palworld-dedicated-server rconcli [命令] 示例：

shell
$ docker exec palworld-dedicated-server rconcli ShowPlayers
> RCON: name,playeruid,steamid
thejcpalma,1234,5789

*** Webhook集成

要启用*** webhook集成，需要在default.env中设置以下环境变量：

shell
WEBHOOK_ENABLED=true
WEBHOOK_URL="https://your.webhook.url"

启用后，服务器将以***兼容的方式向您的webhook URL发送消息。

有关这些变量的更多详细信息，请[查看此处](https://github.com/thejcpalma/palworld-dedicated-server-docker/blob/main//docs/