docs(spec/package): about sutera world yaml format

package/01-sutera-world-spec.md

@@ -0,0 +1,28 @@
+# ワールド
+
+Sutera VR にアップロードするワールドの情報を記述します。
+ワールドは複数のシーンを保持することが出来る、Sutera の世界を構成する最上位の存在です。
+
+## 情報
+
+### medatdata.type
+
+ワールドのタイプを記述します。
+
+### medatdata.name
+
+ワールドの名前を記述します。この項目は任意の値を設定することが出来ます。
+
+### medatdata.version
+
+ワールドのバージョンを記述します。
+
+## スペック
+
+### specs.default_scene
+
+デフォルトのシーンを設定します。
+
+### specs.scenes
+
+ワールド内に存在するシーンを列挙します。

package/02-sutera-scene-spec.md

@@ -0,0 +1,60 @@
+# シーン
+
+Sutera VR にアップロードするシーンの情報を記述します。
+現在シーンは静的なオブジェクトに限定されています。
+
+## 情報
+
+### medatdata.id
+
+シーンの ID を記述します。
+
+### medatdata.type
+
+シーンのタイプを記述します。
+
+### medatdata.name
+
+シーンの名前を記述します。この項目は任意の値を設定することが出来ます。
+
+### medatdata.version
+
+シーンのバージョンを記述します。
+
+## スペック
+
+### specs.spawn_point
+
+ユーザーがシーンに入場した際のスポーンポイントを記述します。
+
+### specs.border
+
+シーンの境界を記述します。ここで設定された値を越えた際、ユーザーはリスポーンします。
+
+### specs.objects
+
+シーンを構成するオブジェクトの情報を記述します。
+
+#### specs.objects.id
+
+オブジェクトの ID を記述します。
+
+#### specs.objects.name
+
+オブジェクトの名前を記述します。
+
+##### specs.objects.path
+
+オブジェクトが保存されているパスを記述します。
+
+#### specs.objects.location
+
+オブジェクトを配置する場所を記述します。
+
+#### specs.objects.rotation
+
+オブジェクトを配置する際の回転情報を記述します。
+
+#### specs.objects.scale
+
+オブジェクトを配置する際のスケーリング情報を記述します。

package/scene.yaml

@@ -0,0 +1,37 @@
+metadata:
+  id: "cqj2ur95vguh3mj5ba00"
+  type: sutera-scene@0.1.0
+  name: sutera scene
+  version: 0.1.0
+specs:
+  spawn_point:
+    x: 0
+    y: 0
+    z: 0
+  border:
+    x_min: -100
+    x_max: 100
+    y_min: -100
+    y_max: 100
+    z_min: -100
+    z_max: 100
+  objects:
+    - id: "cqj2us15vguh3sm15j7g"
+      name: sofa
+      path: models/sofa.yaml
+      location:
+        x: 0.0
+        y: 0.0
+        z: 0.0
+      rotation:
+        x: 0.0
+        y: 0.0
+        z: 0.0
+        w: 0.0
+      scale:
+        x: 1.0
+        y: 1.0
+        z: 1.0
+    - id: "cqj2us95vguh428mb9m0" # 最小構成
+      name: ball
+      path: models/sofa.yaml

package/world.yaml

@@ -0,0 +1,10 @@
+metadata:
+  type: sutera-world@0.1.0
+  name: sutera world
+  version: 0.1.0
+specs:
+  default_scene:
+    id: "cqj2us15vguh3sm15j7g"
+  scenes:
+    - path: models/sofa.yaml
+    - path: models/ball.yaml