new read me

This commit is contained in:
2026-09-18 13:06:03 +01:00
parent ea45f7ef1a
commit 5851077659
2 changed files with 38 additions and 30 deletions
+33
View File
@@ -0,0 +1,33 @@
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
Instructions to install are available in [this page](https://docs.hai-vr.dev/docs/products/animator-as-code/install).
### 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**.