# Install and Quick Start

{% hint style="info" %}
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.
{% endhint %}

### 1. Import Text Animator for Unity <a href="#how-to-implement-text-animator" id="how-to-implement-text-animator"></a>

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

#### Compatibility Check

<mark style="background-color:green;">**The asset works with the following UI and Unity versions**</mark>:

* **Text Mesh Pro** (Unity 2022.3 and up)
* **UI Toolkit** ([Unity 6.3 and up](#user-content-fn-1)[^1]).

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).

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

{% hint style="info" %}
In case the about window doesn't show up, or if you want to see it later, you can access it anytime from the Menu at `Tools/Febucci/TextAnimator/About Window`
{% endhint %}

<figure><img src="/files/0JepsqOw1Q7Tx3XB0ShG" alt="" width="375"><figcaption><p>A part of the Welcome Window, which shows after import</p></figcaption></figure>

### Import the Databases

Make sure you have imported the default effects and actions databases. You should see all their files in the `Assets/Plugins/Febucci/Text Animator for Unity` folders

<figure><img src="/files/XGXq5wHPUKqz80EteEoJ" alt="" width="375"><figcaption></figcaption></figure>

{% hint style="info" %}
In case you do not see default data, or if you want to reset / re-install them, you can always go on the About Window and click "Install Built In Effects" ( or reset them )

![](/files/fUmzvpwtRDCbkuzHUDqN)
{% endhint %}

{% hint style="success" icon="thumbs-up" %}
This way, you can update the asset without worrying that the effects you have edited will be overwritten. Yay!
{% endhint %}

### 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.&#x20;

Make sure you import the **Samples** packages and scenes either from the About window, or the package manager.

{% columns %}
{% column %}

<figure><img src="/files/TKXAZD1LaMZM0ezRRr6l" alt="" width="375"><figcaption><p>you can import the samples scenes from the about window</p></figcaption></figure>

{% endcolumn %}

{% column %}

<figure><img src="/files/wPGZ4r20T8epSnZC2XPv" alt="" width="375"><figcaption><p>you can also import the samples scenes from the Package Manager</p></figcaption></figure>

{% endcolumn %}
{% endcolumns %}

You can start from the scene called "**00 - Welcome**" and the continue with each feature and use case!

{% hint style="success" icon="thumbs-up" %}
You can delete example scenes once you do not need them, and can re-import again anytime you want.
{% endhint %}

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXuXUTa2X5PYuYL6yRvl1%2Fuploads%2FMz4d3PjHJeuB5XSjowp0%2FClipboard-20251115-165101-841.mp4?alt=media&token=b4b87677-6ca5-4a9a-abad-5711119b9562>" %}

## 3. Animating your first texts <a href="#animating-your-first-texts" id="animating-your-first-texts"></a>

You can get your texts running in a few clicks!

{% tabs %}
{% tab title="UI Toolkit" %}
*P.S. Assuming you already know* [*how to use UI Toolkit*](https://docs.unity3d.com/Documentation/Manual/UIElements.html) *and what it does.*

#### From the UI Builder

* Go to Library -> Project
* Drag "<mark style="background-color:yellow;">AnimatedLabel</mark>" from "Custom Controls/Febucci/Text Animator for Unity" in your hierarchy!

{% hint style="info" %}
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!
{% endhint %}

Your .uxml should look like this:

<figure><img src="/files/8HHPDcTTja49pwWKYMbK" alt="" width="302"><figcaption></figcaption></figure>

#### Via Code

You can create an instance of the "<mark style="background-color:yellow;">Febucci.TextAnimatorForUnity.AnimatedLabel</mark>" class and add it to your UI document, like this:

```csharp
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
    }
}
```

{% endtab %}

{% tab title="Text Mesh Pro" %}
*P.S. Assuming you already know* [*how to use Text Mesh Pro*](https://docs.unity3d.com/Packages/com.unity.ugui@2.0/manual/TextMeshPro/index.html) *and how it works.*

Add a <mark style="background-color:yellow;">Text Animator - Text Mesh Pro</mark> component on the same GameObject that has a <mark style="background-color:yellow;">TextMeshPro</mark> component (either UI or world space!):

Your inspector should look like this:

<figure><img src="/files/wWUPYkBcSMyHInFrWB69" alt=""><figcaption></figcaption></figure>
{% endtab %}
{% endtabs %}

{% hint style="success" %}
You can read [Setting up texts](/text-animator-unity/effects/setting-up-texts.md) for more details and suggestions!
{% endhint %}

### Writing effects in your text <a href="#id-1-writing-effects-in-your-text" id="id-1-writing-effects-in-your-text"></a>

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.&#x20;

* 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.

{% embed url="<https://files.gitbook.com/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXuXUTa2X5PYuYL6yRvl1%2Fuploads%2F7y8S1JvFDd8t4bYFdZ4D%2FClipboard-20251115-172643-241.mp4?alt=media&token=de2d715d-e02a-4667-9d0b-66e643e0df55>" %}

{% hint style="success" %}
Your text is animating letters based on the effects you’ve written!
{% endhint %}

***

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

[^1]: Other versions are under consideration/testing! (as they need some important workarounds.) Stay tuned!


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.febucci.com/text-animator-unity/quick-start/install-and-quick-start.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.