# 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. Implement Text Animator <a href="#how-to-implement-text-animator" id="how-to-implement-text-animator"></a>

As the first step, you need to implement Text Animator in your project.

1. **Import the Text Mesh Pro package** (if not present):\
   Browse the Project manager *(Unity → Window/PackageManager),* download and install the package named *TextMeshPro.*
2. **Import the "Text Animator" package**
3. **Add a TextAnimator\_TMP Component** on the same GameObject that has a `TextMeshPro Text` component.

The inspector should look like this (*you can also use TextMeshPro 3D text component instead*):

<div data-full-width="false"><img src="/files/a570S84JNxiJTm0TgJDi" alt=""></div>

{% hint style="success" %}
*Done! We told you that it would have been quick!*\
Your text is now ready for effects.
{% endhint %}

{% hint style="danger" %}
*P.S. If you already have an external typewriter component, please remove it or it might conflict with the plugin.*

You can read more about supported third parties assets here: [Integrated Plugins & Dialogues Systems](/text-animator-unity/2.x/integrations/integrated-plugins-and-dialogues-systems.md)
{% 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 (of course, this documentation includes all of them in detail plus extra customization and tips - don't miss them!).

{% hint style="info" %}
When importing the asset, make sure to include the "Example Scenes" and then start from the "00-Welcome!"
{% endhint %}

<div data-full-width="true"><img src="/files/LbSngiydDWQ4wqPxUKid" alt=""></div>

{% hint style="info" %}
You can safely remove/delete the Example Scenes folder when you don't need them anymore! (and reimport again anytime)
{% endhint %}

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

Here’s how to quickly animate your first texts.

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

To add effects in your text, you can use 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.

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

### Showing letters dynamically <a href="#id-2-showing-letters-dynamically" id="id-2-showing-letters-dynamically"></a>

To show letters dynamically (like a typewriter):

* Add a `TypewriterByCharacter` component on the same GameObject. *(In Unity’s Edit Mode)*
* Tell TextAnimator that you want to use the typewriter. For now, let’s do it the **super simple** way:\
  On the TextAnimator\_TMP component, set “Typewriter Starts Automatically” value to **true**. Then enter Play mode.

{% hint style="success" %}
Your text is now shown dynamically, like a typewriter.&#x20;
{% 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.


---

# 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/2.x/welcome/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.
