From bacb16f17dc4b981406e43e74af5869490f497fc Mon Sep 17 00:00:00 2001 From: bd_ Date: Mon, 12 May 2025 21:29:44 -0700 Subject: [PATCH] chore(docs): small changes to resonite docs --- .../experimental-features/resonite-support.md | 21 +++++++++++-------- .../experimental-features/resonite-support.md | 20 ++++++++++-------- 2 files changed, 23 insertions(+), 18 deletions(-) diff --git a/docs~/docs/experimental-features/resonite-support.md b/docs~/docs/experimental-features/resonite-support.md index 579626bb..0b72980b 100644 --- a/docs~/docs/experimental-features/resonite-support.md +++ b/docs~/docs/experimental-features/resonite-support.md @@ -8,6 +8,9 @@ To build an avatar for resonite, open the NDMF Console (Tools -> NDM Framework - If all goes well, you'll see a "Build finished!" message. You can then either "copy to clipboard", and then hit Ctrl-V in resonite, or click "Save as..." to save the avatar as a `resonitepackage` file. The resonite build process will automatically copy certain avatar features, such as visemes, eye position, and physbones/dynamic bones to the Resonite avatar. +If you've already set up your avatar for VRChat, no additional configuration is needed. If your avatar is not set up +for VRChat, or if you don't have the VRCSDK installed, refer to the documentation on [portable avatar components](./portable-avatar-components.md) +for more information on how to set up your avatar. ## Supported features @@ -53,7 +56,7 @@ The resonite build process will automatically copy certain avatar features, such Modular Avatar will detect dynamic bones created using either [Portable Dynamic Bones](./portable-avatar-components#portable-dynamic-bones) or VRChat's PhysBones, and attempt to convert them to Resonite's dynamic bones, including any colliders. Since Resonite has its own dynamic bone system, most configuration options are not converted. -However, exclusions (including Physbone Blockers), colliders, and collision radius are converted. +However, exclusions (including Physbone Blockers), colliders, collision radius, and grabbability are converted. Modular Avatar will group Dynamic Bones into a number of named "templates" based on their bone names. You can override the template name by either adding a portable dynamic bone component with a group name specified. Alternately, in resonite, you can create a new template by cloning an object under the `Avatar Settings` -> `Dynamic Bone Settings` Slot, setting its name to the new template name, and then changing the name found on the `Template Name` slot underneath the slot that defined the dynamic bone. @@ -76,15 +79,15 @@ Modular Avatar defines a number of default Dynamic Variables that can be used by Some of these dynvars are still somewhat experimental, and may change in the future. -| Name | Type | Description | -| ---- | ---- | ----------- | -| `modular_avatar/AvatarRoot` | `Slot` | The root slot of the avatar (parent of `CenteredRoot`) | -| `modular_avatar/AvatarWorn` | `bool` | Whether the avatar is currently worn (detected by the avatar being a direct child of the User slot) | -| `modular_avatar/AvatarSettingsRoot` | `Slot` | The `Avatar Settings` object | +| Name | Type | Description | +|----------------------------------------| ---- | ----------- | +| `modular_avatar/AvatarRoot` | `Slot` | The root slot of the avatar (parent of `CenteredRoot`) | +| `modular_avatar/AvatarWorn` | `bool` | Whether the avatar is currently worn (detected by the avatar being a direct child of the User slot) | +| `modular_avatar/AvatarSettingsRoot` | `Slot` | The `Avatar Settings` object | | `modular_avatar/AvatarPoseNode.[type]` | `Slot` | The Slot containing the `AvatarPoseNode` component for node `[type]` (e.g. `Head Proxy`) | -| `modular_avatar/MeshNotLoaded` | `bool` | _False_ if there are any unloaded meshes in the avatar, _missing_ otherwise. _This dynvar is subject to change in the future._ | -| `modular_avatar/BoneRef_[name]` | `Slot` | References a humanoid bone by name. _Name is subject to change in the future._ | -| `modular_avatar/BonePose_[name]` | `float4x4` | The initial pose of the bone referenced by `BoneRef_[name]`. _Name is subject to change in the future. Values might not be quite correct yet._ | +| `modular_avatar/MeshNotLoaded` | `bool` | _False_ if there are any unloaded meshes in the avatar, _missing_ otherwise. _This dynvar is subject to change in the future._ | +| `modular_avatar/HumanBone.[name]` | `Slot` | References a humanoid bone by name. _Name is subject to change in the future._ | +| `modular_avatar/HumanBonePose.[name]` | `float4x4` | The initial pose of the bone referenced by `BoneRef_[name]`. _Name is subject to change in the future. Values might not be quite correct yet._ | Additionally, an `Avatar` Dynamic Variable Space is created on the avatar root for use by other gimmicks. diff --git a/docs~/i18n/ja/docusaurus-plugin-content-docs/current/experimental-features/resonite-support.md b/docs~/i18n/ja/docusaurus-plugin-content-docs/current/experimental-features/resonite-support.md index e7a09027..e50e8e19 100644 --- a/docs~/i18n/ja/docusaurus-plugin-content-docs/current/experimental-features/resonite-support.md +++ b/docs~/i18n/ja/docusaurus-plugin-content-docs/current/experimental-features/resonite-support.md @@ -8,6 +8,8 @@ Resonite向けのアバターをビルドするには、NDMFコンソール (Too その後、「copy to clipboard」をクリックして、resoniteでCtrl-Vを押すか、「Save as...」をクリックして、アバターを`resonitepackage`ファイルとして保存できます。 Resoniteのビルドプロセスは、ビルド中にアバターの特定の機能（ビジュアル、目の位置、物理ボーン/ダイナミックボーンなど）を自動的にコピーします。 +すでにVRChat向けにアバターを設定している場合は、追加の設定は必要ありません。 +VRChat向けにアバターを設定していない場合や、VRCSDKがインストールされていない場合は、[Portable Avatar Components](./portable-avatar-components.md)のドキュメントを参照して、アバターの基本設定を行ってください。 ## 現在対応している機能 @@ -52,7 +54,7 @@ Resoniteのビルドプロセスは、ビルド中にアバターの特定の機 Modular Avatarは、[Portable Dynamic Bones](./portable-avatar-components#portable-dynamic-bones)またはVRChatのPhysBonesを使用して作成されたダイナミックボーンを検出し、コライダー設定を含めてResoniteのダイナミックボーンに変換しようとします。 -Resoniteには独自のダイナミックボーンシステムがあるため、ほとんどの設定オプションは変換されません。ただし、除外（Physbone Blockersを含む）、コライダー、および衝突範囲は変換されます。 +Resoniteには独自のダイナミックボーンシステムがあるため、ほとんどの設定オプションは変換されません。ただし、除外（Physbone Blockersを含む）、コライダー、衝突範囲および掴めるかの設定は変換されます。 Dynamic Bonesは、ボーン名に基づいて、いくつかの名前付き「テンプレート」にグループ化されます。テンプレート名は、ポータブルダイナミックボーンコンポーネントにグループ名を指定することで上書きできます。 または、Resoniteで、`Avatar Settings` -> `Dynamic Bone Settings` スロットの下にあるオブジェクトをクローンし、新しいテンプレート名に設定し、ダイナミックボーンを定義したスロットの下にある`Template Name`スロットの名前を変更することで、新しいテンプレートを作成できます。 @@ -73,15 +75,15 @@ Modular Avatarは、アバターシステムで使用できるいくつかのDyn 自動追加されるDynVarの仕様は、現在実験的なものも含まれるため、将来的に変更される可能性があります。 -| 名前 | 型 | 詳細 | -| ---- | ---- | ----------- | -| `modular_avatar/AvatarRoot` | `Slot` | アバターのルートスロット（`CenteredRoot`の親） | -| `modular_avatar/AvatarWorn` | `bool` | アバターが現在着用されているかどうか（アバターがUserスロットの直下にある場合に検出） | -| `modular_avatar/AvatarSettingsRoot` | `Slot` | `Avatar Settings`オブジェクト | +| 名前 | 型 | 詳細 | +|----------------------------------------| ---- | ----------- | +| `modular_avatar/AvatarRoot` | `Slot` | アバターのルートスロット（`CenteredRoot`の親） | +| `modular_avatar/AvatarWorn` | `bool` | アバターが現在着用されているかどうか（アバターがUserスロットの直下にある場合に検出） | +| `modular_avatar/AvatarSettingsRoot` | `Slot` | `Avatar Settings`オブジェクト | | `modular_avatar/AvatarPoseNode.[type]` | `Slot` | | `[type]`の`AvatarPoseNode`コンポーネントを含むスロット（例：`Head Proxy`） | -| `modular_avatar/MeshNotLoaded` | `bool` | アバターのメッシュが読み込まれていないかどうか。なお、この変数は読み込み途中のメッシュがある場合「false」になり、ない場合は「未定義」になるので注意。この仕様は将来的に変更される可能性が高いのでご注意ください | -| `modular_avatar/BoneRef_[name]` | `Slot` | ヒューマノイドボーンを名前で参照します。名義は今後変更される可能性があります。 | -| `modular_avatar/BonePose_[name]` | `float4x4` | 該当するボーンの初期ポーズです。_名前・内容の調整が入る可能性が高い機能です。| +| `modular_avatar/MeshNotLoaded` | `bool` | アバターのメッシュが読み込まれていないかどうか。なお、この変数は読み込み途中のメッシュがある場合「false」になり、ない場合は「未定義」になるので注意。この仕様は将来的に変更される可能性が高いのでご注意ください | +| `modular_avatar/HumanBone.[name]` | `Slot` | ヒューマノイドボーンを名前で参照します。名義は今後変更される可能性があります。 | +| `modular_avatar/HumanBonePose.[name]` | `float4x4` | 該当するボーンの初期ポーズです。_名前・内容の調整が入る可能性が高い機能です。| なお、ほかのギミック用に、アバタールートに「Avatar」のDynamic Variable Spaceも生成されます。