Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from
80 changes: 80 additions & 0 deletions package/01-sutera-world-spec.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# ワールド

sutera VR にアップロードするワールドの情報を記述します。

Check failure on line 3 in package/01-sutera-world-spec.md

View workflow job for this annotation

GitHub Actions / textlint

[textlint] reported by reviewdog 🐶 sutera => Sutera (prh) Raw Output: /home/runner/work/Specifications/Specifications/package/01-sutera-world-spec.md:3:1: error: sutera => Sutera (prh) (eslint.rules.prh)

Check failure on line 3 in package/01-sutera-world-spec.md

View workflow job for this annotation

GitHub Actions / textlint

[textlint] reported by reviewdog 🐶 sutera => Sutera (prh) Raw Output: /home/runner/work/Specifications/Specifications/package/01-sutera-world-spec.md:3:1: error: sutera => Sutera (prh) (eslint.rules.prh)
HMasataka marked this conversation as resolved.
Show resolved Hide resolved
HMasataka marked this conversation as resolved.
Show resolved Hide resolved
現在ワールドは静的なオブジェクトに限定されています。

## 情報

### medatdata.type

yaml の種類を記述します。

### medatdata.name

ワールドの名前を記述します。

### medatdata.version

ワールドのバージョンを記述します。

## スペック

### specs.spawn_point

ユーザーがワールドに入場した際のスポーンポイントを記述します。

### specs.border

ワールドの境界を記述します。ここで設定された値を越えた際、ユーザーはリスポーンします。

### specs.objects

ワールドを構成するオブジェクトの情報を記述します。

#### specs.objects.name

オブジェクトの名前を記述します。

##### specs.objects.model.type

オブジェクトの形式を記述します。

##### specs.objects.model.path

オブジェクトが保存されているパスを記述します。

#### specs.objects.material

オブジェクトが利用するマテリアルの情報を記述します。

##### specs.objects.material.type

マテリアルの形式を記述します。

##### specs.objects.material.path

マテリアルが保存されているパスを記述します。

#### specs.objects.location

オブジェクトを配置する場所を記述します。

#### specs.objects.rotation

オブジェクトを配置する際の回転情報を記述します。

#### specs.objects.scale

オブジェクトを配置する際のスケーリング情報を記述します。

#### specs.objects.physics

オブジェクトの物理情報を記述します。

##### specs.objects.colliders

オブジェクトのコライダー情報を記述します。

##### specs.objects.gravity

オブジェクトの重力情報を記述します。
48 changes: 48 additions & 0 deletions package/world.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
metadata:
type: [email protected]
name: sutera world
version: 0.1.0
specs:
spawn_point:
x:
y:
z:
border: # 越えたらリスポーン
x_min:
x_max:
y_min:
y_max:
z_min:
z_max:
objects: # 配列
- name: sofa
model:
type: gltf
path: models/sofa.gltf
material:
type: sbsar
path: materials/sofa.sbsar
location:
x:
y:
z:
rotation:
x:
y:
z:
w:
scale:
x:
y:
z:
physics:
colliders:
- type: box
gravity:
mass: 5000
- name: ball # 最小構成
model:
type: sphere # 基本図形はgltfなしで可能
material:
type: diffuse_bsdf # 単色もファイルなしで可能
color: 0x6833cf
Loading