> For the complete documentation index, see [llms.txt](https://docs.yeistudios.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.yeistudios.com/scripts/safe-zone/configuration.md).

# Configuration

***

Todas las opciones viven en `config.lua`.

{% hint style="info" %}
`config.lua` y `locales/*.json` **no están en el escrow**, siempre editables aunque compres la versión protegida.
{% endhint %}

### Security & Command

| Variable              | Tipo    | Default          | Descripción                               |
| --------------------- | ------- | ---------------- | ----------------------------------------- |
| `Security.Permission` | string  | `'yei.safezone'` | Nodo ACE requerido para administrar zonas |
| `Command.Name`        | string  | `'safezone'`     | Nombre del comando                        |
| `Command.Restricted`  | boolean | `true`           | Si requiere el ACE para abrir el panel    |

### Framework

| Valor                  | Descripción                                |
| ---------------------- | ------------------------------------------ |
| `'auto'`               | Detecta qbx\_core → qb-core → es\_extended |
| `'qbx' / 'qb' / 'esx'` | Fuerza ese estilo de notificación          |
| `'none'`               | Usa siempre ox\_lib                        |

{% hint style="warning" %}
No afecta permisos ni el panel (siempre ACE) — solo el estilo del aviso de velocidad al entrar en vehículo.
{% endhint %}

### TextUI.Defaults

| Variable    | Default                | Descripción                           |
| ----------- | ---------------------- | ------------------------------------- |
| `Position`  | `right-center`         | right-center, left-center, top-center |
| `FontStyle` | `modern`               | Ver Styles.FontStyles                 |
| `UIStyle`   | `card-dark`            | Ver Styles.UIStyles                   |
| `FontSize`  | `14`                   | Rango 10-24                           |
| `IconColor` | `#1e88ff`              | Azul Yei Studios                      |
| `Label`     | `Estás en zona segura` | Texto por defecto                     |

### Styles

* **UIStyles:** `card-accent`, `card-dark`, `card-glass`, `card-border`, `elegant`, `frost`, `aurora`, `neon`, `cyber`, `hologram`, `retro`, `minimal`
* **FontStyles:** `modern`, `elegant`, `bold`, `tech`, `retro`, `minimal`

### Icons

| Variable    | Descripción                                           |
| ----------- | ----------------------------------------------------- |
| `Available` | shield-heart, shield, hospital, car, house, briefcase |
| `Default`   | `shield-heart`                                        |

### Creator

| Variable              | Default | Descripción                                |
| --------------------- | ------- | ------------------------------------------ |
| `Options.textUI`      | `true`  | Permite activar/desactivar TextUI por zona |
| `Options.maxVehSpeed` | `true`  | Permite velocidad máxima por zona          |
| `Options.driveBy`     | `true`  | Permite drive-by por zona                  |
| `Options.weapons`     | `true`  | Permite armas por zona                     |
| `ClosestRadius`       | `200.0` | Radio para "eliminar zona más cercana"     |
| `MaxSpeedMultiplier`  | `3.6`   | Conversión m/s → km/h                      |

### BlockControls

Lista de controles GTA elegibles desde el panel para bloquear por zona.

{% hint style="info" %}
Los controles de ataque básicos se bloquean **siempre** en cualquier zona — esta lista es para controles **adicionales** configurables por zona.
{% endhint %}

### Invincible

| Valor            | Comportamiento                                      |
| ---------------- | --------------------------------------------------- |
| `true` (default) | `SetEntityInvincible(true)` + statebag `inSafeZone` |
| `false`          | Solo bloqueo de armas/controles, sin invencibilidad |

### Validation

| Variable      | Default | Descripción                     |
| ------------- | ------- | ------------------------------- |
| `MinPoints`   | `4`     | Mínimo de vértices para guardar |
| `MaxZoneName` | `50`    | Largo máximo del nombre         |

### Discord

| Variable                         | Default        | Descripción                                                    |
| -------------------------------- | -------------- | -------------------------------------------------------------- |
| `Webhook`                        | `false`        | URL del webhook o `false` para desactivar todo                 |
| `BotName`                        | `Yei SafeZone` | Nombre del webhook                                             |
| `Events.<Evento>.Enabled/.Color` | según evento   | ZoneCreated, ZoneDeleted, ZoneRenamed, ZoneToggled, ZoneEdited |

{% hint style="danger" %}
Si la URL no empieza con `https://discord.com/api/webhooks/`, verás un aviso en consola al iniciar.
{% endhint %}

### Debug

| Valor             | Comportamiento                               |
| ----------------- | -------------------------------------------- |
| `true`            | Imprime coordenadas ENTER/EXIT en consola F8 |
| `false` (default) | Sin logs de debug                            |

***


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.yeistudios.com/scripts/safe-zone/configuration.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.