Skip to content

Commit 6529b95

Browse files
MakinoharaShokoMakinoharaShoko
committed
update terre docs
1 parent 6a1120a commit 6529b95

6 files changed

Lines changed: 147 additions & 0 deletions

File tree

‎src/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
- [我想要参与引擎开发或了解如何从源代码开发 WebGAL](developers)
88

9+
- [我想要了解如何定制开发或贡献 WebGAL Terre 编辑器](developers/terre)
10+
911
- [如何在编辑器中使用自己或他人开发的定制引擎](derivative)
1012

1113
- [我想要了解 WebGAL 引擎的技术实现](tech)

‎src/developers/terre.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,53 @@ yarn dev
5353

5454
构建完成后，您可以在 `release` 目录下找到构建产物。
5555

56+
## 更新 Terre 附带的 WebGAL 引擎模板
57+
58+
一般来说，我们会在 WebGAL 更新后将最新版本的引擎模板更新到 Terre 项目中。假如你想在 Terre 中使用你定制的 WebGAL 引擎，请遵循以下步骤：
59+
60+
1、Clone WebGAL 引擎项目（推荐在相邻目录 Clone，这样可以使用自动化脚本）
61+
62+
```
63+
git clone https://github.com/OpenWebGAL/WebGAL.git
64+
```
65+
66+
2、**（假设你在 Terre 项目的相邻目录 Clone WebGAL 项目，未这样做的开发者请忽略）** 在 WebGAL 引擎仓库运行自动化脚本构建 WebGAL 到 WebGAL Terre
67+
68+
```
69+
sh release-to-terre.sh
70+
```
71+
72+
:::warning
73+
**以下步骤适用于手动构建并更新 Terre 中的引擎模板的情况。使用自动化脚本的开发者请忽略！**
74+
:::
75+
76+
2、构建 WebGAL 项目（此步骤在 WebGAL 引擎仓库中执行）
77+
78+
```
79+
yarn
80+
yarn build
81+
```
82+
83+
3、删除 WebGAL Terre 里的引擎模板，并移动引擎项目的构建产物到 WebGAL Terre 的模板目录
84+
85+
**此处假设你在 Terre 项目的相邻目录 Clone WebGAL 项目，如果你有不同的目录结构，请根据实际情况修改。**
86+
87+
```
88+
# 进入 Terre 目录
89+
cd ../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template || exit
90+
# 删除其他文件
91+
rm -r assets
92+
rm -r index.html
93+
rm -r webgal-serviceworker.js
94+
95+
# 进入 WebGAL 构建目录
96+
cd ../../../../../../WebGAL/packages/webgal || exit
97+
# 复制
98+
cp -r dist/index.html ../../../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template
99+
cp -r dist/assets ../../../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template
100+
cp -r dist/webgal-serviceworker.js ../../../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template
101+
```
102+
56103
## 包介绍
57104

58105
| 包名 | 说明 |

‎src/en/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
- [I want to contribute to the engine development or learn how to develop WebGAL from source](developers)
88

9+
- [I want to learn how to customize, develop, or contribute to the WebGAL Terre editor](developers/terre)
10+
911
- [How to use custom engine developed by yourself or others in the editor](derivative)
1012

1113
- [I want to learn about the technical implementation of WebGAL engine](tech)

‎src/en/developers/terre.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,53 @@ You need to run the build script to generate a releasable version.
5353

5454
After the build is complete, you can find the build artifacts in the `release` directory.
5555

56+
## Update the WebGAL Engine Template Included in Terre
57+
58+
Generally, we will update the latest version of the engine template to the Terre project after the WebGAL update. If you want to use your customized WebGAL engine in Terre, please follow these steps:
59+
60+
1. Clone the WebGAL engine project (it is recommended to clone in the adjacent directory, so that you can use the automation script)
61+
62+
```
63+
git clone https://github.com/OpenWebGAL/WebGAL.git
64+
```
65+
66+
2. **(Assuming you cloned the WebGAL project in the directory adjacent to the Terre project, developers who did not do this please ignore)** Run the automation script in the WebGAL engine repository to build WebGAL to WebGAL Terre
67+
68+
```
69+
sh release-to-terre.sh
70+
```
71+
72+
:::warning
73+
**The following steps apply to manually building and updating the engine template in Terre. Developers using automated scripts please ignore!**
74+
:::
75+
76+
2. Build the WebGAL project (this step is executed in the WebGAL engine repository)
77+
78+
```
79+
yarn
80+
yarn build
81+
```
82+
83+
3. Delete the engine template in WebGAL Terre and move the build product of the engine project to the template directory of WebGAL Terre
84+
85+
**Here we assume that you cloned the WebGAL project in the directory adjacent to the Terre project. If you have a different directory structure, please modify it according to the actual situation.**
86+
87+
```
88+
# Enter the Terre directory
89+
cd ../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template || exit
90+
# Delete other files
91+
rm -r assets
92+
rm -r index.html
93+
rm -r webgal-serviceworker.js
94+
95+
# Enter the WebGAL build directory
96+
cd ../../../../../../WebGAL/packages/webgal || exit
97+
# Copy
98+
cp -r dist/index.html ../../../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template
99+
cp -r dist/assets ../../../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template
100+
cp -r dist/webgal-serviceworker.js ../../../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template
101+
```
102+
56103
## Package Introduction
57104

58105
| Package Name | Description |

‎src/ja/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
- [WebGAL の開発に参加したり、ソースコードから WebGAL を開発する方法を学びたい](developers)
88

9+
- [WebGAL Terre エディターのカスタマイズ開発や貢献について](developers/terre)
10+
911
- [エディタで自分や他の人が開発したカスタムエンジンを使用する方法](derivative)
1012

1113
- [WebGAL エンジンの技術的な実装について知りたい](tech)

‎src/ja/developers/terre.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,53 @@ yarn dev
5353

5454
ビルドが完了すると、`release` ディレクトリにビルド成果物が配置されます。
5555

56+
## Terre に同梱されている WebGAL エンジンテンプレートの更新
57+
58+
通常、WebGAL の更新後、最新バージョンのエンジンテンプレートを Terre プロジェクトに更新します。Terre でカスタマイズした WebGAL エンジンを使用する場合は、次の手順に従ってください。
59+
60+
1. WebGAL エンジンリポジトリをクローンします（隣接ディレクトリにクローンすることをお勧めします。これにより、自動化スクリプトを使用できます）
61+
62+
```
63+
git clone https://github.com/OpenWebGAL/WebGAL.git
64+
```
65+
66+
2. **（Terre プロジェクトの隣接ディレクトリに WebGAL プロジェクトをクローンした場合、そうでない開発者は無視してください）** WebGAL エンジンリポジトリで自動化スクリプトを実行して、WebGAL を WebGAL Terre にビルドします
67+
68+
```
69+
sh release-to-terre.sh
70+
```
71+
72+
:::warning
73+
**以下の手順は、手動でビルドして Terre のエンジンテンプレートを更新する場合に適用されます。自動化スクリプトを使用する開発者は無視してください！**
74+
:::
75+
76+
2. WebGAL プロジェクトをビルドします（この手順は WebGAL エンジンリポジトリで実行します）
77+
78+
```
79+
yarn
80+
yarn build
81+
```
82+
83+
3. WebGAL Terre のエンジンテンプレートを削除し、エンジンプロジェクトのビルド成果物を WebGAL Terre のテンプレートディレクトリに移動します
84+
85+
**ここでは、Terre プロジェクトの隣接ディレクトリに WebGAL プロジェクトをクローンしていると想定しています。異なるディレクトリ構造を使用している場合は、それに応じて変更してください。**
86+
87+
```
88+
# Terre ディレクトリに移動します
89+
cd ../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template || exit
90+
# 他のファイルを削除します
91+
rm -r assets
92+
rm -r index.html
93+
rm -r webgal-serviceworker.js
94+
95+
# WebGAL ビルドディレクトリに移動します
96+
cd ../../../../../../WebGAL/packages/webgal || exit
97+
# コピーします
98+
cp -r dist/index.html ../../../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template
99+
cp -r dist/assets ../../../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template
100+
cp -r dist/webgal-serviceworker.js ../../../WebGAL_Terre/packages/terre2/assets/templates/WebGAL_Template
101+
```
102+
56103
## パッケージ紹介
57104

58105
| パッケージ名 | 説明 |

0 commit comments

Comments
 (0)