docs(spec/package):about model of sutera package using yaml

package/About_model_of_sutera_package_using_yaml.md

@@ -0,0 +1,87 @@
+# Suteraパッケージのモデルについて(yamlフォーマット)
+
+## 概要
+Suteraパッケージではワールド内に設置された3Dモデルの情報を本項目で説明してるyamal^[1]フォーマットを用いて管理しています。
+
+## モデルのyamlファイルに必要な要素
+Suteraパッケージにおいてワールド内で設置されたオブジェクトの位置や、3Dモデルへのパスといったオブジェクトに関する様々な情報を保持する必要があります。Suteraパッケージではそれらオブエジェクトに関する情報を以下のような要素を持ったyamlファイルを用いて管理しています。
+
+### metadata
+ファイルの基本的な情報が記載される部分です。
+- type オブジェクトの場合Sutera-objectと記載されます
+- Sutera_version 使用されているsuteraのバージョンが記載されます
+- name オブジェクトの名前が記載されます
+- version オブジェクトのバージョンが記載されます
+- id オブジェクトに割り振られたidが記載されます
+
+### model
+使用する3Dモデルに関して記述される部分です。
+- type 使用する3Dモデルのファイルタイプを記載してください
+- path 使用する3Dモデルのファイルへの絶対パスを指定してください
+
+### material
+3Dモデルで使用するマテリアルに関して記述する部分です。
+- type マテリアルに使用するファイルのタイプを記述してください
+- path マテリアルに使用するファイルの絶対パスを記述してください
+
+### physics
+モデルの物理的挙動の設定に関して記述する部分です。
+- coliders
+コライダーに関して設定する部分です。配列なので、設定しない場合は空配列[]を設定してください。
+  - type コライダーのタイプについて記述します
+- gravity 重力について記述します
+  - mass 質量の設定で単位は[kg]です
+
+### specs
+ocjectをワールドに設置した際の位置や回転などを記述する部分です。
+- location ワールドにおけるオブジェクトのグローバル座標です。x,y,zの3次元直交座標系で記載します
+- rotation オブジェクトの回転を表します。x,y,z,wのクォータニオンで記載します
+- scale オブジェクトのスケールです。locationと同じくx,y,zの3次元直交座標系で記載します。
+- object_origin ワールドにおけるオブジェクトの原点です。グローバル座標で表され、オブジェクトをリスポーンした際にはこの位置にオブジェクトが移動します
+## yamlファイルの例
+```
+metadata:
+    type: sutera-object 
+    sutera_version: 0.1.0
+    name: #
+    version: 0.2.0  
+
+model:     
+    type: gltf #ファイルのタイプを記述
+    path: models/sofa.gltf #ファイルの置いてあるフォルダへの絶対パスを指定
+
+material: 
+    type: sbsar  #マテリアルのファイルタイプについて記述
+    path: materials/sofa.sbsar      #マテリアルのファイルへの絶対パス
+
+physics:
+    colliders:       # 配列だから、明記しない場合 `colliders: []`
+    - type: box #コライダーのタイプを記載
+    gravity:
+        mass: 5000                     ##明記しない場合0(つまり重力なし)
+
+specs:
+    location:
+        x:5
+        y:5
+        z:0
+    rotation:
+        x:0
+        y:0
+        z:0
+        w:0
+    scale:
+        x:1
+        y:1
+        z:1
+    obejct_origin:
+        x:1
+        y:1
+        z:0
+
+
+```
+
+## 参考文献,脚注
+^[1~] YAML (「YAML Ain't Markup Language」の再帰的頭字語) は、人間に優しく、日常の一般的なタスクで最新のプログラミング言語とうまく連携するように設計されたデータシリアル化言語です。^[2]  
+^[2~] yaml公式サイトspecification v1.2.2 https://yaml.org/spec/1.2.2/ 閲覧2024/7/23