diff --git a/docs/docs/reference/bone-proxy.md b/docs/docs/reference/bone-proxy.md index ecc161b7..70005dcc 100644 --- a/docs/docs/reference/bone-proxy.md +++ b/docs/docs/reference/bone-proxy.md @@ -3,7 +3,7 @@ ![Bone Proxy](bone-proxy-compare.png) The Bone Proxy allows you to place objects from your prefab inside of objects that are part of the original avatar. -For example, in the Clap sample, this is used to place contacts inside the avatar's hands. +For example, in the [Clap sample](../samples/#clap), this is used to place contacts inside the avatar's hands. Bone Proxy will also adjust any animators referencing the old location of the objects so that they reference the new paths after the objects are moved. diff --git a/docs/docs/reference/merge-animator.md b/docs/docs/reference/merge-animator.md index 3872d08c..bebec213 100644 --- a/docs/docs/reference/merge-animator.md +++ b/docs/docs/reference/merge-animator.md @@ -4,7 +4,7 @@ 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. -Two samples are included that use this component: A hand-clap effect, and a finger-pen gimmick. +[Two samples](../samples/) are included that use this component: A hand-clap effect, and a finger-pen gimmick. ## When should I use it? diff --git a/docs/docs/samples/index.md b/docs/docs/samples/index.md index ef8ff3a5..2a094407 100644 --- a/docs/docs/samples/index.md +++ b/docs/docs/samples/index.md @@ -5,4 +5,25 @@ sidebar_label: Samples # Samples -Modular Avatar comes with a few sample prefabs to demonstrate its features. +Modular Avatar comes with a few sample prefabs to demonstrate its features. These can be found under "Packages -> Modular Avatar -> Samples" in your project window. + +![Samples](wheretofind.png) + +## Fingerpen + +The fingerpen prefab is a useful pen that can be used anywhere. +Simply drop it onto your avatar, then click the "Select Menu" button in the menu installer component, and double-click the menu you want to install the fingerpen controls to. + +The fingerpen prefab demonstrates: + +* Installing animators using [Merge Animator](../reference/merge-animator.md) +* Automatically configuring [synced parameters](../reference/parameters.md) +* Setting up [menus](../reference/menu-installer.md). +* Using the [Bone Proxy](bone-proxy.md) component to place objects inside of the avatar's bones, in an avatar-agnostic way + +## Clap + +By dragging the Clap prefab onto your avatar, when you bring your hands together, you'll hear a clap sound effect, and some particles will spawn. +As with fingerpen, click the select menu button to select where to put the on/off switch. + +In addition to everything demonstrated in the fingerpen prefab, the clap sample also shows off using internal parameters with Contact Receivers to avoid parameter clashes with other components. \ No newline at end of file diff --git a/docs/docs/samples/wheretofind.png b/docs/docs/samples/wheretofind.png new file mode 100644 index 00000000..05ab7cc2 Binary files /dev/null and b/docs/docs/samples/wheretofind.png differ