|
| 1 | +## MojoUnity-TextPro v1.0 |
| 2 | + |
| 3 | +**MojoUnity-TextPro** is a **Extension** of **UGUI Text** which can mix **texts** and **images** as well as attach **events**. |
| 4 | + |
| 5 | +* The current `unitypackage`, **packaged** by `Unity-2020.3`, **tested** on `Unity-2018.4`, and **supported** Unity versions are `2018.4 or higher`. |
| 6 | +* Released versions in [releases](https://github.com/scottcgi/MojoUnity-Packages/releases). |
| 7 | +* Release changes in [ChangeLog](./ChangeLog.md). |
| 8 | + |
| 9 | +Quick **goto** the [Samples Code](./Src/MojoUnity/Samples/MojoUnityTextPro/Scripts/) and the [Source Code](./Src/MojoUnity/Scripts/Modules/UI). |
| 10 | + |
| 11 | +## Note |
| 12 | + |
| 13 | +The **source code** depends on the `Unity UI`, which can be found and installed by `Package Manager` in the Unity menu `Window/Package Manager`. |
| 14 | + |
| 15 | +## Features |
| 16 | + |
| 17 | +* Mix Text-Image with Event by **Efficient** algorithm. |
| 18 | +* Serialize **Image** and **Event** dictionaries in Inspector. |
| 19 | +* Custom **Image-Event** tag in Text. |
| 20 | +* Simple **API** easy to use. |
| 21 | + |
| 22 | +## Use Cases |
| 23 | + |
| 24 | +* Custom **tag** in Text. |
| 25 | +  |
| 26 | + |
| 27 | +* Image **dictionay** in Inspector. |
| 28 | +  |
| 29 | + |
| 30 | +* Event **dictionay** in Inspector. |
| 31 | +  |
| 32 | + |
| 33 | +* Play **Image-Text-Event** in Unity. |
| 34 | +  |
| 35 | + |
| 36 | +## Quick Start |
| 37 | + |
| 38 | +1. Open the `MojoUnityTextPro` Scene in `/MojoUnity/Samples/MojoUnityTextPro/Scenes/MojoUnityTextPro.unity`. |
| 39 | +2. Click the `Text-Image-Event` GameObject, which is child of `Samples` GameObject, in `Unity Hierarchy`. |
| 40 | +3. Click the `Play` button in `Unity Game Window`. |
| 41 | +4. View the settings of `TextPro` and `TextProQuad` in `Text-Image-Event` GameObject. |
| 42 | +5. View the Sample Code in `/MojoUnity/Samples/MojoUnityTextPro/Scripts/TextProQuadEvent.cs`. |
| 43 | + |
| 44 | +Note: If the `image tag` is not replaced correctly in PlayMode, please check whether the `Serialization Dict` setting is right in `Inspector`. |
| 45 | + |
| 46 | +## Issues & Discussions |
| 47 | + |
| 48 | +* Any bugs can go to [[MojoUnity-TextPro Issues]](https://github.com/scottcgi/MojoUnity-Packages/labels/MojoUnity-TextPro) for feedback. |
| 49 | +* Any questions or comments can go to [[MojoUnity-TextPro Discussions]](https://github.com/scottcgi/MojoUnity-Packages/discussions/categories/mojounity-textpro) for exchange. |
0 commit comments