modular-avatar/docs~/docs/samples/index.md
bd_ ddbc3b164b
chore: restructure repository to put package at top-level (#477)
* chore: rearrange package structure to have the package at the root

* ci: update CI workflows

* ci: fixing workflow bugs

* ci: recurse building .zip package

* ci: more fixes

* ci: add back in the nadena.dev VPM repo

* ci: fix tests
2023-10-08 15:39:57 +09:00

29 lines
1.3 KiB
Markdown

---
sidebar_position: 3
sidebar_label: Samples
---
# Samples
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](/docs/reference/merge-animator.md)
* Automatically configuring [synced parameters](/docs/reference/parameters.md)
* Setting up [menus](/docs/reference/menu-installer.md).
* Using the [Bone Proxy](/docs/reference/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.