> For the complete documentation index, see [llms.txt](https://fantasy-scripts.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://fantasy-scripts.gitbook.io/docs/hud-v-system/compatibility.md).

# Compatibility

## Compatibility

This is a HUD: the chips along the bottom left, the speedometer and vehicle menu, the round map in the corner with its compass and street name, the player list, and the key reminders. It draws your player's state — it does not own it, so nothing else on your server has to change.

### What it needs

**A framework**

ESX, QBCore or Qbox. The HUD reads the player's money, job and name from it.

**pma-voice**

Optional. Only for the microphone chip and the radio channel beside it. Turn `Config.Voice.enabled` off if you do not run it.

**Nothing else**

No ox\_lib, no database, no SQL. Everything is read from the game itself.

### Frameworks

| Framework   | Setting                       |
| ----------- | ----------------------------- |
| ESX         | `Config.Framework = 'esx'`    |
| QBCore      | `Config.Framework = 'qbcore'` |
| Qbox        | `Config.Framework = 'qbox'`   |
| Work it out | `Config.Framework = 'auto'`   |

`auto` is the default and is right for almost everyone. Set it by hand if you run more than one framework, or if yours is renamed — and if the folder name is different, say so in `Config.FrameworkResources`.


---

# 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://fantasy-scripts.gitbook.io/docs/hud-v-system/compatibility.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.