Compatibility Notes with VRCFury VRCFuryとの互換性について

[anatawa12]

日本語が下にあります。

In English

This is notes about compatibility with VRCFury.

This information is heavily depends on version of NDMF and VRCFury.
Current information is based on NDMF 1.4.2 and VRCFury 1.859.0.
Since this information can be changed at any time, I put this on discussions. Please check the latest information.

If you have questions, Please ask in Q&A category.

Short notes for VRCFury users

• Using AAO with VRCFury is unstable.
• To execute AAO correctly with VRCFury you have to use latest NDMF and latest VRCFury
• I recommend you to use Av3Emulator to ensure AAO works correctly with VRCFury on Play Mode.
  • If you're old user of Av3Emulator, please make sure Run Preprocess Avatar Hook is enabled. It was not enabled by default for old Av3Emulator.
• Some VRCFury 'fixes' may effect your avatar. See "VRCFury 'fixes' may cause unexpected behavior" section below

Technical information

General information with non-NDMF tools

First, I do not guarantee compatibility with non-destructive tools that do not use NDMF, especially when starting Play Mode.

In general, for actual build time, IVRCSDKPreprocessAvatarCallback.callbackOrder works well for guaranteeing compatibility (processing ordering).
For example, some shaders optimizes their shader or material in IVRCSDKPreprocessAvatarCallback.OnPreprocessAvatar and it works well with AAO.

If you're using Av3Emulator, thanks to the feature in Av3Emulator that calls IVRCSDKPreprocessAvatarCallback when play mode, IVRCSDKPreprocessAvatarCallback.callbackOrder works well even in play mode.
If you're old user of Av3Emulator, please make sure Run Preprocess Avatar Hook is enabled. It was not enabled by default for old Av3Emulator.

Improvements in NDMF 1.3.2 and VRCFury 1.712.0

Starting with NDMF 1.3.2 and VRCFury 1.712.0 or later, both NDMF and VRCFury were changed to use IVRCSDKPreprocessAvatarCallback for entering Play Mode.
Both NDMF and VRCFury will calls IVRCSDKPreprocessAvatarCallback when entering Play Mode in callbackOrder order.
In addition, for environments with Av3Emulator, NDMF and VRCFury will automatically enable Run Preprocess Avatar Hook so that IVRCSDKPreprocessAvatarCallback is called when entering Play Mode.

This makes AAO works correctly on Play Mode.

Improvements in NDMF 1.3.0

In NDMF 1.3.0, NDMF changed something to improves compatibility with VRCFury.

In NDMF 1.3.0, NDMF skips Optimizing phase when entering Play Mode including called by VRCFury as a hack.
This makes VRCFury's gimmick work properly with AAO during Play Mode.
However, as a result, AAO become not applied in Play Mode unless you use Av3Emulator.

VRCFury problems (until NDMF 1.3.0)

There was two big problems for compatibility with VRCFury.

Those problems are worked around in NDMF v1.3.0 so those problems are no longer a problem.

First, VRCFury has ordering difference between Play Mode and Build.

NDMF executes the process during initializing the scene and VRCFury executes after scene initialization.
So VRCFury is executed after NDMF when entering Play Mode.
However, VRCFury has lower callbackOrder than NDMF Optimizing phase.
So, VRCFury is executed before NDMF Optimizing when entering Build.
This makes VRCFury's gimmick may not work properly when entering Play Mode.

Second, VRCFury calls NDMF in incorrect way and timing.

Since VRCFury 1.648.0, VRCFury calls NDMF in their process as a hack.
However, the call completely breaks the Avatar since it executes Optimizing phase before executing VRCFury process.
This made VRCFury's gimmick may not work properly with AAO.
Plesase refer issue on VRCFury for more details

VRCFury 'fixes' may cause unexpected behavior

VRCFury applies some 'fixes' to the avatar if any of VRCFury component is added on the avatar.
However, some of such fixes will cause unexpected behavior if combined with AAO: Avatar Optimizer.

One known problem is compatibility with automatic renaming of objects in VRCFury.
VRCFury silently renames 2nd (or later) GameObjects with exactly same name by adding (1) or others.
This itself does not break thing in most case, but may cause problem with AAO Merge Skinned Mesh (MergeSMR) and mmd world compatibility.
By adding MergeSMR on new Body mesh with original Body as a source as shown below, you can merge multiple meshes with keeping MMD world compatibility.
However, with VRCFury runs before AAO, VRCFury renames Body with MergeSMR to Body (1).
As a result, Avatar Optimizer will merge mesh to Body (1) so mmd world compatibility will be lost.

AvatarRoot
 +- Body (BaseModel)
 +- SomeOtherMesh
 `- Body (MergeSMR)

日本語 (Japanese)

VRCFuryとの互換性についての情報です。

この情報はNDMFとVRCFuryのバージョンに大きく依存しています。
現在の情報はNDMF 1.4.2とVRCFury 1.859.0をベースにしています。
この情報はいつでも変更される可能性があるため、ディスカッションに書きました。最新の情報を確認してください。

もし質問があればQ&Aカテゴリで質問してください

VRCFuryユーザー向けの情報

• AAOとVRCFuryを併用するのは、不安定です。
• VRCFuryとAAOを正しく実行するには、最新版のNDMF及び最新版のVRCFuryを使う必要があります。
• Play ModeでAAOが正しく動作するようにするには、Av3Emulatorを使用することをお勧めします。
  • もしAv3Emulatorの古いユーザの場合、Run Preprocess Avatar Hookが有効であることを確認してください。古いAv3Emulatorでは規定で有効ではありませんでした。
• VRCFuryによって行われる'修正'がアバターの動作に影響を与えることがあります。詳しくは下の"VRCFuryの'修正'が意図しない動作を作る可能性があります"を参照してください。

技術情報

NDMFを使わないツールとの一般的な情報

まずはじめに、私はNDMFを使わない非破壊ツールとの互換性について、特にPlay Mode開始時について保証しません。

一般には、実際のビルド時には、IVRCSDKPreprocessAvatarCallback.callbackOrderが互換性(処理順序)を保証してくれます。
例えば、多くのシェーダーはIVRCSDKPreprocessAvatarCallback.OnPreprocessAvatarでシェーダーまたはマテリアルを最適化し、AAOとうまく動作します。

Av3Emulatorを使用してる際には、Av3Emulatorのプレイモードに入るときにIVRCSDKPreprocessAvatarCallbackを呼び出す機能のおかげで、IVRCSDKPreprocessAvatarCallback.callbackOrderによる互換性(処理順序)の保証がうまく動作します。
もしAv3Emulatorの古いユーザの場合、Run Preprocess Avatar Hookが有効であることを確認してください。古いAv3Emulatorでは規定で有効ではありませんでした。

NDMF 1.3.2とVRCFury 1.712.0での改善

NDMF 1.3.2とVRCFury 1.712.0以降から、NDMFとVRCFuryはPlay Modeに入るときにIVRCSDKPreprocessAvatarCallbackを使用するように変更されました。
NDMFとVRCFuryのどちらも、Play Modeに入るときにIVRCSDKPreprocessAvatarCallbackをcallbackOrderの順序で呼び出します。
また、Av3Emulatorを使用している環境では、NDMFとVRCFuryはPlay Modeに入るときにIVRCSDKPreprocessAvatarCallbackが呼び出されるように自動的にRun Preprocess Avatar Hookを有効にします。

これにより、Play ModeでAAOが正しく動作します。

NDMF 1.3.0 での改善

NDMF 1.3.0では、NDMFはVRCFuryとの互換性を改善するための変更しました。

NDMF 1.3.0では、VRCFuryによるハック呼び出しを含めて、Play Modeに入るときにOptimizingフェーズをスキップします。
したがって、Play Mode中にVRCFuryのし掛けがAAOと併用時に正しく動作するようになりました。
しかし、その結果、Av3Emulatorを使用しない場合にはPlay ModeではAAOが適用されません。

VRCFury固有の問題 (NDMF 1.2.0まで)

VRCFuryとの互換性には2つの大きな問題がありました。

NDMF 1.3.0ではこれらの問題に対する回避策が入りました。そのためこれらの問題は今は発生しないと考えられます。

はじめに、VRCFuryはPlay ModeとBuildで順序が異なりました。

NDMFはシーンの初期化中に処理を実行し、VRCFuryはシーンの初期化後に実行します。
そのため、Play Modeに入るときにはNDMFの後にVRCFuryが実行されます。
しかし、VRCFuryはNDMFのOptimizingフェーズよりも低いcallbackOrderを持っています。
そのため、Buildに入るときにはNDMFのOptimizingの前にVRCFuryが実行されます。
したがって、Play Modeに入るときにVRCFuryの機能が正しく動作しない可能性があります。

次に、VRCFuryはNDMFを間違った方法とタイミングで呼び出します。

VRCFury 1.648.0以降、VRCFuryはハックとして、自分の処理中にNDMFを呼び出します。
しかし、VRCFuryの処理を実行する前にOptimizingフェーズを実行するようにするため、この呼び出しは完全に間違っています。
したがって、VRCFuryの機能がAAOと併用時に正しく動作しない可能性がありました。
詳細はVRCFuryのissueを参照してください。

VRCFuryの'修正'が意図しない動作を作る可能性があります

VRCFury は、アバターに VRCFury コンポーネントが追加されると、いくつかの'修正'を自動的に適用します。
しかし、これらの修正の一部は、AAO: Avatar Optimizerと併用した場合に、予期しない動作を引き起こすことがあります。

既知の問題の一つが、VRCFury によるオブジェクト名の自動リネームとの互換性です。
VRCFury は、まったく同じ名前を持つ 2 個目以降の GameObject に対して、(1) などを付けて自動的にリネームします。

この動作自体は、ほとんどの場合は問題になりませんが、AAO のMerge Skinned Mesh(MergeSMR)機能や、MMD ワールドとの互換性において問題を引き起こす可能性があります。

以下のように、元の Body をソースとして、新しい Body メッシュに MergeSMR を追加することで、MMD ワールドとの互換性を保ったまま複数のメッシュを統合できます。
しかし、AAO より先に VRCFury が実行されると、VRCFury は MergeSMR が付いた Body を Body (1) にリネームしてしまいます。
その結果、Avatar Optimizer は Body (1) に対してメッシュを統合することになり、MMD ワールドとの互換性が失われてしまいます。

AvatarRoot
 +- Body (BaseModel)
 +- SomeOtherMesh
 `- Body (MergeSMR)

[anatawa12]

I have updated this announcement with NDMF 1.3.0 release.
NDMF 1.3.0 includes several improvements for VRCFury compatibility.
I recommend you to use NDMF 1.3.0 if you use AAO with VRCFury.
For more details, please refer the updated announcement above.

NDMF 1.3.0のリリースに伴い、このお知らせを更新しました。
NDMF 1.3.0では、VRCFuryとの互換性のためにいくつかの改良が加えられています。
AAOをVRCFuryで使用する場合は、NDMF 1.3.0を使用することをお勧めします。
詳細は更新された上記のアナウンスをご参照ください。

[anatawa12]

VRCFury 1.712.0 breaks NDMF again so I updated the announcement to suggest use 1.711.0.

VRCFury 1.712.0でまたNDMFが破壊されたため、1.711.0を使用するようにアナウンスを更新しました。

[anatawa12]

I have updated announcement as we have been informed that there is no problem with VRCFury 1.712.0 and VRCFury 1.715.0 is less problematic.

VRCFury 1.712.0に関して問題なく、VRCFury 1.715.0のほうが問題がないとの情報があったため更新しました。

[anatawa12]

I have updated documentation with latest NDMF and VRCFury information.

[anatawa12]

I’ve updated the discussion with information about compatibility issues related to VRCFury’s automatic renaming fixes and AAO, based on a recent report.