Skip to content

Commit

Permalink
update docs and version
Browse files Browse the repository at this point in the history
  • Loading branch information
yechentide committed Mar 1, 2024
1 parent e97f79d commit 81f62db
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,15 @@ To run the scripts in this repository, use `lua5.1` or `luajit`.

- `unzip` command is required.
- The default value for `output_dir_path` is `./output/worldgen`.
- `${dst_version}` must be a number. For example `593204`.
- The version number is stored in `${path_to_dst_server_dir}/version.txt`.
- [Output JSON format](./docs/json-templates/worldgen-vanilla.jsonc)

```bash
lua extract-worldgen-vanilla.lua ${path_to_dst_server_dir}
lua extract-worldgen-vanilla.lua ${path_to_dst_server_dir} ${output_dir_path}
lua extract-worldgen-vanilla.lua ${dst_version} ${path_to_unzipped_scripts_dir}
lua extract-worldgen-vanilla.lua ${dst_version} ${path_to_unzipped_scripts_dir} ${output_dir_path}

# if the path of scripts.zip is /root/server/data/databundles/scripts.zip
lua extract-worldgen-vanilla.lua /root/server
Expand Down
4 changes: 4 additions & 0 deletions docs/README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,15 @@

- `unzip`コマンドが必要です。
- `output_dir_path`のデフォルト値は`./output/worldgen`です。
- `${dst_version}`は数値である必要があります。たとえば、`593204`
- バージョン番号は`${path_to_dst_server_dir}/version.txt`に保存されています。
- [出力JSONのフォーマット](./json-templates/worldgen-vanilla.jsonc)

```bash
lua extract-worldgen-vanilla.lua ${path_to_dst_server_dir}
lua extract-worldgen-vanilla.lua ${path_to_dst_server_dir} ${output_dir_path}
lua extract-worldgen-vanilla.lua ${dst_version} ${path_to_unzipped_scripts_dir}
lua extract-worldgen-vanilla.lua ${dst_version} ${path_to_unzipped_scripts_dir} ${output_dir_path}

# scripts.zip のパスが /root/server/data/databundles/scripts.zip の場合
lua extract-worldgen-vanilla.lua /root/server
Expand Down
4 changes: 4 additions & 0 deletions docs/README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,15 @@

- 需要用到`unzip`命令。
- `output_dir_path`的默认值为`./output/worldgen`
- `${dst_version}`必须是数字。例如`593204`
- 版本号存储在`${path_to_dst_server_dir}/version.txt`中。
- [输出的JSON结构](./json-templates/worldgen-vanilla.jsonc)

```bash
lua extract-worldgen-vanilla.lua ${path_to_dst_server_dir}
lua extract-worldgen-vanilla.lua ${path_to_dst_server_dir} ${output_dir_path}
lua extract-worldgen-vanilla.lua ${dst_version} ${path_to_unzipped_scripts_dir}
lua extract-worldgen-vanilla.lua ${dst_version} ${path_to_unzipped_scripts_dir} ${output_dir_path}

# scripts.zip 的路径为 /root/server/data/databundles/scripts.zip 的话
lua extract-worldgen-vanilla.lua /root/server
Expand Down
2 changes: 1 addition & 1 deletion version.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v1.1.0
v1.1.1

0 comments on commit 81f62db

Please sign in to comment.