Skip to content

Commit ee64fb8

Browse files
shohei-miyashitashohei-miyashita
authored
Merge pull request #30 from PLATEAU-Toolkits-Internal/feature/r4
READMEの細かい誤字脱字等を修正、リンクを差し替え
2 parents 1b6df9c + 457eb93 commit ee64fb8

File tree

1 file changed

+37
-58
lines changed

1 file changed

+37
-58
lines changed

‎README.md‎

Lines changed: 37 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,48 @@
1-
# PLATEAU SDK Toolkits for Unity
1+
# PLATEAU SDK-Toolkits for Unity
22

33
<img width="1080" alt="toolkits_key_visual" src="/Documentation~/Images/toolkits_key_visual.png">
44

5-
65
PLATEAU SDK-Toolkits for Unityは、PLATEAUの提供する「3D都市モデル」のデータを利用したUnity上でのアプリケーション開発を支援するツールキット群です。
7-
**PLATEAU SDK-Toolkits for Unityは[PLATEAU SDK for Unity](https://github.com/Project-PLATEAU/PLATEAU-SDK-for-Unity)を前提とするアドオンです。**
8-
9-
[ダウンロードリンクはこちら](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/releases/)
6+
**PLATEAU SDK-Toolkits for Unity は [PLATEAU SDK for Unity](https://github.com/Project-PLATEAU/PLATEAU-SDK-for-Unity) を前提とするアドオンです。**
107

8+
ダウンロードリンクは[こちら](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/releases/)
119

12-
## Toolkitsの構成要素
10+
## PLATEAU SDK-Toolkitsの構成要素
1311
PLATEAU SDK-Toolkits for Unityは以下の4つのコンポーネントから構成されます。
1412

1513
- [Rendering Toolkit](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/PlateauToolkit.Rendering)
1614
- [Sandbox Toolkit](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/PlateauToolkit.Sandbox)
17-
- [PLATEAU Utilities ※リンク要修正](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/)
15+
- [PLATEAU Utilities](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/PlateauToolkit.Utilities)
1816
- [Maps Toolkit](https://github.com/Project-PLATEAU/PLATEAU-SDK-Maps-Toolkit-for-Unity)（別リポジトリ）
1917
- [AR Extensions](https://github.com/Project-PLATEAU/PLATEAU-SDK-AR-Extensions-for-Unity)（別リポジトリ）
2018

21-
Toolkitを活用した下記の3種類のサンプルアプリプロジェクトを提供しています。<br>
19+
PLATEAU SDK-Toolkitsを活用した下記の4種類のサンプルアプリプロジェクトを提供しています。<br>
2220
下記リポジトリよりご利用ください。
2321

2422
- [Urban Scape](https://github.com/Project-PLATEAU/PLATEAU-Toolkits-Sample-UrbanScape)
2523
- [City Rescue Multiplay](https://github.com/Project-PLATEAU/PLATEAU-Toolkits-Sample-CityRescueMultiPlay)
2624
- [AR Treasure Map](https://github.com/Project-PLATEAU/PLATEAU-Toolkits-Sample-ARTreasureMap)
27-
- [AR City Miniature ※リンク要修正](https://github.com/Project-PLATEAU/PLATEAU-Toolkits-Sample-ARTreasureMap)
25+
- [AR City Miniature](https://github.com/Project-PLATEAU/PLATEAU-Toolkits-Sample-ARCityMiniature)
2826

2927
※サンプルシーンを題材とした開発チュートリアルを今後リリース予定です。
3028

3129
### 更新履歴
32-
33-
| 2024/01/30 | 4th Release <br> Rendering Toolkitにテクスチャ調整機能を追加、SDKのテクスチャ結合機能に対応　<br> PLATEAU Utilitiesを追加 <br> AR Extensionsにテンプレートを追加 <br> サンプルシーン: AR City Miniatureのリリース| Sandbox Toolkit v1.0.0 <br> Rendering Toolkit v1.0.0 <br> Maps Toolkit v1.0.0 <br> AR Extensions v1.0.0 <br> AR City Miniature v1.0.0 |
30+
| 更新日時 | リリース | 更新内容 |
3431
| :--- | :--- | :--- |
35-
| 2023/12/25 | 3rd Release <br> Sandbox Toolkitにおけるカメラインタラクション機能、その他調整　　<br>MapsToolkitを別パッケージ化 <br>Rendering Toolkitに頂点カラー機能を追加 <br>AR Extensionsにマーカー位置合わせ機能を追加 <br> サンプルシーン: Urban Scape, City Rescue Multiplay, AR Treasure Mapのリリース| Sandbox Toolkit v0.3.0（ベータ版） <br> Rendering Toolkit v0.3.0（ベータ版）<br> Maps Toolkit v0.3.0（ベータ版）<br> AR Extensions v0.3.0（ベータ版）<br> Urban Scape v1.0.0 <br> City Rescue Multiplay v1.0.0 <br> AR Treasure Map v1.0.0|
36-
| 2023/10/28 | 2nd Release <br> MapsToolkitのリリース <br> AR Extensionsのリリース <br> Rendering Toolkitにおける雲量調整、ポストエフェクトの追加 | Maps Toolkit v0.2.1（ベータ版）<br> AR Extensions v0.2.1（ベータ版） <br> Rendering Toolkit v0.2.1（ベータ版） |
37-
| 2023/09/15 | Windows Buildに関する不具合の修正 | Rendering Toolkit v0.1.1（ベータ版） <br> Sandbox Toolkit v0.1.1（ベータ版） |
38-
| 2023/07/23 | 1st Release | Rendering Toolkit v0.1.0（ベータ版） <br> Sandbox Toolkit v0.1.0（ベータ版） |
32+
| 2024/01/30 | **4th Release** <br> Rendering Toolkitにテクスチャ調整機能を追加、SDKのテクスチャ結合機能に対応　<br> PLATEAU Utilitiesを追加 <br> AR Extensionsにテンプレートを追加 <br> サンプルシーン: AR City Miniatureのリリース| Sandbox Toolkit v1.0.0 <br> Rendering Toolkit v1.0.0 <br> Maps Toolkit v1.0.0 <br> AR Extensions v1.0.0 <br> AR City Miniature v1.0.0 |
33+
| 2023/12/25 | **3rd Release** <br> Sandbox Toolkitにおけるカメラインタラクション機能、その他調整　　<br>MapsToolkitを別パッケージ化 <br>Rendering Toolkitに頂点カラー機能を追加 <br>AR Extensionsにマーカー位置合わせ機能を追加 <br> サンプルシーン: Urban Scape, City Rescue Multiplay, AR Treasure Mapのリリース| Sandbox Toolkit v0.3.0（ベータ版） <br> Rendering Toolkit v0.3.0（ベータ版）<br> Maps Toolkit v0.3.0（ベータ版）<br> AR Extensions v0.3.0（ベータ版）<br> Urban Scape v1.0.0 <br> City Rescue Multiplay v1.0.0 <br> AR Treasure Map v1.0.0|
34+
| 2023/10/28 | **2nd Release** <br> MapsToolkitのリリース <br> AR Extensionsのリリース <br> Rendering Toolkitにおける雲量調整、ポストエフェクトの追加 | Maps Toolkit v0.2.1（ベータ版）<br> AR Extensions v0.2.1（ベータ版） <br> Rendering Toolkit v0.2.1（ベータ版） |
35+
| 2023/09/15 | Windowsにおけるビルドの不具合修正 | Rendering Toolkit v0.1.1（ベータ版） <br> Sandbox Toolkit v0.1.1（ベータ版） |
36+
| 2023/07/23 | **1st Release** | Rendering Toolkit v0.1.0（ベータ版） <br> Sandbox Toolkit v0.1.0（ベータ版） |
3937

40-
41-
42-
## [Rendering Toolkit](https://github.com/PLATEAU-Toolkits-Internal/PLATEAU-SDK-Toolkits-for-Unity/blob/main/PlateauToolkit.Rendering/README.md)
38+
## [PLATEAU SDK-Rendering-Toolkit](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/PlateauToolkit.Rendering)
4339

4440
PLATEAUの3D都市モデルのグラフィックスを向上させる処理を行います。
4541

4642
環境設定、テクスチャの自動作成、LOD設定等の機能をGUI上で提供します。
4743

4844
https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/assets/137732437/85cb8331-bb26-470c-ad69-33c56ffe9143
4945

50-
5146
### リリース済の機能
5247
- 環境システムの設定
5348
- テクスチャ自動生成
@@ -59,103 +54,88 @@ https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/assets/1377324
5954

6055
使い方は[こちら](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/PlateauToolkit.Rendering)
6156

62-
63-
## [Sandbox Toolkit](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/PlateauToolkit.Sandbox)
57+
## [PLATEAU SDK-Sandbox-Toolkit](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/PlateauToolkit.Sandbox)
6458

6559
PLATEAUの3D都市モデルを用いたゲーム開発、映像製作、シミュレーション実行などを支援します。
6660
乗り物、人、プロップなどの配置及び操作、トラックの設定機能などをGUI上で提供します。
6761

68-
6962
https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/assets/137732437/ba417e2b-5621-4f75-95d0-27ce78a1ba5d
7063

71-
72-
7364
### リリース済の機能
74-
- Tracks(道路)の配置機能
65+
- トラック（道路）の配置機能
7566
- 人物エージェントの配置機能
7667
- 乗り物エージェントの配置機能
77-
- Props(施設器具等)の配置機能
68+
- プロップ（施設器具等）の配置機能
7869
- カメラインタラクション機能
7970

8071
使い方は[こちら](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/PlateauToolkit.Sandbox)
8172

8273

83-
## [PLATEAU Utilities ※リンク要修正](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/)
74+
## [PLATEAU SDK-Utilities](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/PlateauToolkit.Utilities)
8475

8576
3D都市モデルの選択、高さや位置の調整などの編集の際に役立つ機能を提供します。
8677

87-
8878
### リリース済の機能
8979
- メッシュレンダラーの選択機能
9080
- メッシュ頂点の平面化機能
9181
- 選択地物の整列機能
9282
- プレハブへのライトマップ設定機能
9383

94-
使い方は[こちら ※リンク要修正](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/)
95-
96-
84+
使い方は[こちら](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/tree/main/PlateauToolkit.Utilities)
9785

9886
## [PLATEAU SDK-Maps-Toolkit for Unity](https://github.com/Project-PLATEAU/PLATEAU-SDK-Maps-Toolkit-for-Unity)
99-
PLATEAUの3D都市モデルを利用したGIS開発向けツールキットです。Cesium SDK for Unityと連携してPLATEAUの3Dモデルをグローバルな地形モデルに配置することが可能です。また、BIMモデル（IFCファイル）やGISデータ（シェープファイル及びGeoJSON）を読み込んでCesium for Unity上に配置することが可能です。<br>
87+
PLATEAUの3D都市モデルを利用したGIS開発向けツールキットです。Cesium SDK for Unityと連携してPLATEAUの3Dモデルをグローバルな地形モデルに配置することが可能です。また、BIMモデル（IFCファイル）やGISデータ（シェープファイル及びGeoJSON）を読み込んでCesium for Unity上に配置することが可能です。
10088

10189
https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/assets/127069970/5ab8102d-046d-4423-9f7a-7a2029fca630
10290

103-
10491
### リリース済の機能
10592
- Cesium for Unityとの連携
10693
- BIMモデルとの連携（IFCファイルの読み込み）
10794
- GISデータとの連携
10895

109-
[こちらのリポジトリ](https://github.com/Project-PLATEAU/PLATEAU-SDK-Maps-Toolkit-for-Unity)からご利用ください。
110-
96+
[こちら](https://github.com/Project-PLATEAU/PLATEAU-SDK-Maps-Toolkit-for-Unity)のリポジトリからご利用ください。
11197

11298
## [PLATEAU SDK-AR-Extensions for Unity](https://github.com/Project-PLATEAU/PLATEAU-SDK-AR-extensions-for-Unity)
113-
PLATEAUの3D都市モデルを活用したARアプリ開発ツールです。AR空間に3Dモデルを配置し、位置のずれや地面の高さを調整できます。さらに、3Dオブジェクトを遮蔽するオクルージョン機能も備えています。Streamingにより配置された3D都市モデルを用いたARアプリ開発も可能です。
114-
AR ExtensionsはToolkitsを前提としたエクステンションとして構築されています。<br>
99+
PLATEAUの3D都市モデルを活用したARアプリ開発ツールです。AR空間に3Dモデルを配置し、位置のずれや地面の高さを調整できます。さらに、3Dオブジェクトを遮蔽するオクルージョン機能も備えています。ストリーミングにより配置された3D都市モデルを用いたARアプリ開発も可能です。
100+
AR ExtensionsはPLATEAU SDK-Toolkitsを前提としたエクステンションとして構築されています。<br>
115101

116102

117103
https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/assets/127069970/de97d7a9-d6cf-45b6-877a-51bf6259237b
118104

119105
### リリース済の機能
120106

121-
122107
- Geospatial APIを用いた3D都市モデルの位置合わせ機能
123108
- ARマーカーを用いた3D都市モデルの位置合わせ機能
124109
- ARオクルージョン機能
125110

126-
[こちらのリポジトリ](https://github.com/Project-PLATEAU/PLATEAU-SDK-AR-Extensions-for-Unity)からご利用ください。<br>
127-
128-
111+
[こちら](https://github.com/Project-PLATEAU/PLATEAU-SDK-AR-Extensions-for-Unity)のリポジトリからご利用ください。<br>
129112

130113
# セットアップ環境
131114

132-
133-
134-
135115
## 検証済環境
136116
### 推奨OS環境
137-
- Windows11
117+
- Windows 11
138118
- macOS Ventura 13.2
139119

140-
### Unity Version
120+
### Unity バージョン
141121
- Unity 2021.3.34
142122
- Unity 2021.3系であれば問題なく動作する見込みです。
143123

144-
### Rendering Pipeline
124+
### レンダリングパイプライン
145125
- URP
146126
- HDRP
147127

148128
**Built-in Rendering Pipelineでは動作しません。**
149129

150130
## PLATEAU SDKバージョン
151-
- [PLATEAU SDK for Unity v2.2.1-alpha](https://github.com/Project-PLATEAU/PLATEAU-SDK-for-Unity/releases)
131+
- [PLATEAU SDK for Unity v2.3.1](https://github.com/Project-PLATEAU/PLATEAU-SDK-for-Unity/releases/tag/v2.3.1)
132+
- これ以前のバージョンを使用する場合、SDK-Toolkitsの一部機能が利用できません。
152133

153134
## 導入手順
154135

155136
### 1. Unityでのプロジェクト作成
156137

157-
Unity Version 2021.3.34f1(LTS)により新たにUnityプロジェクトを作成してください。
158-
その際のテンプレートとして「3D(URP)」もしくは「3D(HDRP)」を選択してください。
138+
Unity バージョン 2021.3.34f1(LTS)で「3D(URP)」もしくは「3D(HDRP)」のテンプレートから Unity プロジェクトを作成してください。
159139

160140
<p align="center">
161141
<img width="493" alt="toolkits_setup_select_urp" src="/Documentation~/Images/toolkits_setup_select_urp.png">
@@ -165,29 +145,28 @@ Unity Version 2021.3.34f1(LTS)により新たにUnityプロジェクトを作成
165145
### 2. PLATEAU SDK for Unityのインストール
166146

167147
PLATEAU SDK-Toolkits for Unityを利用するにあたり、事前にPLATEAU SDKのインストールが必要となります。
168-
TarballかGithub URLからインストールをする必要があります。詳細はPLATEAU SDKのドキュメンテーションをご参照ください。
148+
TarballかGitHub URLからインストールをする必要があります。詳細はPLATEAU SDKのドキュメンテーションをご参照ください。
169149
[PLATEAU SDK for Unity利用マニュアル](https://project-plateau.github.io/PLATEAU-SDK-for-Unity/)
170150

171-
PLATEAU SDKを利用し、3D都市モデルをUnityシーン上へ配置してください。
151+
PLATEAU SDKを利用し、3D都市モデルをシーン上へ配置してください。
172152

173153
### 3. PLATEAU SDK-Toolkits for Unity のインストール
174154

175155
1. Unityエディタを開き、「Window」メニューから「Package Manager」を選択します。
176-
2. 「Package Manager」ウィンドウが開いたら、右上にある「＋」ボタンをクリックします。
156+
2. Package Manager ウィンドウが開いたら、右上にある「＋」ボタンを押下します。
177157
3. ドロップダウンメニューから「Add package from tarball...」を選択します。
178-
4. ファイル選択ダイアログが開いたら、インストールしたいパッケージの.tar.gzファイルを探し、選択します。
158+
4. ファイル選択ダイアログが開いたら、インストールしたいパッケージの .tar.gz ファイルを選択します。
179159
<p align="center">
180160
<img width="493" alt="toolkits_setup_install_tarball" src="/Documentation~/Images/toolkits_setup_install_tarball.png">
181161
</p>
182162

183-
新しいプロジェクトでPLATEAU SDK-Toolkits for Unityをインストールする際は、入力システムについての確認ダイアログが表示されます場合があります。その場合は「Yes」を選択してください。
184-
Unityエディタが再起動します。
163+
新しいプロジェクトでPLATEAU SDK-Toolkits for Unityをインストールする際は、入力システムについての確認ダイアログが表示されます場合があります。その場合は「Yes」を選択します（Unityエディターが再起動します）。
185164

186165
<p align="center">
187166
<img width="500" alt="toolkits_setup_warning" src="/Documentation~/Images/toolkits_setup_warning.png">
188167
</p>
189168

190-
[ダウンロードリンクはこちら](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/releases/)
169+
ダウンロードは[こちら](https://github.com/Project-PLATEAU/PLATEAU-SDK-Toolkits-for-Unity/releases/)
191170

192171
## ライセンス
193172
- 本リポジトリはMITライセンスで提供されています。
@@ -200,4 +179,4 @@ Unityエディタが再起動します。
200179
- パフォーマンスの観点から、3km²の範囲に収まる3D都市モデルをダウンロード・インポートすることを推奨しています。
201180
- インポートする範囲の広さや地物の種類（建物、道路、災害リスクなど）が量に比例して処理負荷が高くなる可能性があります。
202181
- 本リポジトリの内容は予告なく変更・削除される可能性があります。
203-
- 本リポジトリの利用により生じた損失及び損害等について、国土交通省はいかなる責任も負わないものとします。
182+
- 本リポジトリの利用により生じた損失及び損害等について、国土交通省はいかなる責任も負わないものとします。

0 commit comments

Comments
 (0)