Skip to content

Commit 05dc58f

Browse files
authored
Update README.md
Removed usage segment because it is out of date and in the process of being reworked
1 parent 5799f90 commit 05dc58f

File tree

1 file changed

+0
-47
lines changed

1 file changed

+0
-47
lines changed

README.md

Lines changed: 0 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -15,50 +15,3 @@
1515
- Tag-based animation control similar to HTML or BBCode
1616
- Compatible with TextMeshPro components
1717
- Runtime and editor-time updates supported
18-
19-
## Installation
20-
21-
1. Clone or download this repository into your Unity project under `Assets/textmotion-pro`.
22-
2. Ensure **TextMeshPro** is installed in your project via Unity Package Manager.
23-
3. Use Unity 6.0 or later for full compatibility.
24-
25-
## Usage
26-
27-
### 1. Create a Motion Profile
28-
29-
- Right-click in the Project window → **Create → textmotion-pro → MotionProfile**
30-
- Add or configure `TextEffect` assets to this profile.
31-
32-
### 2. Attach `TextMotionPro`
33-
34-
- Add the `TextMotionPro` component to a GameObject with a `TMP_Text` component.
35-
- Assign a `MotionProfile` to the renderer.
36-
37-
### 3. Use Tags in Text
38-
39-
- Use tags like `<Wave>Text</Wave>` where `"Wave"` matches the `EffectTag` of a `TextEffect`.
40-
41-
42-
## Extending
43-
44-
To implement a new animation:
45-
46-
1. Create a class inheriting from `TextEffect`.
47-
2. Implement the `ApplyEffect()` method.
48-
3. Define an `EffectTag` and optionally override validation or reset behavior.
49-
4. Add the effect to a MotionProfile.
50-
51-
## Example
52-
53-
```csharp
54-
[TextEffect("Wave", "Wavy motion effect for characters")]
55-
public class WaveEffect : TextEffect
56-
{
57-
public override string EffectTag => "Wave";
58-
59-
public override void ApplyEffect(MotionRenderContext context)
60-
{
61-
// Animation logic here
62-
}
63-
}
64-
````

0 commit comments

Comments
 (0)