> 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/car-wipe-1/configuration.md).

# Configuration

Configure rewards, vehicles, NPCs, database settings, and UI options.

Todas las opciones viven en `shared/config.lua`.

{% hint style="info" %}
Este archivo **no está en el escrow**, así que siempre puedes editarlo aunque compres la versión protegida.
{% endhint %}

### Core

| Variable                | Tipo    | Default                    | Descripción                                                          |
| ----------------------- | ------- | -------------------------- | -------------------------------------------------------------------- |
| `Framework`             | string  | `'auto'`                   | Framework a usar: `'auto'`, `'qb'`, `'qbx'`, `'esx'`                 |
| `Notify`                | string  | `'auto'`                   | Sistema de notificación: `'auto'`, `'ox'`, `'qb'`, `'esx'`, `'chat'` |
| `Target`                | string  | `'auto'`                   | Sistema de interacción: `'auto'`, `'ox'`, `'qb'`, `'none'`           |
| `Command`               | string  | `'starterpack'`            | Comando para abrir el menú manualmente                               |
| `AdminResetCommand`     | string  | `'resetstarterpack'`       | Comando admin de reseteo                                             |
| `AdminAce`              | string  | `'yei-starterpack.admin'`  | Permiso ACE requerido para el reset                                  |
| `DatabaseTable`         | string  | `'yei_starterpack_claims'` | Tabla donde se guardan los reclamos                                  |
| `IdentifierType`        | string  | `'license'`                | Identifier usado para validar reclamos                               |
| `PlatePrefix`           | string  | `'YEI'`                    | Prefijo de placas generadas                                          |
| `PlateLength`           | number  | `8`                        | Largo máximo de la placa                                             |
| `GiveVehicleInDatabase` | boolean | `true`                     | Guarda el vehículo en la garage del jugador                          |
| `VehicleGarage`         | string  | `'pillboxgarage'`          | Garage donde queda registrado (QB/QBX)                               |
| `VehicleState`          | number  | `0`                        | Estado inicial en `player_vehicles`                                  |
| `Debug`                 | boolean | `false`                    | Reservado para logs de debug                                         |

{% hint style="success" %}
**Recomendación:** deja `Framework`, `Notify` y `Target` en `'auto'` salvo que tengas un caso específico donde la detección falle.
{% endhint %}

### Logs (Discord webhook)

| Variable     | Tipo    | Descripción                                                     |
| ------------ | ------- | --------------------------------------------------------------- |
| `enabled`    | boolean | Activa o desactiva el log a Discord                             |
| `webhookURL` | string  | URL del webhook. Vacío = no se envía nada                       |
| `botName`    | string  | Nombre mostrado por el webhook                                  |
| `botAvatar`  | string  | Avatar del webhook                                              |
| `serverName` | string  | Nombre de tu servidor                                           |
| `fields.*`   | boolean | `ip`, `discordId`, `license`, `license2`, `steamId`, `steamUrl` |

{% hint style="warning" %}
Si tienes reglas de privacidad estrictas en tu comunidad, desactiva `ip` y deja solo `discordId` y `license`.
{% endhint %}

### NPC

| Variable                  | Descripción                                               |
| ------------------------- | --------------------------------------------------------- |
| `enabled`                 | Activa/desactiva el spawn del NPC                         |
| `model`                   | Modelo de ped a spawnear                                  |
| `coords`                  | Ubicación y heading (vector4)                             |
| `interactionRange`        | Distancia para interactuar (recomendado 2.0–3.0)          |
| `header / label / dialog` | Textos mostrados en la interacción                        |
| `blip.*`                  | Configuración del blip en el mapa (sprite, color, escala) |

### Spawn

| Variable     | Descripción                                         |
| ------------ | --------------------------------------------------- |
| `coords`     | Dónde aparece el vehículo entregado                 |
| `warpPlayer` | Si el jugador se teletransporta dentro del vehículo |

### Rewards

| Variable | Tipo   | Ejemplo                          |
| -------- | ------ | -------------------------------- |
| `cash`   | number | `25000`                          |
| `bank`   | number | `25000`                          |
| `items`  | table  | `{ name = 'phone', amount = 1 }` |

{% hint style="danger" %}
Los nombres de ítems deben existir exactamente igual en tu sistema de inventario, o no se entregarán.
{% endhint %}

### Vehicles

Array de hasta 3 vehículos (la UI está diseñada para 3 tarjetas):

| Campo                  | Descripción                      |
| ---------------------- | -------------------------------- |
| `id`                   | ID único usado al reclamar       |
| `name`                 | Nombre mostrado en la tarjeta    |
| `car`                  | Nombre "bonito" del vehículo     |
| `spawnName`            | Modelo real que se spawnea       |
| `image`                | URL de imagen mostrada           |
| `rarity`               | `Legendary`, `Rare`, `Common`    |
| `speed / acceleration` | Barras visuales de stats (0-100) |
| `description`          | Descripción corta                |

### UI

| Variable            | Descripción                                                    |
| ------------------- | -------------------------------------------------------------- |
| `title / subtitle`  | Textos del header del menú                                     |
| `logo / background` | URLs de imagen                                                 |
| `colors.*`          | Paleta de 6 colores: navy, blueDark, blue, cyan, silver, white |

{% hint style="info" %}
Todas las URLs de imagen deben ser links directos y accesibles (recomendado: CDN como fivemanage), nunca links de Discord (expiran).
{% endhint %}


---

# 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/car-wipe-1/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.