feat: allow opt-out from MMD handling (#1524)

Closes: #1518

CHANGELOG-PRERELEASE-jp.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+- [#1524] MMDワールド対応をアバター全体で無効にする機能を追加
 
 ### Fixed
 - [#1522] `Convert Constraints` がアニメーション参照を変換できない問題を修正

CHANGELOG-PRERELEASE.md

@@ -8,6 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [Unreleased]
 
 ### Added
+- [#1524] Added support for disabling MMD world handling at an avatar level
 
 ### Fixed
 - [#1522] `Convert Constraints` failed to convert animation references

CHANGELOG-jp.md

@@ -17,7 +17,8 @@ Modular Avatarの主な変更点をこのファイルで記録しています。
 ### Fixed
 - [#1460] パラメーターアセットをMA Parametersにインポートするとき、ローカルのみのパラメーターが間違ってアニメーターのみ扱いになる問題を修正
 - [#1489] `Merge Blend Tree` やリアクティブコンポーネントとMMDワールドの互換性の問題を修正。
-  詳細は[ドキュメント](https://modular-avatar.nadena.dev/docs/general-behavior/mmd)を参照してください。
+  - 詳細は[ドキュメント](https://modular-avatar.nadena.dev/docs/general-behavior/mmd)を参照してください。
+  - この動作を無効にするには、新しい `MA VRChat Settings` コンポーネントをアバターの適当なところに追加して、適切な設定を無効にしてください。
 - [#1501] MA Parametersコンポーネントのテキスト入力欄を編集する際にUnityのキーボードショートカットが機能しない問題を修正
 - [#1410] 同期レイヤー内のモーションオーバーライドがBone Proxy/Merge Armatureオブジェクトの移動に対して更新されない問題を修正
 - [#1504] 一部の状況で内部の`DelayDisable`レイヤーが不要なオブジェクトを参照しないように変更

CHANGELOG.md

@@ -20,7 +20,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - [#1460] When importing parameter assets in MA Parameters, "local only" parameters were incorrectly treated as
   "animator only"
 - [#1489] Fixed compatibility issues between `Merge Blend Tree` or reactive components and MMD worlds.
-  See [documentation](https://modular-avatar.nadena.dev/docs/general-behavior/mmd) for details on the new handling. 
+  - See [documentation](https://modular-avatar.nadena.dev/docs/general-behavior/mmd) for details on the new handling.
+  - To disable this behavior, attach the new `MA VRChat Settings` component to any object on your avatar and disable the appropriate setting.
 - [#1501] Unity keyboard shortcuts don't work when editing text fields on the MA Parameters component 
 - [#1410] Motion overrides on synced layers are not updated for Bone Proxy/Merge Armature object movement
 - [#1504] The internal `DelayDisable` layer no longer references unnecessary objects in some situations

Editor/Animation/MMDRelayPass.cs

@@ -27,6 +27,8 @@ namespace nadena.dev.modular_avatar.animation
     {
         protected override void Execute(BuildContext context)
         {
+            if (!MMDRelayPass.ShouldRun(context)) return;
+            
             var asc = context.Extension<AnimatorServicesContext>();
             if (asc.ControllerContext.Controllers.TryGetValue(VRCAvatarDescriptor.AnimLayerType.FX, out var fx))
             {
@@ -53,8 +55,16 @@ namespace nadena.dev.modular_avatar.animation
         internal const string StateNameNotMMD = "NotMMD";
         internal const string StateNameMMD = "MMD";
 
+        internal static bool ShouldRun(BuildContext context)
+        {
+            var settings = context.AvatarRootObject.GetComponentsInChildren<ModularAvatarVRChatSettings>(true);
+            return settings.FirstOrDefault()?.MMDWorldSupport ?? true;
+        }
+        
         protected override void Execute(BuildContext context)
         {
+            if (!ShouldRun(context)) return;
+            
             var asc = context.Extension<AnimatorServicesContext>();
             if (!asc.ControllerContext.Controllers.TryGetValue(VRCAvatarDescriptor.AnimLayerType.FX, out var fx))
                 return;

Editor/Inspector/vrchat.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: d59587969bdd48f4ba16883ee3b30d4d
+timeCreated: 1742695977

Editor/Inspector/vrchat/VRChatSettingsEditor.cs

@@ -0,0 +1,27 @@
+using UnityEditor;
+
+namespace nadena.dev.modular_avatar.core.editor
+{
+    [CustomEditor(typeof(ModularAvatarVRChatSettings))]
+    internal class VRChatSettingsEditor : MAEditorBase
+    {
+        protected override void OnInnerInspectorGUI()
+        {
+            serializedObject.Update();
+
+            EditorGUI.BeginChangeCheck();
+
+            EditorGUILayout.PropertyField(
+                serializedObject.FindProperty(nameof(ModularAvatarVRChatSettings.m_mmdWorldSupport)),
+                Localization.G("platform.vrchat.settings.mmd_world_support")
+            );
+
+            if (EditorGUI.EndChangeCheck())
+            {
+                serializedObject.ApplyModifiedProperties();
+            }
+
+            Localization.ShowLanguageUI();
+        }
+    }
+}

Editor/Inspector/vrchat/VRChatSettingsEditor.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 1ffd87033f4d441b849ad147b6e2a6ef
+timeCreated: 1742695986

Editor/Localization/en-US.json

@@ -304,6 +304,7 @@
   "sync-param-sequence.parameters": "Common parameters asset",
   "sync-param-sequence.parameters.tooltip": "The asset to store common parameters in. Do not use the same Expression Parameters that you have set in your avatar descriptor.",
   "sync-param-sequence.create-asset": "New",
-  "sync-param-sequence.create-asset.tooltip": "Creates a new expression parameters asset"
+  "sync-param-sequence.create-asset.tooltip": "Creates a new expression parameters asset",
+  "platform.vrchat.settings.mmd_world_support": "MMD world support"
 
 }

Editor/PluginDefinition/PluginDefinition.cs

@@ -44,10 +44,10 @@ namespace nadena.dev.modular_avatar.core.editor.plugin
             seq.WithRequiredExtension(typeof(ModularAvatarContext), _s1 =>
             {
                 seq.Run(ClearEditorOnlyTags.Instance);
+                seq.Run(VRChatSettingsPass.Instance);
                 seq.Run(MeshSettingsPluginPass.Instance);
                 seq.Run(ScaleAdjusterPass.Instance).PreviewingWith(new ScaleAdjusterPreview());
                 
-                // All these need to move to the new ASC
 #if MA_VRCSDK3_AVATARS
                 seq.Run(ReactiveObjectPrepass.Instance);
 #endif

Editor/VRChat.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 476a3ae35e5046989e0c7276ae860e3c
+timeCreated: 1742695540

Editor/VRChat/VRChatSettingsPass.cs

@@ -0,0 +1,23 @@
+using System.Collections.Generic;
+using nadena.dev.modular_avatar.editor.ErrorReporting;
+using nadena.dev.ndmf;
+
+namespace nadena.dev.modular_avatar.core.editor
+{
+    internal class VRChatSettingsPass : Pass<VRChatSettingsPass>
+    {
+        protected override void Execute(ndmf.BuildContext context)
+        {
+            var settings = context.AvatarRootObject.GetComponentsInChildren<ModularAvatarVRChatSettings>(true);
+
+            if (settings.Length > 1)
+            {
+                var objects = new List<object>();
+                objects.Add("MA VRChat Settings");
+                objects.AddRange(settings);
+
+                BuildReport.LogFatal("error.singleton", objects);
+            }
+        }
+    }
+}

Editor/VRChat/VRChatSettingsPass.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: cc7a69c0f9aa469dbcf8d4b492f5a6d9
+timeCreated: 1742695552

Runtime/ModularAvatarVRChatSettings.cs

@@ -0,0 +1,20 @@
+using JetBrains.Annotations;
+using UnityEngine;
+
+namespace nadena.dev.modular_avatar.core
+{
+    [AddComponentMenu("Modular Avatar/MA VRChat Settings")]
+    [DisallowMultipleComponent]
+    [HelpURL("https://modular-avatar.nadena.dev/docs/reference/vrchat-settings?lang=auto")]
+    public class ModularAvatarVRChatSettings : AvatarTagComponent
+    {
+        [SerializeField] internal bool m_mmdWorldSupport = true;
+
+        [PublicAPI]
+        public bool MMDWorldSupport
+        {
+            get => m_mmdWorldSupport;
+            set => m_mmdWorldSupport = value;
+        }
+    }
+}

Runtime/ModularAvatarVRChatSettings.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 89c938d7d8a741df99f2eda501b3a6fe
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {fileID: 2800000, guid: a8edd5bd1a0a64a40aa99cc09fb5f198, type: 3}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

docs~/docs/general-behavior/mmd.md

@@ -12,6 +12,9 @@ Layers added via Merge Animator (even in replace mode) will not be affected by t
 padding layers will be added to protect them. If you want to opt them into this behavior, you can attach the `MA MMD
 Layer Control` _state machine behavior_ to the layer you want to control.
 
+You can also disable this behavior entirely by attaching the [VRChat Settings](../reference/vrchat-settings) component
+to your avatar and disabling the relevant setting.
+
 :::warning
 
 The `MA MMD Layer Control` state machine behavior will only work when attached to the layer directly. Due to how state

docs~/docs/reference/vrchat-settings.md

@@ -0,0 +1,10 @@
+# VRChat Settings
+
+This component allows you to set certain avatar-wide configuration that applies specifically to VRChat.
+It can be placed anywhere on the avatar.
+
+Only one instance of this component can be present on the avatar at a time. If not found, default settings will be used.
+
+## Settings
+
+- **MMD World Support**: Enables special animator handling for MMD worlds. See the documentation on [MMD handling](../general-behavior/mmd) for details.

docs~/i18n/ja/docusaurus-plugin-content-docs/current/general-behavior/mmd.md

@@ -10,6 +10,8 @@ Merge Animatorなどで追加されたレイヤーは、（置換モードでも
 必要に応じて、それらを保護するためのパディングレイヤーが追加されます。MMDワールドの動作で無効化したい場合は、
 `MA MMD Layer Control` という_ステートマシンビヘイビア_を制御したいレイヤーに追加することができます。
 
+また、全体的にこの対応を無効にする場合は、[VRChat Settings](../reference/vrchat-settings)コンポーネントをアバターにつけて、
+該当設置絵を無効にしてください。
 
 :::warning
 

docs~/i18n/ja/docusaurus-plugin-content-docs/current/reference/vrchat-settings.md

@@ -0,0 +1,10 @@
+# VRChat Settings
+
+このコンポーネントを使用すると、VRChatに特有のアバター全体の設定を行うことができます。
+アバターのどこにでも配置できます。
+
+アバターには１個のみ存在できます。見つからない場合、デフォルトの設定が使用されます。
+
+## 設定
+
+- **MMD ワールド対応**: MMDワールド用の特別なアニメーター処理を有効にします。詳細は[MMD処理](../general-behavior/mmd)のドキュメントを参照してください。