https://github.com/leiqiaozhi/easy-text-effects-for-unity

An open-source Unity package for animating TextMeshPro text with customizable effects. Includes ready-to-use samples, real-time previews, and per-vertex animation capabilities.
https://github.com/leiqiaozhi/easy-text-effects-for-unity

game-development text-animation text-effects textmeshpro unity unity-package

Last synced: 3 days ago
JSON representation

An open-source Unity package for animating TextMeshPro text with customizable effects. Includes ready-to-use samples, real-time previews, and per-vertex animation capabilities.

• Host: GitHub
• URL: https://github.com/leiqiaozhi/easy-text-effects-for-unity
• Owner: LeiQiaoZhi
• License: mit
• Created: 2024-12-23T08:34:21.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2025-01-17T01:47:16.000Z (29 days ago)
• Last Synced: 2025-01-29T08:02:39.361Z (17 days ago)
• Topics: game-development, text-animation, text-effects, textmeshpro, unity, unity-package
• Language: C#
• Homepage:
• Size: 22.8 MB
• Stars: 418
• Watchers: 7
• Forks: 25
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


     

    Easy Text Effects for Unity



[![openupm](https://img.shields.io/npm/v/com.qiaozhilei.easy-text-effects?label=openupm&registry_uri=https://package.openupm.com)](https://openupm.com/packages/com.qiaozhilei.easy-text-effects/) [![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE) [![Buy Me a Coffee](https://img.shields.io/badge/Buy%20Me%20a%20Coffee-%23FFDD00.svg?logo=buy-me-a-coffee&logoColor=black)](https://buymeacoffee.com/qiaozhilei)

> **Easily animate TextMeshPro text with stunning, customizable effects!**

**Easy Text Effects** is a free and open-source Unity package that brings life to your text. Whether you're working on games, UI, or interactive experiences, this package provides an intuitive and flexible way to create captivating text animations.

[**📦 Install from GitHub url**](Documentation/Documentation.md#installation)

| ![Combine](Documentation/Images/combine.gif) | ![Entry](Documentation/Images/entry.gif) | ![Customize](Documentation/Images/customize.gif) |

|----------------------------------------------|------------------------------------------|--------------------------------------------------|

## ✨ Features

- **Effortless Setup**: Attach a single component, create effects as ScriptableObjects, and apply with drag-and-drop.

- **Customizable Animations**: Use animation curves and a variety of parameters for unique, fine-tuned effects.

- **Per-Vertex Effects**: Animate individual text vertices for detailed and dynamic visuals.

- **Ready-to-Use Samples**: Kickstart your creativity with a library of pre-made effects.

- **Real-Time Previews**: See your effects in the edit mode.



## 🚀 Quick Start

1. [**Install the package**](Documentation/Documentation.md#installation).

2. Add the **Text Effect Component** to your TextMeshPro object.

3. Create an **Effect ScriptableObject** and configure the parameters.

4. Drag and drop your effect onto the component.

5. See you effect in the edit mode right away!

For detailed steps, visit the [Quick Start Guide](Documentation/Documentation.md#quick-start).



## 📚 Learn More

- [**Simple and Clear Documentation**](Documentation/Documentation.md)

- [**Read Documentation Directly in Inspector!**](Documentation/EmbeddedDocumentation.md)

- [Samples](Documentation/Samples.md)

## 🛠️ Customization

Unleash your creativity with:

- **Animation Curves**: Control timing, speed, and intensity.

- [**Per-Vertex Effects**](Documentation/Documentation.md#per-vertex): Animate individual letters for dynamic text effects.

- [**Combine Effects**](Documentation/Documentation.md#composite): Create complex animations with composite effects.

## ❔ How to ...

- **Typewriter Effect?** Absolutely! See [Tutorial: Typewriter Effect](Documentation/Tutorials/Typewriter.md).

- **Chain animations?** Absolutely! See [Tutorial: Chaining Animations](Documentation/Tutorials/Chain%20Animations.md).

- If you are still unsure after reading the documentation, feel free to ask anywhere (dm, email, issue, etc.).

| Typewriter Effect | Chain Animations |

|----------------------------------------------|------------------------------------------|

| ![Typewriter](Documentation/Images/typewriter.gif) | ![Chain](Documentation/Images/entrydelayexit.gif) | 

## 🤝 Contributing

Found a bug or have a feature request? Open an issue or submit a pull request! Contributions are welcome.

## 📃 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.