docs: document manual processing (#381)

Closes: #315
This commit is contained in:
bd_ 2023-08-07 21:11:28 +09:00 committed by GitHub
parent 16faa4d98a
commit 4aa5e32184
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 57 additions and 0 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

View File

@ -0,0 +1,29 @@
---
sidebar_position: 7
---
# Manual processing
When developing for VRChat, usually you can just let Modular Avatar automatically process your avatar; when you enter
play mode or build your avatar, Modular Avatar will apply its transformations automatically. However, there are some
cases where you might want to manually apply Modular Avatar processing - for example, when building an avatar for a
non-VRChat platform, or when you are debugging issues with your avatar.
You can trigger manual processing by right-clicking your avatar and selecting `Modular Avatar -> Manual bake avatar`.
Modular Avatar will create a copy of your avatar with all transformations applied.
![Manual Bake Avatar option](manual-bake-avatar.png)
## Generated Assets
Modular Avatar generates a number of assets based on the components you attach to your avatar. When you manually bake
your avatar, these assets are saved in a folder named `ModularAvatarOutput` under your project's main Assets folder.
Initially, all assets are packed into a single file; this is necessary to avoid Unity bugs and improve processing time.
However, you can unpack this file by selecting it in your project view, then clicking `Unpack` on the inspector pane.
![Unpack button](manual-bake-unpack.png)
Modular Avatar will then unpack the generated assets into separate files.
Regardless of whether you choose to unpack or not, if you delete the cloned baked avatar, it's safe to delete the
`ModularAvatarOutput` files.

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

View File

@ -0,0 +1,28 @@
---
sidebar_position: 7
---
# 手動処理
VRChat向けにアバターを作る場合は、通常Modular Avatarに自動的にアバターを処理させてもよいはずです。
プレイモードに入るか、アバターをビルドすると、Modular Avatarが自動的に変換・適用します。
しかし、VRChat以外のプラットフォーム向けにアバターを作る場合や、アバターの問題をデバッグする場合など、手動でModular Avatarの処理を適用する
必要がある場合もあります。
アバターを右クリックし、`Modular Avatar -> Manual bake avatar`を選択することで、手動で処理できます。
Modular Avatarは、すべての変換を適用したアバターのコピーを作成します。
![Manual Bake Avatar option](manual-bake-avatar.png)
## 生成されたアセット
Modular Avatarは、アバターにアタッチしたコンポーネントに基づいて、いくつかのアセットを生成します。
アバターを手動で処理すると、この一時アセットがプロジェクトのメインAssetsフォルダーの下にある`ModularAvatarOutput`フォルダーに保存されます。
最初は、すべてのアセットが1つのファイルにパックされています。これは、Unityのバグを回避し、処理時間を短縮するために必要です。
ただし、プロジェクトビューでファイルを選択し、インスペクターペインで`Unpack`をクリックすると、このファイルを展開できます。
![Unpack button](manual-bake-unpack.png)
Unpackを押すと、生成されたアセットが別々のファイルに展開されます。
Unpackするかどうかにかかわらず、クローンされたベイク済みアバターを削除した後は`ModularAvatarOutput`フォルダーを削除しても大丈夫です。