Make your components compatible with Avatar Optimizer #

This page describes the following two things.

• When can components be incompatible with Avatar Optimizer?
• How to improve the compatibility?

If you have some question, please feel free to ask @[email protected] on fediverse.

When can components be incompatible with Avatar Optimizer? #

If your components are on the avatar and still exist when Avatar Optimizer processes it, your components can be incompatible with Avatar Optimizer.

Since Avatar Optimizer has Garbage Collection system for Components and others, Avatar Optimizer has to know about all existing components in the Avatar at the optimization.

To avoid problem with unknown components, Avatar Optimizer currently assumes unknown components

• have some side-effects.
• will have dependency relationship to all components referenced in the component. (They can be changed in the future.)

However, the assumption can be incorrect, so Avatar Optimizer will generate the following warning.

How to improve the compatibility? #

Please remove your components before Avatar Optimizer processes as much as possible. If you cannot remove some components, please register them to Avatar Optimizer.

Since Avatar Optimizer v1.7.0, Asset Description is added for components that doesn’t process on build or at runtime. If your tool process nothing at build time, you can use this to register your components.

If your tool process something at build time, registering with Asset Description is not recommended. This prevents Avatar Optimizer from accidentally removing components and causing your tool to not work properly when the processes execution order is unexpected/incorrect.

Removing your components #

You can remove your components with several ways.

If your tool is a non-destructive tool based on NDMF¹, removing your components before the Optimizing phase or before com.anatawa12.avatar-optimizer plugin (with BeforePlugin) in the Optimizing phase is recommended.

If your tool is a non-destructive tool not based on NDMF¹, removing your components before the NDMF’s Optimizing phase is recommended. In this case, current NDMF executes Optimizing phase in order -1025, which is JUST before VRCSDK’s RemoveAvatarEditorOnly callback, so your tool should remove components with IVRCSDKPreprocessAvatarCallback with smaller callbackOrder.

If your components holds some information for your tool and has no meaning on the build time, removing your components before Avatar Optimizer processes with IVRCSDKPreprocessAvatarCallback is recommended. See above for the ordering of IVRCSDKPreprocessAvatarCallback.

Registering your components #

If your tool wants to keep your component after Avatar Optimizer processes, you can register your components to Avatar Optimizer to tell about your components.

First, to call APIs of Avatar Optimizer, please make an assembly definition file² if your tool doesn’t have.

Next, add com.anatawa12.avatar-optimizer.api.editor to assembly references in asmdef file.
If your tool doesn’t want to depends on Avatar Optimizer, please use Version Defines. Because Avatar Optimizer didn’t have public API prior to 1.6.0 and will break in 2.0.0, it’s recommended to add version range like [1.6,2.0) (or stricter like [1.7,2.0) when you need new APIs that can be available in the future).

Then, define ComponentInformation for your component in your assembly.

#if AVATAR_OPTIMIZER && UNITY_EDITOR

[ComponentInformation(typeof(YourComponent))]
internal class YourComponentInformation : ComponentInformation<YourComponent>
{
    protected override void CollectMutations(YourComponent component, ComponentMutationsCollector collector)
    {
        // call methods on the collector to tell about the component
    }

    protected override void CollectDependency(YourComponent component, ComponentDependencyCollector collector)
    {
        // call methods on the collector to tell about the component
    }
}

#endif

In CollectMutations, you should register any mutation your component may do.
In CollectDependency, you should register build-time or run-time dependencies of your component.
Please refer xmldoc and method name for more datails.