Install and Quick Start

Using the asset is a matter of a few clicks (import -> add components -> press play), but to better understand everything please have a look at the following pages, so that you can start even faster and in the right direction.

1. Import Text Animator for Unity

As the very first step, you need to import Text Animator for Unity in your project.

Compatibility Check

The asset works with the following UI and Unity versions:

Text Mesh Pro (Unity 2022.3 and up)
UI Toolkit ().

It also supports the new Unity input system (and the legacy one, too).

Import the Package

Once your project is set up correctly, you can import Text Animator from the Package Manager (Asset Store tab).

Make sure to include the "Samples/BuiltIn" folder, or the asset might not work.

After a succesful installation, the welcome window will show up and Text Animator is ready to animate your texts!

In case the about window doesn't show up, or if you want to seet it later, you can access it anytime from the Menu at Tools/Febucci/TextAnimator/About Window!

2. Example Scenes

You can learn about most Text Animator features directly from the inspector, and see how we've set up things and their direct result from the example scenes.

Start from the scene called "00 - Welcome", or click "Get Started" on Text Animator's welcome window.

To access the example scenes, make sure you have imported them! You can safely remove/delete them once you don't need them anymore, too.

3. Animating your first texts

You can get your texts running in a few clicks!

P.S. Assuming you already know how to use UI Toolkit and what it does.

From the UI Builder

Go to Library -> Project
Drag "AnimatedLabel" from "Custom Controls/Febucci/Text Animator for Unity" in your hierarchy!

We are working to make sure you can animate built in Labels and Buttons from UI toolkit directly! (Unity 6.3 and up.) Stay updated!

Your .uxml should look like this:

Via Code

You can create an instance of the "Febucci.TextAnimatorForUnity.AnimatedLabel" class and add it to your UI document, like this:

using UnityEngine;
using UnityEngine.UIElements;
using Febucci.TextAnimatorForUnity; // <- import Text Animator's namespace

public class ExampleScript : MonoBehaviour
{ 
    [SerializeField] UIDocument document;

    void Start()
    {
        var container = document.rootVisualElement.contentContainer;
        var animatedLabel = new AnimatedLabel(); // <- create an animated label
        container.Add(animatedLabel); // <- add it to the content container
        // [..]
        animatedLabel.SetText("<wave>hello"); // <- set the text
    }
}

You can read Setting up texts for more details and suggestions!

Writing effects in your text

One way to adding effects in your text is using rich text tags, like this: “I'm <shake>freezing</shake>”, where "shake" is an ID for a built-in effect.

Try writing a text by experimenting with the following tags: <wiggle> <shake> <wave> <bounce>, like “<wiggle>I'm joking</wiggle> hehe now <shake>I'm scared</shake>”, then enter Unity’s Play mode.

Your text is animating letters based on the effects you’ve written!

Have fun animating your texts! You can proceed to the next page for a more in-depth look on all the asset's features.