Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add: ZH-CN translations for locking game version #426

Merged
merged 2 commits into from
Feb 22, 2024
Merged

Add: ZH-CN translations for locking game version #426

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
691b822
Add: ZH-CN translations for locking game version
celaraze Feb 22, 2024
1cf26e8
Update README.md
celaraze Feb 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 71 additions & 49 deletions docs/zh-CN/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/palworld)](https://artifacthub.io/packages/search?repo=palworld)

> [!CAUTION]
> The docs have been moved to: [https://palworld-server-docker.loef.dev/zh/](https://palworld-server-docker.loef.dev/zh/)
> The docs have been moved
> to: [https://palworld-server-docker.loef.dev/zh/](https://palworld-server-docker.loef.dev/zh/)

加入我们的 [Discord](https://discord.gg/UxBxStPAAE)

Expand Down Expand Up @@ -154,42 +155,42 @@ docker run -d \
* PUID
* PGID

| 变量 | 信息 | 默认值 | 允许值 |
|------------------|--------------------------------------------------|-------|-------------------------------------------------------------------------------|
| 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 |
| BACKUP_CRON_EXPRESSION | 自动备份的频率。 | 0 0 \* \* \* | 需要一个Cron表达式 - 参见 [使用 Cron 执行自动备份](#使用-cron-执行自动备份)。 |
| BACKUP_ENABLED | 启用自动备份。 | true | true/false |
| DELETE_OLD_BACKUPS | 在一定天数后删除备份。 | false | true/false |
| OLD_BACKUP_DAYS | 保留备份的天数。 | 30 | 任何正整数 |
| AUTO_UPDATE_CRON_EXPRESSION | 自动更新的频率。 | 0 \* \* \* \* | 需要一个Cron表达式 - 参见 [使用 Cron 执行自动更新](#使用-cron-执行自动更新)。 |
| AUTO_UPDATE_ENABLED | 启用自动更新。 | false | true/false |
| AUTO_UPDATE_WARN_MINUTES | 在通知玩家后等待多长时间更新服务器。 | 30 | !0 |
| AUTO_REBOOT_CRON_EXPRESSION | 设置自动重启的频率。 | 0 0 \* \* \* | 需要一个Cron表达式 - 参见 [使用 Cron 执行自动重启](#使用-cron-执行自动重启)。 |
| AUTO_REBOOT_ENABLED | 启用自动重启 | false | true/false |
| AUTO_REBOOT_WARN_MINUTES | 在通知玩家后等待多长时间重启服务器。 | 5 | !0 |
| DISCORD_WEBHOOK_URL | Discord 服务器上创建 Webhook 后的 Discord Webhook URL | | `https://discord.com/api/webhooks/<webhook_id>` |
| DISCORD_CONNECT_TIMEOUT | Discord 命令初始连接超时 | 30 | !0 |
| DISCORD_MAX_TIMEOUT | Discord 超时时间 | 30 | !0 |
| DISCORD_PRE_UPDATE_BOOT_MESSAGE | 服务器开始更新时发送到 Discord 的消息 | Server is updating... | "string" |
| DISCORD_POST_UPDATE_BOOT_MESSAGE | 服务器完成更新时发送到 Discord 的消息 | Server update complete! | "string" |
| DISCORD_PRE_START_MESSAGE | 服务器启动时发送到 Discord 的消息 | Server is started! | "string" |
| DISCORD_PRE_SHUTDOWN_MESSAGE | 服务器关闭时发送到 Discord 的消息 | Server is shutting down... | "string" |
| DISCORD_POST_SHUTDOWN_MESSAGE | 服务器停止时发送到 Discord 的消息 | Server is stopped! | "string" |
| 变量 | 信息 | 默认值 | 允许值 |
|----------------------------------|--------------------------------------------------|----------------------------|-------------------------------------------------------------------------------|
| 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 |
| BACKUP_CRON_EXPRESSION | 自动备份的频率。 | 0 0 \* \* \* | 需要一个Cron表达式 - 参见 [使用 Cron 执行自动备份](#使用-cron-执行自动备份)。 |
| BACKUP_ENABLED | 启用自动备份。 | true | true/false |
| DELETE_OLD_BACKUPS | 在一定天数后删除备份。 | false | true/false |
| OLD_BACKUP_DAYS | 保留备份的天数。 | 30 | 任何正整数 |
| AUTO_UPDATE_CRON_EXPRESSION | 自动更新的频率。 | 0 \* \* \* \* | 需要一个Cron表达式 - 参见 [使用 Cron 执行自动更新](#使用-cron-执行自动更新)。 |
| AUTO_UPDATE_ENABLED | 启用自动更新。 | false | true/false |
| AUTO_UPDATE_WARN_MINUTES | 在通知玩家后等待多长时间更新服务器。 | 30 | !0 |
| AUTO_REBOOT_CRON_EXPRESSION | 设置自动重启的频率。 | 0 0 \* \* \* | 需要一个Cron表达式 - 参见 [使用 Cron 执行自动重启](#使用-cron-执行自动重启)。 |
| AUTO_REBOOT_ENABLED | 启用自动重启 | false | true/false |
| AUTO_REBOOT_WARN_MINUTES | 在通知玩家后等待多长时间重启服务器。 | 5 | !0 |
| DISCORD_WEBHOOK_URL | Discord 服务器上创建 Webhook 后的 Discord Webhook URL | | `https://discord.com/api/webhooks/<webhook_id>` |
| DISCORD_CONNECT_TIMEOUT | Discord 命令初始连接超时 | 30 | !0 |
| DISCORD_MAX_TIMEOUT | Discord 超时时间 | 30 | !0 |
| DISCORD_PRE_UPDATE_BOOT_MESSAGE | 服务器开始更新时发送到 Discord 的消息 | Server is updating... | "string" |
| DISCORD_POST_UPDATE_BOOT_MESSAGE | 服务器完成更新时发送到 Discord 的消息 | Server update complete! | "string" |
| DISCORD_PRE_START_MESSAGE | 服务器启动时发送到 Discord 的消息 | Server is started! | "string" |
| DISCORD_PRE_SHUTDOWN_MESSAGE | 服务器关闭时发送到 Discord 的消息 | Server is shutting down... | "string" |
| DISCORD_POST_SHUTDOWN_MESSAGE | 服务器停止时发送到 Discord 的消息 | Server is stopped! | "string" |

* 强烈建议设置。

Expand Down Expand Up @@ -251,7 +252,7 @@ docker exec palworld-server backup

若启用了 RCON，服务器将在备份前进行保存。

## 透过备份恢復数据
## 通过备份恢复数据

要从备份中恢复，请使用以下命令：

Expand All @@ -262,16 +263,17 @@ docker exec -it palworld-server restore
必须将 `RCON_ENABLED` 环境变量设置为 `true` 以使用此命令。

> [!IMPORTANT]
> 如果 Docker 重启策略不是设为 `always` 或 `unless-stopped`，那麽伺服器将会关闭，需要手动重新启动。
> 在 [开始使用](#开始使用) 中的示例 Docker run 命令和 Docker Compose 文件已經使用了所需的策略。
> 如果 Docker 重启策略不是设为 `always` 或 `unless-stopped`，那么服务器将会关闭，需要手动重新启动。
> 在 [开始使用](#开始使用) 中的示例 Docker run 命令和 Docker Compose 文件已经使用了所需的策略。

## 手动从备份中恢复数据

在 `/palworld/backups/` 中找到要恢复的备份并解压缩它。

删除位于 `/palworld/Pal/Saved/SaveGames/0/<old_hash_value>` 的旧保存数据文件夹。

将新解压缩的保存数据文件夹 `Saved/SaveGames/0/<new_hash_value>` 的内容复制到 `palworld/Pal/Saved/SaveGames/0/<new_hash_value>` 。
将新解压缩的保存数据文件夹 `Saved/SaveGames/0/<new_hash_value>`
的内容复制到 `palworld/Pal/Saved/SaveGames/0/<new_hash_value>` 。

将 `palworld/Pal/Saved/Config/LinuxServer/GameUserSettings.ini` 中的 `DedicatedServerName` 替换为新文件夹名称。

Expand Down Expand Up @@ -312,8 +314,8 @@ docker compose down && docker compose up -d
* UPDATE_ON_BOOT

> [!IMPORTANT]
> 如果 Docker 重启策略不是设为 `always` 或 `unless-stopped`，那麽伺服器将会关闭，需要手动重新启动。
> 在 [开始使用](#开始使用) 中的示例 Docker run 命令和 Docker Compose 文件已經使用了所需的策略。
> 如果 Docker 重启策略不是设为 `always` 或 `unless-stopped`，那么服务器将会关闭，需要手动重新启动。
> 在 [开始使用](#开始使用) 中的示例 Docker run 命令和 Docker Compose 文件已经使用了所需的策略。

设置 `AUTO_UPDATE_ENABLED` 以启用或禁用自动更新（默认为禁用）。

Expand All @@ -325,15 +327,15 @@ docker compose down && docker compose up -d
> 或者
> [Crontab Generat](https://crontab-generator.org).

設置 `AUTO_UPDATE_CRON_EXPRESSION` 以更改默認时程。
設置 `AUTO_UPDATE_CRON_EXPRESSION` 以更改默认时程。

## 使用 Cron 执行自动重启

为了能够使用该服务器的自动重启功能，需要启用 `RCON_ENABLED` 。

> [!IMPORTANT]
> 如果 Docker 重启策略不是设为 `always` 或 `unless-stopped`，那麽伺服器将会关闭，需要手动重新启动。
> 在 [开始使用](#开始使用) 中的示例 Docker run 命令和 Docker Compose 文件已經使用了所需的策略。
> 如果 Docker 重启策略不是设为 `always` 或 `unless-stopped`，那么服务器将会关闭，需要手动重新启动。
> 在 [开始使用](#开始使用) 中的示例 Docker run 命令和 Docker Compose 文件已经使用了所需的策略。

设置 `AUTO_REBOOT_ENABLED` 以启用或禁用自动备份（默认为禁用）。

Expand Down Expand Up @@ -424,11 +426,12 @@ docker compose down && docker compose up -d
服务器配置文件参数相关说明，请在
[shockbyte](https://shockbyte.com/billing/knowledgebase/1189/How-to-Configure-your-Palworld-server.html) 中查看。

## 使用 discord webhooks
## 使用 Discord Webhooks

1. 在 Discord 的服务器设置中为你的 Discord 服务器生成一个 Webhook URL。

2. 使用 Discord Webhook URL 的範例，將唯一的令牌設置為環境變數，附在 URL 的末尾，如下所示：`https://discord.com/api/webhooks/1234567890/abcde`
2. 使用 Discord Webhook URL 的范例，将唯一的令牌设置为环境变量，附在 URL
的末尾，如下所示：`https://discord.com/api/webhooks/1234567890/abcde`

使用 Docker run 命令发送 Discord 消息：

Expand All @@ -437,13 +440,32 @@ docker compose down && docker compose up -d
-e DISCORD_PRE_UPDATE_BOOT_MESSAGE="Server is updating..." \
```

使用 Docker Compose 命令發送 Discord 消息：
使用 Docker Compose 命令发送 Discord 消息：

```yaml
- DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/1234567890/abcde
- DISCORD_PRE_UPDATE_BOOT_MESSAGE=Server is updating...
```

## 锁定特定的游戏版本

> [!WARNING]
> 降级到更低的游戏版本是可能的，但目前不清楚它对现有存档会有什么影响。
>
>**请自行承担风险！**

如果 **TARGET_MANIFEST_ID** 环境变量被设置，服务器将锁定到特定的 manifest 版本。
manifest 对应于发布日期/更新版本。manifest 可以在 SteamCMD 或 [SteamDB](https://steamdb.info/depot/2394012/manifests/)
等网站上找到。

### 版本和 manifest 对照表

| 版本 | Manifest ID |
|-------|---------------------|
| 1.3.0 | 1354752814336157338 |
| 1.4.0 | 4190579964382773830 |
| 1.4.1 | 6370735655629434989 |

## 报告问题/功能请求

可通过 [此链接](https://github.com/thijsvanloef/palworld-server-docker/issues/new/choose) 报告问题/功能请求。
Expand Down