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. Implement Text Animator

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

Done! We told you that it would have been quick! Your text is now ready for effects.

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

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

When importing the asset, make sure to include the "Example Scenes" and then start from the "00-Welcome!"

You can safely remove/delete the Example Scenes folder when you don't need them anymore! (and reimport again anytime)

3. Animating your first texts

Here’s how to quickly animate your first texts.

Writing effects in your text

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.

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

Showing letters dynamically

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.

Your text is now shown dynamically, like a typewriter.

---

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