> For the complete documentation index, see [llms.txt](https://documentation.rcore.cz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentation.rcore.cz/paid-resources/rcore_formula/configuration.md).

# Configuration

## 🛠 Debugging & Localization

| Setting        | Default | Description                                                                                                   |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------- |
| Debug          | `false` | If true, debug messages will be printed to the console. Useful for development and troubleshooting.           |
| Locale         | `'en'`  | Language code for translations (uses `locales/[locale].lua`).                                                 |
| IgnoredLocales | `{}`    | List of locale keys to ignore (e.g. to disable certain notifications). Example: `{ ['UI_NOT_READY'] = true }` |

## 🔌 Bridge Settings

These settings control integration with FiveM frameworks, database systems, and target interaction scripts. If set to `AUTO_DETECT`, the script will attempt to detect the system automatically.

| Setting   | Options                      | Default       | Description                   |
| --------- | ---------------------------- | ------------- | ----------------------------- |
| Framework | ESX, QBCore, QBX, Standalone | `AUTO_DETECT` | The server framework to use.  |
| Database  | OX, MYSQL\_ASYNC, GHMATTI    | `AUTO_DETECT` | The database resource to use. |
| Target    | NONE, OX, QB, QTARGET        | `AUTO_DETECT` | Target interaction system.    |

## 👮 Admin Groups (Framework Specific)

```lua
FrameworkAdminGroups = {
    [Framework.ESX] = { 'superadmin', 'admin' },
    [Framework.QBCore] = { 'god', 'admin' },
}
```

Lists framework-specific admin group names that have elevated permissions (e.g., race creation, team management).

Standalone ACE permission is `rcore_formula.admin` for standalone servers.

## 🚗 Vehicle View

| Setting          | Default | Description                                                                |
| ---------------- | ------- | -------------------------------------------------------------------------- |
| ForceFirstPerson | `false` | If true, players will be forced into first-person view while in a vehicle. |

## 📊 HUD Settings

```lua
Hud = {
    SyncTime = 100,
    Kph = false
}
```

| Setting  | Default | Description                                                                      |
| -------- | ------- | -------------------------------------------------------------------------------- |
| SyncTime | `100`   | Refresh rate (ms) for syncing HUD with game data.                                |
| Kph      | `false` | If true, HUD speed is shown in kilometers per hour; otherwise in miles per hour. |

## 🛠 Pit Lane Settings

```lua
Pit = {
    MaxSpeed = 60,                      -- Maximum speed in pit lane in MPH
    BoxMarker = {                       -- Marker settings for pit box, used to show where the pit box is
        Type = 21,                      -- Marker type, see https://docs.fivem.net/docs/game-references/markers/
        Scale = { 1.0, 1.0, 1.0 },      -- Scale of the marker, X, Y, Z
        Rotation = { 0.0, 180.0, 0.0 }, -- Rotation of the marker, X, Y, Z
        Color = { 255, 0, 0, 100 },     -- RGB color with alpha
    },
},
```

| Setting            | Default             | Description                              |
| ------------------ | ------------------- | ---------------------------------------- |
| MaxSpeed           | `60`                | Maximum allowed speed in pit lane (MPH). |
| BoxMarker.Type     | `21`                | Marker type (see FiveM Marker Types).    |
| BoxMarker.Scale    | `{1.0, 1.0, 1.0}`   | Size of the pit box marker.              |
| BoxMarker.Rotation | `{0.0, 180.0, 0.0}` | Marker rotation.                         |
| BoxMarker.Color    | `{255, 0, 0, 100}`  | Marker color with transparency.          |