diff --git a/README.md b/README.md index ba331e4..bf00ce4 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,8 @@ -Animator As Code V1 -==== +## Animation As Crab -**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#. +This is a hard fork of https://github.com/hai-vr/av3-animator-as-code +We will be using [rhai](https://rhai.rs/) for writing animation controllers instead of C# -Describing your animators as code provides the following advantages: +the idea is, (rhai + rust) will output a big eval'd json file that the C# side will parse and generate a native unity animation controller from. -- 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**. +Original Creator is [hai-vr](https://github.com/hai-vr) diff --git a/old_README.md b/old_README.md new file mode 100644 index 0000000..ba331e4 --- /dev/null +++ b/old_README.md @@ -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**.