AvatarRoot API: Non-VRChat avatar support in VRCSDK projects #71

kaikoga · 2023-10-29T12:27:10Z

Resolves #68, with avatar root detection logic described in the issue.

This is a potentially breaking change for VRCSDK + UniVRM environment. Current Non-VRChat avatar support (implemented in #34) is meant to not break existing NDMF plugins, which targets VRChat avatars only, in all projects including VRCSDK + UniVRM setup. This PR is the breaking part.

Explanation: VRM avatars were not AvatarRoots but would be. NDMF plugins expecting VRChat avatars may try to process VRM avatars, which would fail because VRCAvatarDescriptor does not exist. VRCSDK + UniVRM environment can be created using legacy UniVRM (0.99.4). info

User mitigation: Remove all VRM avatars, or all VRMMeta / Vrm10Instance components, when using VRChat only NDMF plugins in hybrid projects.

bdunderscore · 2023-11-01T10:18:36Z

Hmm. To resolve the compatibility issue, I think I'd prefer to have plugins declare what environments they're compatible with (with "vrchat" being the default). Let me noodle on this a bit and add that API first, before merging this.

bdunderscore · 2023-11-01T10:19:50Z

This will also need tests in a UniVRM environment... I'll have to look into auto-importing unitypackages.

anatawa12 · 2023-11-01T10:55:22Z

I think we should use upm version of univrm for testing since this pr expects upm version of univrm, not unitypackage one.

kaikoga · 2023-11-04T05:43:38Z

If ndmf is going to be aware of environments, perhaps we can warn if VRM version defines are not defined but installation is detected through AppDomain.CurrentDomain.GetAssemblies() (this should indicate a unitypackage installation)

bdunderscore · 2023-11-26T11:49:57Z

Sorry for the lack of replies - I haven't been able to do much development on NDMF/MA over the past few weeks. I'll hopefully be able to spend some more time on it in December.

kaikoga · 2024-01-27T13:11:55Z

Thoughts for this issue:

Theoretically, there may be three types of avatar setup when we want to create an avatar for VRC and VRM.
Which strategy should we support (or recommend)?

Setup as separate avatars

VRCAvatar (VRCDescriptor)
VRMAvatar (VRMMeta)

Pros: Currently available.
Cons: When VRC avatar (or MA outfit) is modified, manual sync to VRM avatar (or MA outfit) by hand.

Conversion plugin

VRCAvatar (VRCDescriptor)
- → some ndmf plugin converts VRC components into VRM counterparts

Pros: Easy.
Cons: Requires development of conversion plugin, which may not be accurate enough or well customizable.

Universal avatar

VRCAvatar (VRCDescriptor) (VRMMeta)
- → some ndmf plugin strips VRM components in VRC builds, vice versa.

Pros: Possible. Proof of concept ( docs_ja component ndmf pass )
Cons: Somewhat bloated avatar.

bdunderscore · 2024-09-01T21:58:05Z

Runtime/RuntimeUtil.cs

@@ -95,8 +101,17 @@ public static string AvatarRootPath(GameObject child)
        public static bool IsAvatarRoot(Transform target)


こちらも要更新？（仮実装です）

ndmf/Editor/PreviewSystem/ComputeContext/SingleObjectQueries.cs

Lines 33 to 44 in 23fa9c4

#if NDMF_VRCSDK3_AVATARS

if (context.GetComponent<VRCAvatarDescriptor>(elem.gameObject) != null)

{

candidate = elem.gameObject;

break;

}

#else

if (context.GetComponent<Animator>(elem.gameObject) != null)

{

candidate = elem.gameObject;

}

#endif

そうかもしれません・・・
NDMF 1.5.0 リリース後に作業を再開する予定でしたが、この機会に全体を見直しておきます。

了解です。

kaikoga · 2024-09-29T23:37:00Z

Runtime/RuntimeUtil.cs

@@ -94,14 +100,23 @@ public static string AvatarRootPath(GameObject child)
        /// <returns></returns>
        public static bool IsAvatarRoot(Transform target)
        {
+            // First, look for platform specific avatar descriptors
+            // TODO: ignore nested avatar descriptors? 


たぶん以下の扱いをちゃんと考えないといけない

VRCAvatarDescriptor の子に Vrm10Instance

VRCAvatarDescriptor をアバターとみなすべき

Vrm10Instance の子に VRCAvatarDescriptor

Vrm10Instance をアバターとみなすべき

Animator の子に VRCAvatarDescriptor / Vrm10Instance

バニラの Animator はアバターではないかもしれない

VRChatプロジェクトだと VRCAvatarDescriptor がアバターっぽく見える

Resoniteアバターがメインターゲットになるなら Animator がアバターになるべきケースもある

その時はたぶん VRCAvatarDescriptor を外してもらった方が良い

FindAvatarsInScene() みたいに全てのアバターかもしれない Animator をリストアップするとエラー UI などが不便になるかもしれない

FindAvatarRoots() は少し賢い

Animator が実は CVRAvatar だったケース

CVRAvatar をアバターとみなしたいけど、上との区別が無理

VRCAvatarDescriptor を外すか、 ndmf が CVRAvatar に対応するか、 AvatarRoot マーカーコンポーネントを定義してつけてもらうか・・・

考えました #432

kaikoga mentioned this pull request Oct 29, 2023

feat: VRM0 / VRM1 support (UniVRM) anatawa12/AvatarOptimizer#651

Open

5 tasks

kaikoga marked this pull request as ready for review October 31, 2023 22:23

kaikoga force-pushed the avatar_root_true_xp branch 2 times, most recently from f724bbe to c26e478 Compare March 3, 2024 08:05

kaikoga mentioned this pull request Mar 4, 2024

chore: Fix non-VRChat support bdunderscore/modular-avatar#731

Merged

kaikoga force-pushed the avatar_root_true_xp branch 2 times, most recently from d9775df to 8e71646 Compare March 16, 2024 23:28

kaikoga force-pushed the avatar_root_true_xp branch from 8e71646 to c34d56c Compare May 4, 2024 13:20

kaikoga force-pushed the avatar_root_true_xp branch from c34d56c to 0e5efef Compare May 12, 2024 20:55

kaikoga added 6 commits August 31, 2024 16:37

add runtime VRM defines and asmdef references

e01ccf7

add test VRM defines and asmdef references

cebd6be

fix avatar root detection

25e047c

really add test VRM defines and asmdef references

10545ea

add changelog

0893781

prevent modification while iteration

3a3bcc1

kaikoga force-pushed the avatar_root_true_xp branch from 0e5efef to 3a3bcc1 Compare August 31, 2024 07:37

bdunderscore reviewed Sep 1, 2024

View reviewed changes

Merge branch 'main' into avatar_root_true_xp

fa1ebb6

kaikoga marked this pull request as draft September 29, 2024 09:33

kaikoga added 2 commits September 30, 2024 08:03

allow generic avatars in VRChat and/or VRM projects

3547fd3

add TODO comment

976dc74

kaikoga commented Sep 29, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AvatarRoot API: Non-VRChat avatar support in VRCSDK projects #71

AvatarRoot API: Non-VRChat avatar support in VRCSDK projects #71

kaikoga commented Oct 29, 2023

bdunderscore commented Nov 1, 2023

bdunderscore commented Nov 1, 2023

anatawa12 commented Nov 1, 2023

kaikoga commented Nov 4, 2023

bdunderscore commented Nov 26, 2023

kaikoga commented Jan 27, 2024

bdunderscore Sep 1, 2024 •

edited

Loading

kaikoga Sep 7, 2024

bdunderscore Sep 14, 2024

kaikoga Sep 29, 2024

kaikoga Oct 1, 2024

		@@ -95,8 +101,17 @@ public static string AvatarRootPath(GameObject child)
		public static bool IsAvatarRoot(Transform target)

	#if NDMF_VRCSDK3_AVATARS
	if (context.GetComponent<VRCAvatarDescriptor>(elem.gameObject) != null)
	{
	candidate = elem.gameObject;
	break;
	}
	#else
	if (context.GetComponent<Animator>(elem.gameObject) != null)
	{
	candidate = elem.gameObject;
	}
	#endif

AvatarRoot API: Non-VRChat avatar support in VRCSDK projects #71

Are you sure you want to change the base?

AvatarRoot API: Non-VRChat avatar support in VRCSDK projects #71

Conversation

kaikoga commented Oct 29, 2023

bdunderscore commented Nov 1, 2023

bdunderscore commented Nov 1, 2023

anatawa12 commented Nov 1, 2023

kaikoga commented Nov 4, 2023

bdunderscore commented Nov 26, 2023

kaikoga commented Jan 27, 2024

Setup as separate avatars

Conversion plugin

Universal avatar

bdunderscore Sep 1, 2024 • edited Loading

Choose a reason for hiding this comment

kaikoga Sep 7, 2024

Choose a reason for hiding this comment

bdunderscore Sep 14, 2024

Choose a reason for hiding this comment

kaikoga Sep 29, 2024

Choose a reason for hiding this comment

kaikoga Oct 1, 2024

Choose a reason for hiding this comment

bdunderscore Sep 1, 2024 •

edited

Loading