More docs

This commit is contained in:
bd_ 2022-11-09 18:46:57 -08:00
parent 397061c360
commit afe714fc60
6 changed files with 48 additions and 42 deletions

View File

@ -1,39 +1,41 @@
--- ---
sidebar_position: 5 sidebar_position: 5
sidebar_label: Distributing Prefabs sidebar_label: アセット配布に関して
--- ---
import ReactPlayer from 'react-player' import ReactPlayer from 'react-player'
# Distributing Prefabs # Distributing Prefabs
Modular Avatar is designed to make things easier for prefab authors, by allowing them to distribute prefabs which can be installed by simply dragging and dropping onto the avatar. Modular Avatarはアセット製作者の補助として、ドラッグアンドドロップだけでインストールできるアセットを製作できるように設計しています。
Here are some recommendations for how to best structure prefabs based on Modular Avatar. このページには、Modular Avatarを使ったアセットの配布に関するお勧めな手順などを纏めています。
## Guide your users to the official distribution point for Modular Avatar ## ユーザーをModular Avatarの正式配布ページに誘導してください
Including a copy of Modular Avatar in your prefab's distribution is permitted by the license. However, this could result in users installing a very old version, or even accidentally downgrading and breaking their other prefabs. ライセンス上、アセットにModular Avatarを同封することは許可されています。しかし、古いバージョンをインストールしたり、
I strongly recommend guiding users to the official distribution point for Modular Avatar, which is the [Modular Avatar GitHub repository](https://github.com/bdunderscore/modular-avatar/releases). 場合によってダウングレードさせて他のアセットの誤作動につながる場合があります。[Modular Avatarの公式配布ページ](https://github.com/bdunderscore/modular-avatar/releases)から
DLするように手引きすることを強くお勧めします。
In the future, I intend to provide a VCC-based installation method, which should make things even easier. This is waiting on improvements to VCC itself, however. 今後、VCCを応用した簡易インストール方法を実装する予定です。VCC自体の改善・機能追加待ちですが、導入がかなり楽になると思います。
## Use nested prefabs for compatibility with non-ModularAvatar setups ## ModularAvatarなしの環境にも対応するなら、ネスト状のプレハブを使いこなしましょう
If you add a Modular Avatar component to a prefab, users will be unable to use that prefab without installing Modular Avatar. プレハブにModular Avatarコンポーネントを追加すると、原則としてModular Avatarを導入せずに使うことができません。
Some users might prefer not to use Modular Avatar for whatever reason. If you wish to support this, you can use nested prefabs to separate out the core of your outfits from the Modular Avatar configuration. 一部のユーザーは何らかの理由でModular Avatarを拒むかもしれませんので、その環境にも対応するなら、衣装自体の設定とModular Avatarの設定を
ネスト状のプレハブで分けることができます。
If you've not worked with nested prefabs before, here's how to do this: 使ったことがないなら、簡単に開設すると
1. Create your outfit prefab as normal. 1. まずは衣装のプレハブを作ります
2. Open your prefab in prefab mode (double-click it in the project view). 2. プレハブモードでプレハブを開く(プロジェクトからダブルクリック)
![Prefab mode](prefab-mode.png) ![Prefab mode](prefab-mode.png)
3. Drag the root of your prefab to the project window. When a window pops up, click Create Base. Rename the file to something you'll remember (e.g. `Outfit without Modular Avatar`) 3. プレハブのルートオブジェクトをプロジェクトウィンドウにドラッグアンドドロップ。確認画面が開いたら、「Create Base」を押してください。作られたファイルの名前を分かりやすく変更しましょう例えば「衣装_MAなし」
<ReactPlayer playing muted loop playsinline url='/img/creating-base.mp4' /> <ReactPlayer playing muted loop playsinline url='/img/creating-base.mp4' />
Once you've done this, you can set up modular avatar components on the original prefab, and set any non-modular avatar settings on the base prefab you just created. これが終わったら、もともとのプレハブにModular Avatarコンポーネントを設定し、その他の設定を新しく作られたベースプレハブに設定できます。Prefab overridesメニューを使えば、シーン上で行った調整を設定を簡単にどちらかのプレハブに適用させることもできます。
An easy way of applying such settings is using the prefab overrides menu - you can make changes in a test scene, then select which prefab to apply those changes to afterward. テストシーンにひとまず調整を行って、あとから各プレハブに割り振ることもできます。
![Apply as override](apply-as-override.png) ![Apply as override](apply-as-override.png)
## Use internal parameters on your animator gimmicks ## アニメーターを使ったアセットに内部パラメーターを使いましょう。
Using [internal parameters](../reference/parameters.md) can help avoid clashing with other prefabs. Internal parameters are automatically renamed to a unique name at build time, ensuring you won't have any name clashes. [内部パラメーター](../reference/parameters.md)を使うことで、他のアセットと干渉することを避けましょう。内部パラメーターは自動的にユニークな名前に変更されることで、名前かぶりが起きなくなります。

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 52 KiB

View File

@ -2,50 +2,54 @@
![Merge Animator](merge-animator.png) ![Merge Animator](merge-animator.png)
The merge animator component will add the provided animator to a specified layer of the avatar it is added to. This can be used to make complex AV3 gimmicks that install themselves just by dragging and dropping onto an avatar. Merge Animatorコンポーネントは、指定したアニメーターをアバターの指定したレイヤーに追加します。
ドラッグアンドドロップだけで導入できるAV3ギミックを実装する時には便利です。
[Two samples](../samples/) are included that use this component: A hand-clap effect, and a finger-pen gimmick. ## いつ使うもの?
## When should I use it? アセットの中に、アバター本体のアニメーターに追加するコントローラーがあった場合に使います。
Merge Animator should be used when you have animations you'd like to play back as part of your gimmick. ## 非推奨の場合
## When shouldn't I use it? 既存のレイヤーをそのままにして、指定したコントローラーを追加するだけです。完全に既存のアニメーターを置き換える場合は将来通り
ユーザーに差し替えてもらいましょう。
Merge Animator adds to, but does not replace existing animator layers. If you want the end-user to completely replace an animator layer, it may be better to have them replace it in the avatar descriptor in the traditional way. ## セットアップ方法
## Setting up Merge Animator Merge Animatorコンポーネントをプレハブの中の任意のオブジェクトに追加して、統合されるアニメーターに自分のアニメーターコントローラーを指定します。
そして、「レイヤー種別」をFXなど、アバターディスクリプタにあるアニメーター種別を指定します。
Add the Merge Animator component to an object in your prefab, and attach the animator in the "Animator to merge" field. Set the "Layer Type" field to the avatar layer this should be added to (e.g. FX). ### アニメーションの収録
### Recording animations デフォルトでは、アニメーターの中のパスはMerge Animatorコンポーネントを基準に相対的に解釈されます。
Merge Animator以下のオブジェクトだけをいじる場合は、これでアニメーションの収録が簡単にできます。
By default, paths in your animator are interpreted as relative to the merge animator component. This makes it easy to record new animations, provided you're animating object underneath the Merge Animator component. GameObjectにAnimatorコンポーネントも追加して、Animationパネルでアニメーションを収録できます。
Just attach an Animator component to your GameObject, and you can use the Animation panel to record animations:
![Recording an animation using Merge Animator](merge-animator-record.png) ![Recording an animation using Merge Animator](merge-animator-record.png)
As a development convenience, you can check the "Delete attached animator" box to remove the animator component at build time. 開発の補助として、「付属アニメーターを削除」を入れると、同じオブジェクト内のAnimatorが自動的に排除されます。
### Humanoid bone animations ### ヒューマノイドボーンのアニメーション
Animations that move humanoid bones ignore the relative path logic, and will always apply to the overall avatar. As such most humanoid animations (e.g. AFK animations) can be used as-is. ヒューマノイドボーンを操作するアニメーションは上記の相対的なパスで解釈されるのではなく、アバター全体に適用されます。
AFKアニメーションなどほとんどのヒューマイドアニメーションがそのまま使えるというわけです。
### Absolute path mode ### 絶対的パスモード
If you want to animate objects that are already attached to the avatar (that aren't under your object), set the path mode to "Absolute". This will cause the animator to use absolute paths, and will not attempt to interpret paths relative to the Merge Animator component. 自分のプレハブ外の、元々からあったオブジェクトを操作する場合は、「パースモード」を「絶対的」に変えてください。
This means you will need to record your animations using the avatar's root animator instead. これでアニメーターの中のパスがアバターを基準に解釈され、Merge Animatorから相対的に解釈されるシステムがはずされます。
上記の収録方法が使えなくなるわけです。
### Write Defaults ### Write Defaults
By default, the write defaults state of your animator will not be changed. If you want to ensure that the WD settings of your animator states always matches the avatar's animator, click "Match Avatar Write Defaults". デフォルトでは、アニメーターの中のWrite Defaults設定がそのまま使われます。アバターに合わせたい場合は、「アバターのWriteDefaults設定に合わせる」を入れてください。
This will detect whether the avatar is using write defaults ON or OFF states consistently, and if so your animator will be adjusted to match. If the avatar is inconsistent in its use of write defaults, your animator will be unchanged. アバターの既存アニメーターが一貫して同じWriteDefault設定を使っているかを判断して、それに合わせます。
なお、アバターがもともとからWD設定を混合している場合は、統合するアニメーターの設定をそのまま採用します。
## Limitations ## 制限
### VRCAnimatorLayerControl ### VRCAnimatorLayerControl
Currently, Merge Animator only supports VRCAnimatorLayerControl state behaviors which reference layers within the same animator. 現在、VRCAnimatorLayerControlのState Behaviorに関しては、単一アニメーター内のレイヤーを操作する場合のみに対応しています。
If you intend to use this support, ensure the `Playable` field matches the layer set on the Merge Animator component, and set the `Layer` かならず`Playable`値がMergeAnimatorのレイヤー種別と同じになるようにして、`Layer`値を自分のアニメーター内のレイヤー番号にしてください。
field to be the index of the layer within your animator.

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 26 KiB