Skip to content

Commit

Permalink
docs: chore for sync_interval & remove warn & dark mode
Browse files Browse the repository at this point in the history
  • Loading branch information
zaigie committed Feb 3, 2024
1 parent 6f7ef67 commit a95662d
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 24 deletions.
25 changes: 13 additions & 12 deletions README.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
![PC](./docs/img/pst-en-1.png)

> The current mobile adaptation is good, you can view [Function Screenshot](#function-screenshot)
>
> Of course, the dark mode is also arranged no problem ~
Features and roadmap based on parsing of `Level.sav` save files:

Expand All @@ -41,14 +43,13 @@ Due to limited maintenance and development staff, we welcome front-end, back-end

## Download

> [!CAUTION]
> The task of parsing `Level.sav` requires **significant system memory (often 4GB-6GB) in a short period (about 1-3min)** , this portion of memory is released after the parsing task is completed. Ensure your server has enough memory!
> The task of parsing `Level.sav` requires 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.
>
> If the conditions are not met and still needed, the `pst-agent` is deployed on the game server, and the `pst` is deployed on a PC or other server with enough memory to perform the parsing task.
>
> ==> [pst-agent deployment tutorial](./README.agent.en.md)
>
> And synchronization [Sync archive from K8s-pod](#synchronizing-archives-from-k8s-pod) can be replicated directly within the k8s cluster via the kubectl api.
[pst-agent deployment tutorial](./README.agent.en.md)

And synchronization [Sync archive from K8s-pod](#synchronizing-archives-from-k8s-pod) can be replicated directly within the k8s cluster via the kubectl api.

Download the latest executable files at:

Expand Down Expand Up @@ -148,7 +149,7 @@ mkdir -p pst && tar -xzf pst_v0.5.0_linux_x86_64.tar.gz -C pst
save: # Save file parsing configuration
path: "/path/to/you/Level.sav" # Save file path
decode_path: "/path/to/your/sav_cli" # Save file parsing tool path, usually in the same directory as pst
sync_interval: 600 # Interval for syncing data from save file, in seconds, recommended >= 600
sync_interval: 120 # Interval for syncing data from save file, in seconds, recommended >= 120
```
##### Run
Expand Down Expand Up @@ -188,7 +189,7 @@ Access at http://{Server IP}:8080 after opening firewall and security group in c
> [!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, the default is 600s (10min).
> If your server configuration is sufficient and performance is good, you can try to make `save.sync_interval` shorter.
#### Windows

Expand Down Expand Up @@ -226,7 +227,7 @@ rcon: # RCON configuration
save: # Save file parsing configuration
path: "C:\\path\\to\\you\\Level.sav" # Save file path
decode_path: "C:\\path\\to\\your\\sav_cli.exe" # Save file parsing tool path, usually in the same directory as pst
sync_interval: 600 # Interval for syncing data from save file, in seconds, recommended >= 600
sync_interval: 120 # Interval for syncing data from save file, in seconds, recommended >= 120
```
##### Running
Expand Down Expand Up @@ -261,7 +262,7 @@ Access at http://{Server IP}:8080 after opening firewall and security group in c
> [!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, the default is 600s (10min).
> If your server configuration is sufficient and performance is good, you can try to make `save.sync_interval` shorter.

### Docker Deployment

Expand All @@ -277,7 +278,7 @@ docker run -d --name pst \
-e RCON__ADDRESS="172.17.0.1:25575" \
-e RCON__PASSWORD="your password" \
-e SAVE__PATH="/game/Level.sav" \
-e SAVE__SYNC_INTERVAL=600 \
-e SAVE__SYNC_INTERVAL=120 \
jokerwho/palworld-server-tool:latest
```

Expand Down Expand Up @@ -350,7 +351,7 @@ docker run -d --name pst \
-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=600 \
-e SAVE__SYNC_INTERVAL=120 \
jokerwho/palworld-server-tool:latest
```

Expand Down
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
![PC](./docs/img/pst-zh-1.png)

> 目前移动端适配良好,可查看下面 [功能截图](#功能截图)
>
> 当然深色模式也安排得妥妥的~
基于 `Level.sav` 存档文件解析实现的功能及路线图:

Expand All @@ -41,14 +43,13 @@

## 下载

> [!CAUTION]
> 解析 `Level.sav` 存档的任务需要在**短时间(1-3 分钟)耗费较大的系统内存**(常常是 4GB~6GB),这部分内存会在执行完解析任务后释放,因此你至少需要确保你的服务器有充足的内存!
> 解析 `Level.sav` 存档的任务需要在短时间(<20s)耗费一定的系统内存(1GB~3GB),这部分内存会在执行完解析任务后释放,因此你至少需要确保你的服务器有充足的内存。
>
> 若不满足条件仍需使用,提供了 `pst-agent` 部署在游戏服务器,而将 `pst` 部署在 PC 或者其它有足够内存执行解析任务的服务器。
>
> ==> [pst-agent 部署教程](./README.agent.md)
>
> 以及在 k8s 集群内可以直接通过 kubectl api 复制同步 [从 k8s-pod 同步存档](#从-k8s-pod-同步存档)
[pst-agent 部署教程](./README.agent.md)

k8s 集群内可以直接通过 kubectl api 复制同步 [从 k8s-pod 同步存档](#从-k8s-pod-同步存档)

请在以下地址下载最新版可执行文件

Expand Down Expand Up @@ -149,7 +150,7 @@ mkdir -p pst && tar -xzf pst_v0.5.0_linux_x86_64.tar.gz -C pst
save: # 存档文件解析相关配置
path: "/path/to/you/Level.sav" # 存档文件路径
decode_path: "/path/to/your/sav_cli" # 存档解析工具路径,一般和 pst 在同一目录
sync_interval: 600 # 定时从存档获取数据的间隔,单位秒,推荐 >= 600
sync_interval: 120 # 定时从存档获取数据的间隔,单位秒,推荐 >= 120
```
##### 运行
Expand Down Expand Up @@ -189,7 +190,7 @@ kill $(ps aux | grep 'pst' | awk '{print $2}') | head -n 1
> [!WARNING]
> 初次打开会显示空白没有内容,请**等待第一次 sav 存档同步完成**再访问
>
> 如果你的服务器配置足够且性能良好,你可以试着将 `save.sync_interval` 改短一点,默认 600s(10min)
> 如果你的服务器配置足够且性能良好,你可以试着将 `save.sync_interval` 改短一点
#### Windows

Expand Down Expand Up @@ -227,7 +228,7 @@ rcon: # RCON 相关配置
save: # 存档文件解析相关配置
path: "C:\\path\\to\\you\\Level.sav" # 存档文件路径
decode_path: "C:\\path\\to\\your\\sav_cli.exe" # 存档解析工具路径,一般和 pst 在同一目录
sync_interval: 600 # 定时从存档获取数据的间隔,单位秒,推荐 >= 600
sync_interval: 120 # 定时从存档获取数据的间隔,单位秒,推荐 >= 120
```
##### 运行
Expand Down Expand Up @@ -262,7 +263,7 @@ save: # 存档文件解析相关配置
> [!WARNING]
> 初次打开会显示空白没有内容,请**等待第一次 sav 存档同步完成**再访问
>
> 如果你的服务器配置足够且性能良好,你可以试着将 `save.sync_interval` 改短一点,默认 600s(10min)
> 如果你的服务器配置足够且性能良好,你可以试着将 `save.sync_interval` 改短一点

### Docker 部署

Expand All @@ -278,7 +279,7 @@ docker run -d --name pst \
-e RCON__ADDRESS="172.17.0.1:25575" \
-e RCON__PASSWORD="your password" \
-e SAVE__PATH="/game/Level.sav" \
-e SAVE__SYNC_INTERVAL=600 \
-e SAVE__SYNC_INTERVAL=120 \
jokerwho/palworld-server-tool:latest
```

Expand Down Expand Up @@ -351,7 +352,7 @@ docker run -d --name pst \
-e RCON__ADDRESS="游戏服务器IP:25575" \
-e RCON__PASSWORD="your password" \
-e SAVE__PATH="http://游戏服务器IP:Agent端口/sync" \
-e SAVE__SYNC_INTERVAL=600 \
-e SAVE__SYNC_INTERVAL=120 \
jokerwho/palworld-server-tool:latest
```

Expand Down

0 comments on commit a95662d

Please sign in to comment.