Skip to content

Commit 4dec2e1

Browse files
authored
Update README.md
1 parent c0faf85 commit 4dec2e1

File tree

1 file changed

+53
-7
lines changed

1 file changed

+53
-7
lines changed

README.md

Lines changed: 53 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,23 +38,65 @@ TMPEffects allows you to easily apply all kinds of effects to your TextMeshPro t
3838

3939
- **Many other features (timeline integration, keyword databases, ...)**
4040

41-
## Built-in animations
41+
42+
<br><br/>
43+
The rest of this README gives just a quick overview of TMPEffects, you definitely should refer to [the manual](https://tmpeffects.luca3317.dev/manual/introduction.html) when questions come up!
44+
45+
## Built-in animations (+ commands)
4246
TMPEffects comes with a lot of built-in animations (most of which are really versatile when using tag parameters):
43-
<div valign="middle" style="border: none;" align="center"><br>
44-
<img src="/gifs/overview.gif" width=100% height=auto />
47+
<div style="display:flex;justify-content:center;align-items:center;">
48+
<img src="/gifs/basic-overview.gif" width="80%"/>
4549
</div>
46-
![til](/gifs/overview.gif)
47-
<img src="/gifs/overview.gif"/>
50+
51+
There are also various built-in show/hide animations (which are just as versatile):
52+
<div style="display:flex;justify-content:center;align-items:center;">
53+
<img src="/gifs/showhide-overview.gif" width="80%"/>
54+
</div>
55+
4856

4957
For a full preview of built-in [animations](https://tmpeffects.luca3317.dev/manual/tmpanimator_builtinbasicanimations.html), [show / hide animations](https://tmpeffects.luca3317.dev/manual/tmpanimator_builtinshowhideanimations.html),
50-
and [commands](https://tmpeffects.luca3317.dev/manual/tmpwriter_builtincommands.html), see the respective documentation.
58+
and [commands](https://tmpeffects.luca3317.dev/manual/tmpwriter_builtincommands.html), as well as each of their parameters, see the respective documentation.
59+
60+
## Creating your own effects
61+
You can easily create your own animations and commands through custom scripts ([animations](https://tmpeffects.luca3317.dev/manual/animatingacharacter.html), [commands](https://tmpeffects.luca3317.dev/manual/tmpwriter_creatingcommands.html)).
62+
63+
Additionally, if you prefer not to code, you can create animations in the inspector using [GenericAnimations](https://tmpeffects.luca3317.dev/manual/genericanimations.html) or through Unity's timeline window, if you have it installed:
64+
<div style="display:flex;justify-content:center;align-items:center;">
65+
<img src="/gifs/timeline.gif" width="80%"/>
66+
</div>
67+
68+
## Parameters
69+
TMPEffects comes with very strong support for tag parameters; when creating an animation or command from script adding a parameter to your animation is as easy as decorating it with the [AutoParameter] attribute:
70+
71+
```csharp
72+
[AutoParameter("ampltiude", "amp"), SerializeField]
73+
private float amplitude;
74+
```
75+
76+
You can now set amplitude from the tag (e.g. &lt;wave amp=12&gt;) and use the value in your animation / command logic!
77+
78+
On top of that, TMPEffects has many types that are supported out of the box (float, Vector3, AnimationCurve...) as well as giving you the ability to easily create your own (which are also compatible with the AutoParameter attribute).
79+
You can also define custom keywords using Keyword databases.
80+
81+
## Integrations
82+
These are the external packages TMPEffects is integrated and confirmed to work with.
83+
If there is some other package/tool you'd like to see TMPEffects integrated with, feel free to open an issue (or, even better, a pull request!)
84+
85+
### Timeline
86+
TMPEffects is fully integrated with [Unity's Timeline package](https://docs.unity3d.com/Packages/[email protected]/manual/index.html), providing custom tracks, clips and markers.
87+
88+
### YarnSpinner
89+
TMPEffects works out of the box with [YarnSpinner](https://www.yarnspinner.dev/), you only have to disable YarnSpinner's built-in typewriter effects (see [the docs](https://tmpeffects.luca3317.dev/manual/yarnspinner.html) on that).
90+
You can even use variables defined in YarnSpinner scripts as tag parameters!
91+
5192

5293
## Dependencies and compatibility
5394
- TMPEffects is compatible with Unity 2021.3 and up
5495
- Tested in 2021.3, 2022.3 and 2023.2; if you have compatibility issues in another version (>= 2021.3), please open an issue for it!
5596
- Only dependency: Unity's TextMeshPro package (automatically included in Unity 2018.3 and up)
5697

57-
## Installation
98+
## Quickstart
99+
### Installation
58100
TMPEffects is available on the [OpenUPM registry](https://openupm.com/packages/com.luca3317.tmpeffects/).
59101
Alternatively, you can install TMPEffects through the Unity Package Manager, using the git url:
60102
```console
@@ -66,6 +108,10 @@ If you don't know how to install packages using git urls, see the [docs](https:/
66108
If you instead want to simply clone the repository,
67109
you will have to manually import the required resources located under Assets > TMPEffects > Resources.
68110

111+
### Set up
112+
Add the TMPAnimator and/or TMPWriter component to a GameObject with a TextMeshPro(UI) component, and select "use default database" in both their inspectors.
113+
You will get a prompt to import the required resources. Hit the button and you're done setting up TMPEffects!
114+
69115
## Documentation
70116
The full documentation can be found [here](https://tmpeffects.luca3317.dev/manual/introduction.html).
71117

0 commit comments

Comments
 (0)