From 28945ba772f196251adf9bdfae2d68ea867d91d2 Mon Sep 17 00:00:00 2001 From: celaraze <31471452+celaraze@users.noreply.github.com> Date: Mon, 29 Jan 2024 09:54:01 +0800 Subject: [PATCH] Update README.md for zh_CN --- docs/zh-CN/README.md | 110 ++++++++++++++++++++++--------------------- 1 file changed, 56 insertions(+), 54 deletions(-) diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 814dd2e..3ec61d6 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -17,14 +17,14 @@ > 不知道从何开始？ [看看这里吧！](https://tice.tips/containerization/palworld-server-docker/) 这是一个 [Docker](https://docs.docker.com/engine/install/) 容器，可帮助您创建自己的 -[幻兽帕鲁](https://store.steampowered.com/app/1623730/Palworld/) 服务器 +[幻兽帕鲁](https://store.steampowered.com/app/1623730/Palworld/) 服务器。 -此容器经测试可正常在 (Ubuntu/Debian) 和 Windows 10 上运行 +此容器经测试可正常在 (Ubuntu/Debian) 和 Windows 10 上运行。 > [!IMPORTANT] -> 目前, Xbox Game Pass/Xbox 主机玩家无法加入服务器 +> 目前，Xbox Game Pass/Xbox 主机玩家无法加入服务器。 > -> 他们只能通过邀请码加入，并且最多允许4人游玩 +> 他们只能通过邀请码加入，并且最多允许4人游玩。 ## 服务器配置需求 @@ -36,11 +36,11 @@ ## 开始使用 -注意，您需要配置 [环境变量](#环境变量). +注意，您需要配置 [环境变量](#环境变量)。 ### Docker Compose -您可以直接使用 [docker-compose.yml](/docker-compose.yml) 来配置您的服务器 +您可以直接使用 [docker-compose.yml](/docker-compose.yml) 来配置您的服务器： ```yml services: @@ -70,7 +70,7 @@ services: ### Docker Run -将``修改为您自己的路径 +将``修改为您自己的路径。 ```bash docker run -d \ @@ -97,17 +97,18 @@ docker run -d \ ### Kubernetes -将此容器部署到 Kubernetes 的所有文件都位于[此文件夹中](k8s/). +将此容器部署到 Kubernetes 的所有文件都位于[此文件夹中](k8s/)。 -请按照 [此处](k8s/readme.md) 进行部署 +请按照 [此处](k8s/readme.md) 进行部署。 #### 使用 helm 部署 -请按照 [此处](./chart/README.md) 进行部署 +请按照 [此处](./chart/README.md) 进行部署。 ### 环境变量 -您可以使用以下值来修改服务器设置 +您可以使用以下值来修改服务器设置。 + 强烈建议您在启动服务器之前设置以下变量： * PLAYERS @@ -117,33 +118,33 @@ docker run -d \ | 变量 | 信息 | 默认值 | 允许值 | |------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------------------------------------------------------------| -| TZ | 备份服务器时所使用的时间戳 | UTC | 参见 [时区列表](https://zh.wikipedia.org/wiki/%E6%97%B6%E5%8C%BA%E5%88%97%E8%A1%A8) | -| PLAYERS* | 可同加入服务器的最大玩家数 | 16 | 1-32 | -| PORT* | 服务器将开放的 UDP 端口 | 8211 | 1024-65535 | -| PUID* | 服务器运行时的用户的 UID | 1000 | !0 | -| PGID* | 服务器运行时的组的 GID | 1000 | !0 | -| MULTITHREADING** | 提高多线程 CPU 环境下的性能。它最多对 4 个线程有效，分配超过这个数量的线程没有太大意义 | false | true/false | -| COMMUNITY | 服务器是否显示在社区服务器页中（建议设置SERVER_PASSWORD） | false | true/false | -| PUBLIC_IP | 您可以手动指定服务器 IP 地址。若未指定，将自动检测 | | x.x.x.x | -| PUBLIC_PORT | 您可以手动指定服务器端口。若未指定，将自动检测 | | 1024-65535 | -| SERVER_NAME | 服务器名称 | | "string" | -| SERVER_PASSWORD | 为服务器设置密码 | | "string" | -| ADMIN_PASSWORD | 为服务器设置管理员密码 | | "string" | -| UPDATE_ON_BOOT** | 在启动 Docker 容器时更新/安装服务器（需要在第一次运行时启用） | true | true/false | -| RCON_ENABLED*** | 为服务器启用 RCON | true | true/false | -| RCON_PORT | RCON 连接端口 | 25575 | 1024-65535 | -| QUERY_PORT | 用于与 Steam 服务器通信的查询端口 | 27015 | 1024-65535 | +| TZ | 备份服务器时所使用的时间戳。 | UTC | 参见 [时区列表](https://zh.wikipedia.org/wiki/%E6%97%B6%E5%8C%BA%E5%88%97%E8%A1%A8) | +| PLAYERS* | 可同加入服务器的最大玩家数。 | 16 | 1-32 | +| PORT* | 服务器将开放的 UDP 端口。 | 8211 | 1024-65535 | +| PUID* | 服务器运行时的用户的 UID。 | 1000 | !0 | +| PGID* | 服务器运行时的组的 GID。 | 1000 | !0 | +| MULTITHREADING** | 提高多线程 CPU 环境下的性能。它最多对 4 个线程有效，分配超过这个数量的线程没有太大意义。 | false | true/false | +| COMMUNITY | 服务器是否显示在社区服务器页中（建议设置SERVER_PASSWORD）。 | false | true/false | +| PUBLIC_IP | 您可以手动指定服务器 IP 地址。若未指定，将自动检测。 | | x.x.x.x | +| PUBLIC_PORT | 您可以手动指定服务器端口。若未指定，将自动检测。 | | 1024-65535 | +| SERVER_NAME | 服务器名称。 | | "string" | +| SERVER_PASSWORD | 为服务器设置密码。 | | "string" | +| ADMIN_PASSWORD | 为服务器设置管理员密码。 | | "string" | +| UPDATE_ON_BOOT** | 在启动 Docker 容器时更新/安装服务器（需要在第一次运行时启用）。 | true | true/false | +| RCON_ENABLED*** | 为服务器启用 RCON。 | true | true/false | +| RCON_PORT | RCON 连接端口。 | 25575 | 1024-65535 | +| QUERY_PORT | 用于与 Steam 服务器通信的查询端口。 | 27015 | 1024-65535 | -*强烈建议设置 +* 强烈建议设置。 -** 启用该选项时，请确保您知道自己在做什么 +** 启用该选项时，请确保您知道自己在做什么。 -*** 是使用docker命令保存并关闭服务器的必要条件 +*** 是使用docker命令保存并关闭服务器的必要条件。 > [!IMPORTANT] -> 环境变量中使用的布尔值区分大小写，因为它们是在 shell 脚本中使用的 +> 环境变量中使用的布尔值区分大小写，因为它们是在 shell 脚本中使用的。 > -> 必须准确使用 `true` 或 `false` 设置它们，选项才能生效 +> 必须准确使用 `true` 或 `false` 设置它们，选项才能生效。 ### Game Ports @@ -155,59 +156,60 @@ docker run -d \ ## 使用 RCON -RCON 已在此项目中默认开启 -使用 RCON CLI 非常简单: +RCON 已在此项目中默认开启。 + +使用 RCON CLI 非常简单： ```bash docker exec -it palworld-server rcon-cli ``` -这将打开一个 CLI，使用 RCON 使用服务器命令 +这将打开一个 CLI，使用 RCON 使用服务器命令。 ### 命令列表 | 命令 | 信息 | |----------------------------------|-----------------------------------------------------| | Shutdown {秒} {信息} | 服务器将在{秒}后关闭 | -| DoExit | 强制关闭服务器 | -| Broadcast | 向服务器中所有玩家发送消息 | -| KickPlayer {SteamID} | 从服务器中踢出玩家 | -| BanPlayer {SteamID} | 从服务器中封禁玩家 | -| TeleportToPlayer {SteamID} | 传送到目标玩家 | -| TeleportToMe {SteamID} | 将目标玩家传送到身边 | -| ShowPlayers | 显示所有已连接玩家信息 | -| Info | 显示服务器信息 | -| Save | 保存游戏 | +| DoExit | 强制关闭服务器。 | +| Broadcast | 向服务器中所有玩家发送消息。 | +| KickPlayer {SteamID} | 从服务器中踢出玩家。 | +| BanPlayer {SteamID} | 从服务器中封禁玩家。 | +| TeleportToPlayer {SteamID} | 传送到目标玩家。 | +| TeleportToMe {SteamID} | 将目标玩家传送到身边。 | +| ShowPlayers | 显示所有已连接玩家信息。 | +| Info | 显示服务器信息。 | +| Save | 保存游戏。 | -请查看 [官方文档](https://tech.palworldgame.com/server-commands) 以获取所有命令 +请查看 [官方文档](https://tech.palworldgame.com/server-commands) 以获取所有命令。 ## 创建备份 -To create a backup of the game's save at the current point in time, use the command: +想要在游戏保存的时间点创建一个备份，使用以下命令： ```bash docker exec palworld-server backup ``` -执行后将在 `/palworld/backups/` 文件夹中生成备份 +执行后将在 `/palworld/backups/` 文件夹中生成备份。 -若启用了 RCON，服务器将在备份前进行保存 +若启用了 RCON，服务器将在备份前进行保存。 ## 修改服务器设置 -服务器启动时， `PalWorldSettings.ini` 文件将在 `/Pal/Saved/Config/LinuxServer` 文件夹中生成 +服务器启动时，`PalWorldSettings.ini` 文件将在 `/Pal/Saved/Config/LinuxServer` 文件夹中生成。 -所有更改将在服务器下次启动时生效 +所有更改将在服务器下次启动时生效。 -请注意，环境变量将始终覆盖对 `PalWorldSettings.ini` 所做的更改 +请注意，环境变量将始终覆盖对 `PalWorldSettings.ini` 所做的更改。 服务器配置文件参数相关说明，请在 -[shockbyte](https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html) 中查看 +[shockbyte](https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html) 中查看。 ## 报告问题/功能请求 -可通过 [此链接](https://github.com/thijsvanloef/palworld-server-docker/issues/new/choose) 报告问题/功能请求 +可通过 [此链接](https://github.com/thijsvanloef/palworld-server-docker/issues/new/choose) 报告问题/功能请求。 ### 已知问题 -已知问题已在 [Wiki](https://github.com/thijsvanloef/palworld-server-docker/wiki/Known-Issues) 中列出 +已知问题已在 [Wiki](https://github.com/thijsvanloef/palworld-server-docker/wiki/Known-Issues) 中列出。