36 lines
2.4 KiB
Markdown
36 lines
2.4 KiB
Markdown
Animator As Code V1
|
|
====
|
|
|
|
**Animator As Code** is a small Unity Editor facility to generate Animator layers and animations from a [fluent builder](https://en.wikipedia.org/wiki/Fluent_interface) syntax written in C#.
|
|
|
|
Describing your animators as code provides the following advantages:
|
|
|
|
- you do not need to edit your animations by hand every time you add remove or change the location of a component in your hierarchy
|
|
- you will not need to edit a hundred transitions by hand if you need to rectify your animator
|
|
|
|
Initially designed for use in VRChat to create Avatars 3.0 animator controllers, this is now a generic package that does not require it.
|
|
|
|
https://user-images.githubusercontent.com/60819407/157751278-475538c7-3310-4fa5-9a87-3651c85eaa1c.mp4
|
|
|
|
Initially created by **[@hai-vr](https://github.com/hai-vr)**,
|
|
- with major contributions from **[@galister](https://github.com/galister)** for supporting sub-state machines and the generic use of nodes and parameters.
|
|
|
|
## Installation
|
|
|
|
If you are using Animator As Code in VRChat, install using the VRChat Creator Companion or ALCOM. Instructions are available in [this page](https://docs.hai-vr.dev/docs/products/animator-as-code/install).
|
|
|
|
Otherwise, if you are **not** using VRChat, you may install it through the [Releases](https://github.com/hai-vr/av3-animator-as-code/releases), or install it through the Unity Package Manager by adding the git url `https://github.com/hai-vr/av3-animator-as-code.git?path=/Packages/dev.hai-vr.animator-as-code.v1`, or updating your `Packages/manifest.json` directly by adding the line `"dev.hai-vr.animator-as-code.v1": "https://github.com/hai-vr/av3-animator-as-code.git?path=/Packages/dev.hai-vr.animator-as-code.v1"`.
|
|
|
|
### Documentation
|
|
|
|
- [Documentation](https://docs.hai-vr.dev/docs/products/animator-as-code)
|
|
- [V1 Reference manual](https://docs.hai-vr.dev/docs/products/animator-as-code/reference)
|
|
- [V1 Functions reference](https://docs.hai-vr.dev/docs/products/animator-as-code/functions/base)
|
|
- [VRChat reference](https://docs.hai-vr.dev/docs/products/animator-as-code/functions/vrchat)
|
|
- [VRChat (Destructive Workflow) reference](https://docs.hai-vr.dev/docs/products/animator-as-code/functions/vrchat-destructive-workflow)
|
|
- [Modular Avatar As Code reference](https://docs.hai-vr.dev/docs/products/animator-as-code/functions/modular-avatar)
|
|
|
|
## Animator As Code V0
|
|
|
|
- You can browse the repository in its **[V0](https://github.com/hai-vr/av3-animator-as-code/tree/V1-2022-04) state**.
|