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: Update docs and modal instruction for the ratified spec #14

Merged
merged 1 commit into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# bvh to VRMA

このリポジトリは bvh ファイルを VRMAnimation ファイルに変換する web アプリケーションのリポジトリです。
このリポジトリは bvh ファイルを VRMアニメーション ファイルに変換する web アプリケーションのリポジトリです。

# デモ

Expand All @@ -9,9 +9,7 @@ https://vrm-c.github.io/bvh2vrma/

# 注意点

- VRMAnimation ファイル(vrma)の仕様はドラフト段階です。
- 変換結果を保証するものではありません。入力された bvh ファイルによっては失敗することがあります。
- ドラフトのため、書き出されたデータが将来的な仕様変更により使えなくなることがあります。

# 開発を行うには

Expand All @@ -27,10 +25,11 @@ git clone https://github.com/vrm-c/bvh2vrma
yarn install && yarn dev
```

# VRMAnimation
# VRMアニメーション

VRMAnimation は現在仕様策定中の人間型モデルに対するアニメーションを記述するための glTF 拡張です。
詳しい仕様に関しては別途[仕様書](https://github.com/vrm-c/vrm-specification/blob/master/specification/VRMC_vrm_animation-1.0/README.ja.md)をお読みいただけますと幸いです。
VRMアニメーションは、VRMで定義された人型モデルに対するアニメーションを記述するための glTF 拡張です。
VRMアニメーションファイルについての詳細は[Webサイト](https://vrm.dev/vrma/)をご覧ください。
また、詳しい仕様に関しては別途[仕様書](https://github.com/vrm-c/vrm-specification/blob/master/specification/VRMC_vrm_animation-1.0/README.ja.md)をお読みいただけますと幸いです。

# ライセンス

Expand Down
30 changes: 23 additions & 7 deletions src/components/Modal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,28 @@ const ModalWrapper = (props: ModalWrapperProps) => {
<div className="py-24 text-brand typography-20">このアプリケーションについて</div>
<div>
<ul className="list-disc pl-24">
<li>bvhファイルをVRMAnimationファイル(vrma)に変換するアプリケーションです。</li>
<li>bvhファイルをVRMアニメーションファイル (vrma) に変換するアプリケーションです。</li>
<li>
VRMアニメーションファイルについての詳細は
<a
className="text-link1"
href="https://vrm.dev/vrma/"
target="_blank"
rel="noreferrer"
>
Webサイト
</a>
をご覧ください。
</li>
<li>このサイトは入力されたbvhファイルをサーバーにアップロードしません。</li>
<li>
このサイトのライセンスはMITです。リポジトリのリンクは
<a className="text-link1" href="https://github.com/vrm-c/bvh2vrma">
<a
className="text-link1"
href="https://github.com/vrm-c/bvh2vrma"
target="_blank"
rel="noreferrer"
>
こちら
</a>
です。
Expand All @@ -33,21 +50,20 @@ const ModalWrapper = (props: ModalWrapperProps) => {
<div className="py-24 text-brand typography-20">利用上の注意</div>
<ul className="pl-24 list-disc">
<li>
VRMAnimationファイル(vrma)の仕様はドラフト段階です。詳しい仕様に関しましては
VRMアニメーションファイル (vrma) の詳しい仕様については
<a
className="text-link1"
href="https://github.com/vrm-c/vrm-specification/blob/master/specification/VRMC_vrm_animation-1.0/README.ja.md"
target="_blank"
rel="noreferrer"
>
GitHub
</a>
にてご覧ください
をご覧ください
</li>
<li>
変換結果を保証するものではありません。入力されたbvhファイルによっては失敗することがあります。
</li>
<li>
ドラフトのため、書き出されたデータが将来的な仕様変更により使えなくなることがあります。
</li>
</ul>
<ModalButtons>
<Button variant="Primary" onClick={() => state.close()}>
Expand Down