Leahnaya/UniVRM
1
0
Fork 0
mirror of https://github.com/vrm-c/UniVRM.git synced 2026-08-28 13:54:45 -05:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

read the docs テンプレート向けに整理

Browse Source
This commit is contained in:
ousttrue
2021-10-13 15:52:03 +09:00
parent ac6ed518f0
commit dcce1f2c46
16 changed files with 102 additions and 147 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/build.md
View File

@@ -1,5 +1,7 @@
# アプリケーションのビルド
UniVRMを使うアプリケーションのビルドに関する注意事項
## ビルドに含めるシェーダー
`Project Settings = Graphics - Always Included Shaders` などに設定して、ビルドに含まれるようにしてください。

12
docs/history.md → docs/gltf/index.md
View File

@@ -1,4 +1,4 @@
# Version
# glTF
| version | |
|---------|-------------------------------------------------|
@@ -7,4 +7,12 @@
| v0.77 | `RuntimeGltfInstance` |
| v0.68 | `GltfParser` |
| v0.63.2 | gltf の extension の実装方法を変更 |
| v0.56 | BlendShapeKey の仕様変更 |
```{toctree}
:maxdepth: 1
0_82_glb_import
how_to_impl_extension
0_36_update
format
```

11
docs/implementation/index.md Normal file
View File

@@ -0,0 +1,11 @@
# 実装メモ
```{toctree}
:maxdepth: 1
runtime_resource_management
texture_manipulation
coordinate
fast_spring_bone
first_person
```

84
docs/index.md
View File

@@ -3,93 +3,17 @@
これは、[UniVRM](https://github.com/vrm-c/UniVRM) の開発ドキュメントです。
UnityでVRMをエクスポートする方法などについては [manual](https://vrm.dev/docs/univrm/) を参照してください。
## 概要
```{toctree}
:maxdepth: 1
package
history
```
## build
UniVRMを使うアプリケーションのビルドに関する注意事項
```{toctree}
build
```
## 実装メモ
```{toctree}
:maxdepth: 1
implementation/runtime_resource_management
implementation/texture_manipulation
implementation/coordinate
implementation/fast_spring_bone
implementation/first_person
```
## glTF
```{toctree}
:maxdepth: 1
gltf/0_82_glb_import
gltf/how_to_impl_extension
gltf/0_36_update
gltf/format
```
## VRM
```{toctree}
:maxdepth: 1
vrm0/0_82_runtime_import
vrm0/0_79_runtime_import
vrm0/0_77_runtime_import
vrm0/0_68_runtime_import
vrm0/0_44_runtime_import
vrm0/0_58_blendshape
vrm0/firstperson
```
### Samples
- SimpleViewer
- RuntimeExporerSample
- FirstPersonSample
- AnimationBridgeSample
## VRM-1.0(β)
```{toctree}
:maxdepth: 2
vrm1/vrm1_runtime_load
vrm1/vrm1_get_humanoid
vrm1/vrm1_expression
vrm1/vrm1_lookat
vrm1/vrm1_firstperson
```
### Samples
- VRM10Viewer
## Release
```{toctree}
:glob:
:maxdepth: 1
implementation/index
gltf/index
vrm0/index
vrm1/index
release/index
```
# Indices and tables
* {ref}`genindex`

1
docs/release/055/index.md
View File

@@ -9,7 +9,6 @@
```{toctree}
:glob:
:maxdepth: 1
:reversed:
v*
```

1
docs/release/056/index.md
View File

@@ -5,7 +5,6 @@
```{toctree}
:glob:
:maxdepth: 1
:reversed:
v*
```

1
docs/release/068/index.md
View File

@@ -10,7 +10,6 @@
```{toctree}
:glob:
:maxdepth: 1
:reversed:
v*
```

18
docs/package.md → docs/release/079/index.md
View File

@@ -1,6 +1,18 @@
# パッケージ構成
# v0.79～: Unity-2019.4
## パッケージ
## ReleaseNote
* `0.80.0` からサポートする Unity の最低バージョンを `2019.4LTS` に更新しました。
* `0.80.0` から `VRM-1.0β` のパッケージ提供を開始しました。
```{toctree}
:glob:
:maxdepth: 1
v*
```
## パッケージ(v0.81~)
| unitypackage | folder | contents |
|--------------------|-----------------------------------|-----------------------|
@@ -19,7 +31,7 @@
+----------------------+
```
## UPM
## UPM(v0.81~)
```json
// manifest.json 抜粋

12
docs/release/079/v0.79.0.md
View File

@@ -2,18 +2,12 @@
## [v0.79.0](https://github.com/vrm-c/UniVRM/tree/v0.79.0) (2021-07-19)
* commit: https://github.com/vrm-c/UniVRM/releases/tag/v0.79.0
* milestone: https://github.com/vrm-c/UniVRM/milestone/41?closed=1
[Full Changelog](https://github.com/vrm-c/UniVRM/compare/v0.78.0...v0.79.0)
* [0.79.0](http://github.com/vrm-c/UniVRM/releases/tag/v0.79.0)
* [milestone](https://github.com/vrm-c/UniVRM/milestone/41?closed=1)
* [Full Changelog](https://github.com/vrm-c/UniVRM/compare/v0.78.0...v0.79.0)
このバージョンから `pre release` をやめて通常リリースに戻ります。
## ToDo:
* [ ] 0.66 ~ 0.79 の変更まとめ
* [ ] (GLB, GLTF) ScriptedImporter の導入 と Extract の説明
## AutoReference
Autoreference を有効にします。

9
docs/release/079/v0.80.0.md
View File

@@ -1,11 +1,10 @@
# v0.80.0: 1.0準備, 最低バージョンを Unity-2019.4LTS に更新
## [v0.80.0](https://github.com/vrm-c/UniVRM/tree/v0.80.0) (2021-08-11)
* commit: https://github.com/vrm-c/UniVRM/releases/tag/v0.80.0
* milestone: https://github.com/vrm-c/UniVRM/milestone/42?closed=1
[Full Changelog](https://github.com/vrm-c/UniVRM/compare/v0.79.0...v0.80.0)
* [0.80.0](http://github.com/vrm-c/UniVRM/releases/tag/v0.80.0)
* [milestone](https://github.com/vrm-c/UniVRM/milestone/42?closed=1)
* [Full Changelog](https://github.com/vrm-c/UniVRM/compare/v0.79.0...v0.80.0)
* `Unity-2019.4LTS`
## 最低バージョンを Unity-2019.4LTS に更新
- Unityのサポートバージョンを 2019.4LTS 以降にする [\#1126](https://github.com/vrm-c/UniVRM/issues/1126)

13
docs/release/079/v0.81.0.md
View File

@@ -2,6 +2,12 @@
**Stable 安定板**
## [v0.81.0](https://github.com/vrm-c/UniVRM/tree/v0.81.0) (2021-08-20)
* [0.81.0](http://github.com/vrm-c/UniVRM/releases/tag/v0.81.0)
* [milestone](https://github.com/vrm-c/UniVRM/milestone/43?closed=1)
* [Full Changelog](https://github.com/vrm-c/UniVRM/compare/v0.80.0...v0.81.0)
`v0.81.0` から `unitypackage` が変わりました。
* Install `UniGLTF_VRMShaders` and `UniVRM`
@@ -34,13 +40,6 @@
`UniGLTF_VRMShaders` `UniVRM` の順に２つインストールしてください
## [v0.81.0](https://github.com/vrm-c/UniVRM/tree/v0.81.0) (2021-08-20)
* commit: https://github.com/vrm-c/UniVRM/releases/tag/v0.81.0
* milestone: https://github.com/vrm-c/UniVRM/milestone/43?closed=1
[Full Changelog](https://github.com/vrm-c/UniVRM/compare/v0.80.0...v0.81.0)
## パッケージ整理など
- UniGLTF の UPM id を、`com.vrmc.unigltf` から `com.vrmc.gltf` に変えてバージョンを振り直し [\#1156](https://github.com/vrm-c/UniVRM/issues/1156)
- UnityPackage に Samples を含める [\#1159](https://github.com/vrm-c/UniVRM/pull/1159) ([ousttrue](https://github.com/ousttrue))

8
docs/release/079/v0.82.0.md
View File

@@ -1,10 +1,10 @@
# v0.82.0: 1.0準備, URP 向け Material置き換え機能
## [v0.82.0](https://github.com/vrm-c/UniVRM/tree/v0.82.0) (2021-09-01)
* commit: https://github.com/vrm-c/UniVRM/releases/tag/v0.82.0
* milestone: https://github.com/vrm-c/UniVRM/milestone/44?closed=1
[Full Changelog](https://github.com/vrm-c/UniVRM/compare/v0.81.0...v0.82.0)
* [0.82.0](http://github.com/vrm-c/UniVRM/releases/tag/v0.82.0)
* [milestone](https://github.com/vrm-c/UniVRM/milestone/44?closed=1)
* [Full Changelog](https://github.com/vrm-c/UniVRM/compare/v0.81.0...v0.82.0)
* glb の import, URP API
## URP(Universal Render Pipeline)
URP 向けに Material Import をカスタマイズする機能をはじめました (Experimental)

2
docs/release/079/v0.83.0.md
View File

@@ -10,6 +10,8 @@ https://vrm-c.github.io/UniVRM/
## [v0.83.0](https://github.com/vrm-c/UniVRM/tree/v0.83.0) (2021-09-10)
| 09/03 | [0.82.1](http://github.com/vrm-c/UniVRM/releases/tag/v0.82.1) [milestone](https://github.com/vrm-c/UniVRM/milestone/45?closed=1) | | URP API |
* commit: https://github.com/vrm-c/UniVRM/releases/tag/v0.83.0
* milestone: https://github.com/vrm-c/UniVRM/milestone/45?closed=1
[Full Changelog](https://github.com/vrm-c/UniVRM/compare/v0.82.1...v0.83.0)

36
docs/release/index.md
View File

@@ -2,47 +2,15 @@
| バージョン | お勧め | Unity | |
|---------------------------------|--------|--------------------|----------------------------------|
| v0.79～ | 最新版 | Unity-2019.4 | 特に問題が無ければこれ。 |
| {doc}`v0.79～ <079/index>` | 最新版 | Unity-2019.4 | 特に問題が無ければこれ。 |
| {doc}`v0.68～v0.78 <068/index>` | | Unity-2018.4 | 開発版。最新版を使ってください。 |
| {doc}`v0.56～v0.67 <056/index>` | v0.66 | Unity-2018.4 | |
| {doc}`～v0.55 <055/index>` | v0.55 | Unity-5.6(.NET3.5) | |
## v0.79～
* `from 0.80`: `Unity-2019.4`
* `from 0.81`: `UniGLTF_VRMShaders` and `UniVRM` ２パッケージ構成
### ReleaseNote
```{toctree}
:glob:
:maxdepth: 1
:reversed:
079/*
```
### Download
## v0.79.0 ～
* `0.80.0` からサポートする Unity の最低バージョンを `2019.4LTS` に更新しました。[Unity Version]({{< relref "unity_version.md" >}})。
* `0.80.0` から `VRM-1.0β` のパッケージ提供を開始しました。
| date | version | 安定性・バグ | 更新内容・備考 |
|-------|----------------------------------------------------------------------------------------------------------------------------------|---------------|---------------------------------------------|
| 07/20 | [0.79.0](http://github.com/vrm-c/UniVRM/releases/tag/v0.79.0) [milestone](https://github.com/vrm-c/UniVRM/milestone/41?closed=1) | | pre release 運用終了 |
| 08/12 | [0.80.0](http://github.com/vrm-c/UniVRM/releases/tag/v0.80.0) [milestone](https://github.com/vrm-c/UniVRM/milestone/42?closed=1) | | `Unity-2019.4LTS` 以降 |
| 08/20 | [0.81.0](http://github.com/vrm-c/UniVRM/releases/tag/v0.81.0) [milestone](https://github.com/vrm-c/UniVRM/milestone/43?closed=1) | | ３パッケージ構成(UniGLTF, VRM, VRM-1.0beta) |
| 09/01 | [0.82.0](http://github.com/vrm-c/UniVRM/releases/tag/v0.82.0) [milestone](https://github.com/vrm-c/UniVRM/milestone/44?closed=1) | glb の import | URP API |
| 09/03 | [0.82.1](http://github.com/vrm-c/UniVRM/releases/tag/v0.82.1) [milestone](https://github.com/vrm-c/UniVRM/milestone/45?closed=1) | | URP API |
## Older versions
```{toctree}
:maxdepth: 1
079/index
068/index
056/index
055/index

24
docs/vrm0/index.md Normal file
View File

@@ -0,0 +1,24 @@
# VRM
| version | |
|---------|-------------------------------------------------|
| v0.56 | BlendShapeKey の仕様変更 |
```{toctree}
:maxdepth: 1
0_82_runtime_import
0_79_runtime_import
0_77_runtime_import
0_68_runtime_import
0_44_runtime_import
0_58_blendshape
firstperson
```
## Samples
- SimpleViewer
- RuntimeExporerSample
- FirstPersonSample
- AnimationBridgeSample

15
docs/vrm1/index.md Normal file
View File

@@ -0,0 +1,15 @@
# VRM-1.0(β)
```{toctree}
:maxdepth: 2
vrm1_runtime_load
vrm1_get_humanoid
vrm1_expression
vrm1_lookat
vrm1_firstperson
```
## Samples
- VRM10Viewer