# Quick Start

You can get started with Text Animator for Godot in very few simple steps. To get a better understanding of the tool's fundamentals, here is how to get started to animatae your texts:

## 1. Import Text Animator

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

1. Import the "**Text Animator**" zip content in your project base folder, you will see two plugins.
2. Build the project once and activate first `EditorUtils` and then `TextAnimator` (in this order).
3. After enabling both plugins, build again and restart your godot project.

## 2. Start animating

1. Add a `RichTextLabel` in your scene.
2. Add a `TextAnimator` node as a child.

Your scene tree should look like this:

<figure><img src="/files/TqwyhTdVqFmpxrmeB1xF" alt=""><figcaption></figcaption></figure>

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

{% hint style="warning" %}
P.S. Please make sure to have the `TextAnimator` node as a child of the RichTextLabel you want to control.
{% endhint %}

## 3. Example Scenes

{% hint style="info" %}
When importing the asset, you can include and have a look at the "Example Scenes". If you do, please start from the "00-Welcome!"
{% endhint %}

<figure><img src="/files/fwZPzUW3Ux55C7DaAF96" alt=""><figcaption></figcaption></figure>

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

## 3. Animating your first texts

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.

## 4. 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 Node with the `TypewriterByCharacter` script, as a child of the same RichTextLabel node.
* Bind the TextAnimator node to the Typewriter through the inspector

{% hint style="success" %}
Your text is animating letters based on the effects you’ve written, and it's also ready to display characters one after another!
{% endhint %}


---

# 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-godot/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.
