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

# Introduction

An editable status HUD for QBCore, Qbox and ESX. Also the settings hub of the Striga suite.

**Striga Tokyo HUD** is a status HUD where every player can move, group and restyle their own parts.

Players open it with `/hud` (or **F9**), press **Edit HUD** and drag things around. Everything saves by itself, there is no save button.

Current version: **1.0.0**

## Features

| Feature                | What it means                                                                              |
| ---------------------- | ------------------------------------------------------------------------------------------ |
| **Status**             | Health, armor, hunger, thirst, stamina, oxygen, stress (optional) and microphone           |
| **Free layout editor** | Drag parts, select several and group them, restyle many at once                            |
| **Two layouts**        | One on foot, one in a vehicle (the vehicle one starts as a copy)                           |
| **Vehicle HUD**        | Speed, rpm, gear, fuel, seatbelt, indicators, cruise, nitro. Boats, helis and planes too   |
| **Info panel**         | Top right: server name, ID, character, cash, bank, weapon and ammo                         |
| **Compass**            | Top center, with the street name                                                           |
| **Minimap**            | Rounded or circle, with a frame, 3 positions                                               |
| **Theme color**        | The player's theme color is sent to every Striga script through striga-core                |
| **Settings hub**       | The `/hud` menu shows a settings block for every Striga script that has player settings    |
| **Share codes**        | `strg-XXXXXX` codes copy a full look to a friend, Striga script settings included          |
| **Cinematic mode**     | Hides the HUD and radar, adds black bars                                                   |
| **11 languages**       | `en`, `tr`, `de`, `es`, `fr`, `ar`, `pt`, `ru`, `pl`, `it`, `nl` (Arabic is right to left) |

## The suite settings hub

The `/hud` menu is the one place where players change the settings of **every** Striga script:

* Every Striga script with player settings (Chat, Notify, Text UI, Inventory, Multicharacter...) shows its own block in the menu.
* The theme color the player picks is sent through striga-core to all scripts. Each script follows it, unless the player picked a color in that script.
* Share codes and `/hud reset` include those script settings too.

Each script keeps its own panel as well. Both places change the same settings.

Full guide: [Settings Menu (/hud)](/docs/striga-tokyo-hud/settings-menu.md).

## Supported frameworks

QBCore, Qbox and ESX, picked up by **striga-core**. No framework at all also works (standalone mode).

## Requirements

* **striga-core 0.1.0 or newer** (started before the HUD). It needs **ox\_lib** and **oxmysql**.
* One of: QBCore, Qbox, ESX (or standalone)

Optional:

* **pma-voice**: the microphone part turns on by itself.
* **Fuel script**: ox\_fuel, LegacyFuel, cdn-fuel, ps-fuel, qb-fuel and lc\_fuel work out of the box. Without one, GTA's own fuel level is used.
* **Seatbelt**: qb-smallresources or qbx\_seatbelt. Without them, the HUD uses its own seatbelt.
* **Nitro**: shows when your mechanic script fires the qb-hud nitro event (qb-mechanicjob does).

{% hint style="warning" %}
**Do not run it with qb-hud, qbx\_hud or esx\_hud.** Tokyo HUD uses the same stress and needs events as qb-hud, so with both running, stress goes up twice and two HUDs fight on screen.
{% endhint %}

## Player commands

| Command / key | What it does                                                                                         |
| ------------- | ---------------------------------------------------------------------------------------------------- |
| `/hud` or F9  | Opens the menu: Edit HUD, cinematic mode, theme, minimap, share codes, refresh rate, script settings |
| `/hud reset`  | Wipes the saved layout (PC and server) and the Striga script settings, like a first join             |
| `/hud debug`  | Prints minimap numbers to the F8 console (for server owners)                                         |
| B             | Seatbelt (built in seatbelt only)                                                                    |
| Left / Right  | Turn signals                                                                                         |
| Up            | Hazard lights                                                                                        |

Players can change the keys in *Settings > Key Bindings > FiveM*.

{% content-ref url="/pages/THLC5gBwn8ggzndD48ff" %}
[Installation & Configuration](/docs/striga-tokyo-hud/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-tokyo-hud/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.
