> 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-chat/introduction.md).

# Introduction

A clean RP chat for QBCore, Qbox and ESX. Drop-in for the default chat.

**Striga Chat** replaces the default FiveM `chat` resource. Everything that already talks to the chat (your framework, inventory, jobs, admin menus) keeps working, with no edit.

On top of that you get RP commands, channel tabs, command help while you type, lines over the head and a chat log in your database. The look matches **Striga Tokyo HUD**.

Current version: **1.0.0**

## Features

| Feature                    | What it means                                                                               |
| -------------------------- | ------------------------------------------------------------------------------------------- |
| **Drop-in for `chat`**     | `chat:addMessage`, suggestions, templates, modes, `chatMessage` and `exports.chat` all work |
| **RP commands**            | `/me`, `/do`, `/try`, `/roll`, `/looc`, `/ooc`, `/ad`                                       |
| **No slash needed**        | `me lights a cigarette` or `dv` runs as a command. The input shows a tag while you type     |
| **Lines over the head**    | `/me`, `/do`, `/try` and `/roll` also show over the player's head                           |
| **Channel tabs**           | General, OOC, Local, Job, Gang, Ads, plus your own. Off by default (`Config.UseChannels`)   |
| **3 looks**                | Card, Tinted and Compact                                                                    |
| **Quick buttons**          | ME / DO / ROLL buttons under the input                                                      |
| **Emoji panel**            | With categories and search                                                                  |
| **Player settings**        | Look, text size, width, height, color, corners, opacity, blur, time, input tag, head lines  |
| **Follows your HUD color** | With Striga Tokyo HUD, the chat uses the HUD theme color, live                              |
| **History**                | Players see the latest messages when they join, also after a restart                        |
| **Chat log**               | Every line and RP command goes into the `striga_chat_logs` table (made by itself)           |
| **Spam guard**             | Too many messages shows "Slow down" and drops the extra ones                                |
| **11 languages**           | en, tr, de, es, fr, it, nl, pl, pt, ru, ar                                                  |

## Supported frameworks

| Framework | Status                               |
| --------- | ------------------------------------ |
| QBCore    | Supported                            |
| Qbox      | Supported                            |
| ESX       | Supported                            |
| None      | Works standalone through striga-core |

{% hint style="info" %}
striga-core finds your framework by itself. Striga Chat never talks to the framework directly.
{% endhint %}

## Requirements

* **striga-core 0.1.0 or newer** (started before Striga Chat)
* **ox\_lib** and **oxmysql**
* **OneSync** for the nearby commands (`/me`, `/do`, `/try`, `/roll`, `/looc`, Local channel). Without it those only reach the sender.

{% hint style="info" %}
**Striga Tokyo HUD is optional.** With it, the chat follows the HUD theme color (unless the player picks a chat color), you can move and edit the chat in the HUD editor, and the `/hud` menu gets a **Chat** settings section through the striga-core settings hub.
{% endhint %}

## Player controls

| Key / command       | What it does                                                               |
| ------------------- | -------------------------------------------------------------------------- |
| **T**               | Opens the chat (players can rebind it in Settings > Key Bindings > FiveM)  |
| **Esc**             | Closes the chat                                                            |
| **Arrow Up / Down** | Goes through the messages you sent before                                  |
| `/togglechat`       | Switches the chat between `whenactive` (fades out), `visible` and `hidden` |
| Settings button     | Opens the chat settings panel                                              |
| `/hud`              | Tokyo HUD menu, has a **Chat** section (if the HUD runs)                   |

Both settings places change the same settings. They are saved for each player, so every player keeps their own look.

{% content-ref url="/pages/OKTE6PSzzfLkZBKydco5" %}
[Installation & Configuration](/docs/striga-chat/installation-and-configuration.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-chat/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.