# Quickstart

<figure><img src="https://2667765084-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FHn6DmkxXXtfi3gPxzMFr%2Fuploads%2F8ssT6eBfVQQbWsta3dWG%2FFrame%2018.png?alt=media&#x26;token=772f4857-9a12-4e2b-a1fb-a5822ec8b8ff" alt="" width="563"><figcaption></figcaption></figure>

:tada: Thank you for purchasing the TMP VFX asset!&#x20;

* Before using TMP VFX, please check  :warning: [Requirements](https://stellarabbitstudio.gitbook.io/stellarabbitstudio/tmp-vfx-shader/requirements).&#x20;
* Having problems? Check the Error Fix Tool below.

{% content-ref url="error-fix-tool" %}
[error-fix-tool](https://stellarabbitstudio.gitbook.io/stellarabbitstudio/tmp-vfx-shader/error-fix-tool)
{% endcontent-ref %}

## Quick Setup

1. Add a <mark style="color:yellow;">**TextMeshPro**</mark> component to your GameObject (UI or World Space)
2. Change the shader to <mark style="color:yellow;">**"TextMeshPro/TMP VFX"**</mark> in the material settings
3. Add the <mark style="color:yellow;">**GlitchOnce.cs**</mark> script to your TMP gameObject

## Detailed Setup

#### 1. Right-click in the Hierarchy window to create a <mark style="color:yellow;">Text - TextMeshPro</mark>

<figure><img src="https://content.gitbook.com/content/Hn6DmkxXXtfi3gPxzMFr/blobs/xlWWUeZ9vXrt9uXRRoxI/image.png" alt="" width="546"><figcaption></figcaption></figure>

2. Set the <mark style="color:yellow;">**Font Asset**</mark> to <mark style="color:blue;">**Iceland-Regular SDF\_Dynamic\_Glitch**</mark>

If you want to create a custom <mark style="color:yellow;">**Font Asset**</mark> that can apply effects, check out the guide below.

{% content-ref url="font-asset" %}
[font-asset](https://stellarabbitstudio.gitbook.io/stellarabbitstudio/tmp-vfx-shader/font-asset)
{% endcontent-ref %}

<figure><img src="https://content.gitbook.com/content/Hn6DmkxXXtfi3gPxzMFr/blobs/Gv46t59Mz5jBfPpcUvpk/image.png" alt=""><figcaption></figcaption></figure>

3. Scroll down in the Inspector, then click the <mark style="color:blue;">**Add TMP VFX Component**</mark> button under **TMP VFX Shader Settings**.

<figure><img src="https://content.gitbook.com/content/Hn6DmkxXXtfi3gPxzMFr/blobs/8sg2uWYOqthaDVfGW2J2/image.png" alt="" width="444"><figcaption></figcaption></figure>

4. Scroll back up to locate the **TMP VFX Component**, then click the <mark style="color:blue;">**Save Font (Clear VFX)**</mark> button.

<figure><img src="https://content.gitbook.com/content/Hn6DmkxXXtfi3gPxzMFr/blobs/OI4R6g5zBxHspfxEDrIA/image.png" alt="" width="443"><figcaption></figcaption></figure>

5. Assign the created <mark style="color:yellow;">**Font Asset**</mark> to the **Font Asset** field in <mark style="color:blue;">**TextMeshPro**</mark>

<figure><img src="https://content.gitbook.com/content/Hn6DmkxXXtfi3gPxzMFr/blobs/DhHuFyHg9fJ6lyD5ncUv/image.png" alt="insert Saved Text Font Asset to inspector Font Asset" width="442"><figcaption></figcaption></figure>

The setup is now complete. Keep reading to learn how to apply effects.

## How to apply VFX

Scroll down to the **Material Shader Settings** section of the font

You will find the <mark style="color:blue;">**TMP VFX Shader Settings**</mark> tab.&#x20;

In that tab, click **Show VFX Effects**, then enable the **Glitch** effect by turning it <mark style="color:green;">**ON**</mark>

<figure><img src="https://content.gitbook.com/content/Hn6DmkxXXtfi3gPxzMFr/blobs/K1TO257WvH6h09TxT7se/image.png" alt="" width="443"><figcaption></figcaption></figure>

Scroll back up and click the <mark style="color:blue;">**Auto Add VFX Components**</mark> button in the <mark style="color:yellow;">**TMP VFX**</mark>**&#x20;Component** tab.

<figure><img src="https://content.gitbook.com/content/Hn6DmkxXXtfi3gPxzMFr/blobs/PVtFK3GCTlV67xyMA3Fb/image.png" alt="" width="441"><figcaption></figcaption></figure>

<mark style="color:yellow;">Everything is ready!</mark>  :tada:

When you play, you should see the text with the applied effects.&#x20;

For details on additional settings you can customize, please refer to the guide below.

{% content-ref url="shader-settings/glitch-vfx" %}
[glitch-vfx](https://stellarabbitstudio.gitbook.io/stellarabbitstudio/tmp-vfx-shader/shader-settings/glitch-vfx)
{% endcontent-ref %}

Additional Features

* Outline customization
* Glow effects
* Underlay options

## <mark style="color:yellow;">Support</mark>

For additional support or questions:

* Join our [Discord ](https://discord.gg/mnHRQ4HutJ)community for direct support
* <https://discord.gg/mnHRQ4HutJ>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://stellarabbitstudio.gitbook.io/stellarabbitstudio/tmp-vfx-shader/quickstart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.