> For the complete documentation index, see [llms.txt](https://striga.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://striga.gitbook.io/docs/striga-text-ui/introduction.md).

# Introduction

Clean interaction prompts ("\[E] Open door") for QBCore, Qbox and ESX, on screen or in the world.

**Striga Text UI** replaces the interaction prompts on your server ("\[E] Open door") with a clean design that matches **Striga Tokyo HUD**.

You install it once, and every prompt on your server uses the new look: your Striga scripts, your framework and your other scripts. It can also show prompts **in the world**, pinned to a spot or to a vehicle, ped or object.

Version: **1.0.0**

## Features

| Feature                    | What it means                                                                                                                                                     |
| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **3 looks**                | Card, Pill and Minimal                                                                                                                                            |
| **3 key looks**            | Keycap, Tile and Plain                                                                                                                                            |
| **4 types**                | Info (theme color), Success, Warning and Error                                                                                                                    |
| **2D or 3D mode**          | Each player picks: prompts on the screen, or pinned in the world                                                                                                  |
| **3D prompts**             | Put a prompt on a spot or on an entity with `Add3D`. Far away only the key shows, close by the whole prompt. See [3D Prompts](/docs/striga-text-ui/3d-prompts.md) |
| **Hidden behind walls**    | A 3D prompt behind a wall or an object is hidden. Glass, vehicles and peds do not hide it                                                                         |
| **Key animation**          | Pressing the prompt's key fills it with the main color and fades it. It comes back when the player is still there and no menu is open                             |
| **Follows your HUD color** | With Striga Tokyo HUD, prompts use the theme color the player picked, live                                                                                        |
| **Player settings**        | Every player can change look, key look, mode, position, opacity, size, blur and color                                                                             |
| **`[E]` becomes the key**  | A text like `[E] Open door` shows `E` as a key tile, no change in your scripts                                                                                    |
| **Catches other scripts**  | ESX, QBCore, Qbox and ox\_lib prompts all show in the new design. See [Integration](/docs/striga-text-ui/integration.md)                                          |
| **Background blur**        | Soft blur of the game behind each prompt                                                                                                                          |

## Supported frameworks

| Framework | How other scripts are caught                               |
| --------- | ---------------------------------------------------------- |
| ESX       | Automatic, no file to edit                                 |
| QBCore    | One line per function in `qb-core`                         |
| Qbox      | One line per function in `ox_lib`                          |
| ox\_lib   | One line per function in `ox_lib` (works on any framework) |

## Requirements

* **striga-core 0.1.0 or newer** (started before Striga Text UI, see [Striga Core](/docs/striga-core/introduction.md))
* **ox\_lib** and **oxmysql** (needed by striga-core)
* One of: QBCore, Qbox, ESX

{% hint style="info" %}
**Striga Tokyo HUD is optional.** Without it, Striga Text UI uses the color from its config. With it, the color follows the HUD theme (unless the player picks a color) and the `/hud` menu gets an **Interaction prompt** section, through the striga-core settings hub.
{% endhint %}

## Player commands

| Command           | What it does                                                            |
| ----------------- | ----------------------------------------------------------------------- |
| `/textuisettings` | Opens the settings panel with a live preview                            |
| `/hud`            | Tokyo HUD menu, has an **Interaction prompt** section (if the HUD runs) |

Both places change the same settings. They are saved on each player's own PC, so every player keeps their own look.

## Next steps

{% content-ref url="/pages/cJg4ereuFV8acLl6B5hc" %}
[Installation & Configuration](/docs/striga-text-ui/installation-and-configuration.md)
{% endcontent-ref %}

{% content-ref url="/pages/PqKTMAkBHOBXwi0J8ktc" %}
[3D Prompts](/docs/striga-text-ui/3d-prompts.md)
{% endcontent-ref %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://striga.gitbook.io/docs/striga-text-ui/introduction.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.