🌊 Any Platform
I am releasing Animator As Code V1.
Starting from V1.1.0, all Animator As Code V1 packages are leaving Alpha/Beta.
Animator As Code V1 can now be safely used in public projects that wish to do so.
Animator As Code V1 is designed to be installed even in projects that already have Animator As Code V0.
Animator As Code V0 will not be overwritten by Animator As Code V1. Both installations will act as separate, non-conflicting installs. Projects like FaceEmo will continue to function properly.
In fact Animator As Code V1 has already been extensively used in my own tools (Prefabulous, ComboGestureExpressions, Vixen).
There is no real need to migrate between V0 and V1, if V0 already provides all the functionality you need in your project.
If you choose to migrate, V0 and V1 are almost identical.
// When using Sub-State Machines, the Sub-State Machine will evaluate all transitions until
// it resolves a destination state within one single frame.
// This means it can traverse multiple transition conditions at once, no matter how nested
// the Sub-State Machine is.
//
// This is not doable with just states, so Sub-State Machines have a functional value beyond mere organization.
var a = layer.IntParameter("IntA");
var b = layer.IntParameter("IntB");
var rootSsm = layer.NewSubStateMachine("UsingNestedSubStateMachines");
for (var i = 0; i < 16; i++)
{
// A Sub-State Machine can have other Sub-State Machines created inside them.
// TransitionsFromEntry creates a transition between `subSsm` and the Entry node of the Sub-State Machine it belongs in.
// Exits creates a transition between `subSsm` and the Exit node.
var subSsm = rootSsm.NewSubStateMachine($"A = {i}");
subSsm.TransitionsFromEntry().When(a.IsEqualTo(i));
subSsm.Exits();
for (var j = 0; j < 16; j++)
{
var state = subSsm.NewState($"A = {i} and B = {j}");
state.TransitionsFromEntry().When(b.IsEqualTo(j));
state.Exits()
.When(a.IsNotEqualTo(i))
.Or()
.When(b.IsNotEqualTo(j));
}
}
// This creates a transition between the Sub-State Machine and itself.
// When that Sub-State Machine exits, it will re-enter itself.
rootSsm.Restarts();
// Animator As Code V1 no longer requires VRChat (compared to V0).
// VRChat-specific functions have been moved to extension methods.
// If you want to use VRChat Avatars functionality, add the `Animator As Code V1 - VRChat` package, and do the following:
//
// Add the following import, which contains extension methods:
using AnimatorAsCode.V1.VRC;
// To access VRChat parameters, use the following extension method:
var vrcAv3 = layer.Av3();
// To access VRChat assets, use the following extension method:
var vrcAssets = aac.VrcAssets();
layer.NewState("UsingVRChat")
.WithAnimation(vrcAssets.ProxyForGesture(AacAv3.Av3Gesture.HandOpen, false))
// VRChat State Behaviours are created through extension methods located in namespace `AnimatorAsCode.V1.VRC`
.TrackingAnimates(AacAv3.Av3TrackingElement.RightHand)
.Driving(driver => driver.Sets(layer.BoolParameter("A"), true))
.TransitionsFromEntry()
.When(vrcAv3.GestureRight.IsEqualTo(AacAv3.Av3Gesture.HandOpen));
layer.NewState("BlendTrees").WithAnimation(aac.NewBlendTree()
.FreeformDirectional2D(layer.FloatParameter("X"), layer.FloatParameter("Y"))
.WithAnimation(aac.NewClip("Center"), 0, 0)
.WithAnimation(aac.NewClip("Up"), Vector2.up)
.WithAnimation(aac.NewClip("Right"), 1, 0)
.WithAnimation(aac.NewClip("Down"), 0, -1)
.WithAnimation(aac.NewClip("Left"), -1, 0)
);
var one = layer.FloatParameter("One");
layer.OverrideValue(one, 1f);
layer.NewState("Direct BlendTree").WithAnimation(aac.NewBlendTree()
.Direct()
.WithAnimation(aac.NewClip("DrivenByA"), layer.FloatParameter("A"))
.WithAnimation(aac.NewClip("AlwaysOn"), one)
.WithAnimation(aac.NewBlendTree().Simple1D(layer.FloatParameter("B"))
// In Animator As Code, it is safe to declare points in a Simple1D blend tree in a different order (i.e. 0, 1, -1).
// (In native blend trees, it would not have been safe to do so)
.WithAnimation(aac.NewClip("Zero"), 0)
.WithAnimation(aac.NewClip("Positive"), 1)
.WithAnimation(aac.NewClip("Negative"), -1)
, one)
);
// When creating a new controller, the ContainerMode of the configuration usually needs to be
// set to either `Container.OnlyWhenPersistenceRequired` or `Container.Everything`.
//
// This is because it is not possible to add state behaviours to states unless the Animator Controller
// is already persisted in the asset database.
var controller = aac.NewAnimatorController();
var fx = controller.NewLayer();
AacFlState.Audio(AudioSource or string, ...) function,
which takes a lambda expression as a parameter.AudioSource source = MyAudioSource(); // This can be a string instead.
AudioClip[] clips = MyAudioClips();
layer.NewState("UsingAudio")
.Audio(source, audio =>
{
// Get the PlayAudio object if there's a need to edit it directly.
VRCAnimatorPlayAudio vrcAnimatorPlayAudio = audio.PlayAudio;
// By default, a PlayAudio created through AAC does nothing (unlike a manually created behaviour)
// so you need to invoke anything that is relevant.
audio
.SelectsClip(VRC_AnimatorPlayAudio.Order.Random, clips)
.SetsLooping()
.RandomizesPitch(0.8f, 1.2f)
.RandomizesVolume(0.5f, 1f)
// "Replays" means Stop and Play.
// "StartsPlaying" means just Play.
// "StopsPlaying" means just Stop.
// To do neither Stop nor Play, don't invoke anything.
.StartsPlayingOnEnter()
.StopsPlayingOnExit();
});
AacFlState.Driving(...) function, which takes a lambda expression as a parameter.AacFlState.Driving(...) multiple times, it will create multiple VRCAvatarParameterDriver behaviours on the same state. One may be local, the other not.layer.NewState("UsingDrivers").Driving(driver => driver
.Copies(layer.FloatParameter("CopySource"), layer.FloatParameter("CopyDestination"))
.Sets(layer.FloatParameter("Set"), 2.3f)
.Increases(layer.FloatParameter("IncreaseBy2"), 2f)
.Decreases(layer.FloatParameter("DecreaseBy3"), 3f)
.Randomizes(layer.FloatParameter("Randomizes"), 0f, 100f)
.Randomizes(layer.BoolParameter("RandomizesBool"), 0.25f) // 25% chance of being true.
.Remaps(layer.FloatParameter("RemapsSource"), 0f, 2f, layer.FloatParameter("RemapsDestination"), 2f, 4f)
// This creates a second VRCAvatarParameterDriver in the same state.
).Driving(driver => driver
.Sets(layer.FloatParameter("SecondDriver"), 100f)
.Locally() // Only this second VRCAvatarParameterDriver is local.
);
Using the Animator As Code V1 - Modular Avatar functions, it can create Modular Avatar components.
var ctrl = aac.NewAnimatorController();
var fx = ctrl.NewLayer();
var toggleFloatParameter = fx.FloatParameter("MyToggle");
fx.NewState("BlendTree")
.WithAnimation(aac.NewBlendTree().Simple1D(toggleFloatParameter)
.WithAnimation(aac.NewClip().Toggling(myObject, false), 0)
.WithAnimation(aac.NewClip().Toggling(myObject, true), 1)
)
.WithWriteDefaultsSetTo(true);
// Create a new object in the scene. We will add Modular Avatar components inside it.
var modularAvatar = MaAc.Create(holder);
// By creating a Modular Avatar Merge Animator component,
// our animator controller will be added to the avatar's FX layer.
modularAvatar.NewMergeAnimator(ctrl, VRCAvatarDescriptor.AnimLayerType.FX);
// We use a float in the animator blend tree, but we declare it as a bool
// so that it takes 1 bit in the expression parameters.
// By default, it is saved and synced.
modularAvatar.NewBoolToFloatParameter(toggleFloatParameter).WithDefaultValue(true);
The documentation includes an example on how to integrate with Non-Destructive Modular Framework using a plugin.
Animator As Code V1.1.0 contains breaking changes compared to Animator As Code (Alpha) V1.0.99xx.
This list does not contain the breaking changes between V0 and V1, please see the migration guide for this.
Compared to 1.0.99xx:
Other notes:
These are likely going to be the last breaking change in V1's lifetime.
VRC_SDK_VRCSDK3 scripting define around.
IEditorOnly class only if the VRChat Avatars SDK is installed.VRC_SDK_VRCSDK3 scripting define around.
IEditorOnly class only if the VRChat Avatars SDK is installed.anim:<your search query> may be used in your search query to only show Animation Viewer results.A new knowledge sharing devlog has been published, "Nochat".
In the Nochat research page, you can read about my attempts to run VRChat prefabs with the Unity Editor in VR, without the VRChat SDK installed.
Versions 1.1.0 and 1.1.1 contain errors.
The above changes have been contributed by mekanyanko (めかにゃんこ) (first contribution).
🌊 Any Platform
I am releasing LetMeSee (LMS), a tool that lets you see your content in VR, with the Unity Editor in Edit Mode.
The Scene tab is used as the camera viewpoint. You can use this to fly through avatars and worlds.
This product is released for free.
Using LMS for worlds and level design.
Using LMS for avatars.
Hello,
In February 2022, I had released Animator As Code version 0 (V0).
During 2023, I had started to move towards Animator As Code to version 1 (V1), in order to do the following breaking changes:
My own projects, such as ComboGestureExpressions V3, Vixen, and Prefabulous for VRChat, already use Animator As Code V1.
The project has stalled for long enough, I think it's finally time to give it the last push for release.
One of the goals of Animator As Code V1 is to preserve the ability for V0 and V1 to be installed in the same project, as Animator As Code V0 is currently being used in the wild.
Therefore, installing Animator As Code V1 will not interfere with Animator As Code V0.
Even then, Animator As Code V0 and V1 are almost identical in syntax, so migrating from V0 and V1 should not be a challenge.
Animator As Code V1 will be entering a beta phase before release, which should ideally last a month.
Beta versions of Animator As Code V1 will only be available as pre-release packages, and they may contain breaking changes between two beta versions.
The objective of the Beta is to capture the last inconsistencies in the API, including naming conventions, method signatures, exposed functions and classes, public fields vs public properties, etc. It will also be to complete the documentation, both on this site, and inline documentation.
After Animator As Code V1 comes out of beta in 1.1.0, there should not be any more breaking changes.
AacFlState.Audio(AudioSource or string, ...) function,
which takes a lambda expression as a parameter.AacFlState.Driving(...) function, which takes a lambda expression as a parameter.Fix Assign UV Tile "Entire Mesh" no longer fails to process meshes that were set to EditorOnly.
Hide all Prefabulous icons from the scene in Unity 2022 or above.
This update tries to improve Lightbox Viewer speed in Edit mode, especially in avatar setups where there may be a lot of non-destructive components which have code that runs when that component is destroyed.
There are no speed improvements in Play mode.