> For the complete documentation index, see [llms.txt](https://docs.febucci.com/text-animator-unity/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.febucci.com/text-animator-unity/3.x-zh/kuai-su-ru-men/an-zhuang-yu-kuai-su-ru-men.md).

# 安装与快速入门

{% hint style="info" %}
使用该资源只需几次点击（导入 -> 添加组件 -> 按播放），但为了更好地理解所有内容，请查看以下页面，这样你可以更快且朝着正确的方向开始。
{% endhint %}

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

第一步，你需要在项目中导入 Text Animator for Unity。

#### 兼容性检查

<mark style="color:默认;background-color:green;">**该资源兼容以下 UI 与 Unity 版本**</mark>:

* **Text Mesh Pro** （Unity 2022.3 及更高版本）
* **UI Toolkit** ([Unity 6.3 及更高版本](#user-content-fn-1)[^1]).

它还支持新的 Unity 输入系统（也支持旧版）。

#### 导入包

在项目正确设置后，你可以从包管理器（Asset Store 选项卡）导入 Text Animator。

安装成功后， **欢迎窗口** 会出现，Text Animator 就可以开始为你的文本制作动画了！

{% hint style="info" %}
如果关于窗口没有弹出，或者你想稍后查看，你可以随时从菜单访问： `Tools/Febucci/TextAnimator/About Window`
{% endhint %}

<figure><img src="/files/9e67853a1beea015e3402da354df782a5ede4956" alt="" width="375"><figcaption><p>导入后显示的欢迎窗口的一部分</p></figcaption></figure>

### 导入数据库

确保你已导入默认的效果和动作数据库。你应该能在以下位置看到它们的所有文件： `Assets/Plugins/Febucci/Text Animator for Unity` 文件夹

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

{% hint style="info" %}
如果你未看到默认数据，或想重置/重新安装它们，你可以随时在关于窗口中点击“Install Built In Effects”（或重置它们）

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

{% hint style="success" icon="thumbs-up" %}
这样，你可以更新资源而不用担心已编辑的效果会被覆盖。太棒了！
{% endhint %}

### 2. 示例场景

你可以直接从检查器中了解大多数 Text Animator 功能，并通过示例场景查看我们如何设置以及它们的直接效果。&#x20;

确保你已导入 **样例** 包和场景，可以从关于窗口或包管理器导入。

{% columns %}
{% column %}

<figure><img src="/files/b12dd9a6c7fe6f11a37c8115431bb88de5c97a05" alt="" width="375"><figcaption><p>你可以从关于窗口导入样例场景</p></figcaption></figure>

{% endcolumn %}

{% column %}

<figure><img src="/files/c9bc5bb9adf5f8233827bc313e455f9bafb83bcc" alt="" width="375"><figcaption><p>你也可以从包管理器导入样例场景</p></figcaption></figure>

{% endcolumn %}
{% endcolumns %}

你可以从名为 “**00 - Welcome**” 的场景开始，然后继续学习每个功能和使用场景！

{% hint style="success" icon="thumbs-up" %}
不需要示例场景时可以删除它们，并且随时可以重新导入。
{% 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. 为你的第一个文本制作动画 <a href="#animating-your-first-texts" id="animating-your-first-texts"></a>

你可以在几次点击内让文本开始运行！

{% tabs %}
{% tab title="UI Toolkit" %}
*附注：假设你已经知道* [*如何使用 UI Toolkit*](https://docs.unity3d.com/Documentation/Manual/UIElements.html) *以及它的功能。*

#### 从 UI Builder

* 转到 库 -> 项目
* 拖动 "<mark style="color:默认;background-color:yellow;">AnimatedLabel</mark>" 从 “Custom Controls/Febucci/Text Animator for Unity” 到你的层级结构中！

{% hint style="info" %}
我们正在努力确保你可以直接在 UI Toolkit 中为内置的 Label 和 Button 添加动画！ *（适用于 Unity 6.3 及以上。）*  保持关注！
{% endhint %}

你的 .uxml 应该看起来像这样：

<figure><img src="/files/9d9dcee98e6dbdd40207c905e43e4d9936763443" alt="" width="302"><figcaption></figcaption></figure>

#### 通过代码

你可以创建一个 "<mark style="color:默认;background-color:yellow;">Febucci.TextAnimatorForUnity.AnimatedLabel</mark>" 类的实例并将其添加到你的 UI 文档中，像这样：

```csharp
using UnityEngine;
using UnityEngine.UIElements;
using Febucci.TextAnimatorForUnity; // <- 导入 Text Animator 的命名空间

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

    void Start()
    {
        var container = document.rootVisualElement.contentContainer;
        var animatedLabel = new AnimatedLabel(); // <- 创建一个 animated label
        container.Add(animatedLabel); // <- 将其添加到内容容器中
        // [..]
        animatedLabel.SetText("<wave>hello"); // <- 设置文本
    }
}
```

{% endtab %}

{% tab title="Text Mesh Pro" %}
*附注：假设你已经知道* [*如何使用 Text Mesh Pro*](https://docs.unity3d.com/Packages/com.unity.ugui@2.0/manual/TextMeshPro/index.html) *以及它如何工作。*

添加一个 <mark style="color:默认;background-color:yellow;">文本动画器 - Text Mesh Pro</mark> 组件到同一个具有 <mark style="color:默认;background-color:yellow;">TextMeshPro</mark> 组件（UI 或世界空间！）：

你的检视器应如下所示：

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

{% hint style="success" %}
你可以阅读 [设置文本](/text-animator-unity/3.x-zh/xiao-guo/she-zhi-wen-ben.md) 以获取更多细节和建议！
{% endhint %}

### 在文本中书写效果 <a href="#id-1-writing-effects-in-your-text" id="id-1-writing-effects-in-your-text"></a>

向文本添加效果的一种方式是使用富文本标签，例如：“`I'm <shake>freezing</shake>`”，其中 “shake” 是内置效果的 ID。&#x20;

* 尝试通过实验以下标签来编写文本： `<wiggle>` `<shake>` `<wave>` `<bounce>`，例如 “`<wiggle>I'm joking</wiggle> hehe now <shake>I'm scared</shake>`” 然后进入 Unity 的播放模式。

{% 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" %}
你的文本会根据你写的效果对字母进行动画处理！
{% endhint %}

***

祝你玩得开心！你可以继续查看下一页，以更深入地了解该资源的所有功能。

[^1]: 其他版本正在考虑/测试中！（因为它们需要一些重要的变通方法。）敬请关注！