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

# Configuration

Every option in config.lua.

### General

| Option                  | Default      | Description                                                                          |
| ----------------------- | ------------ | ------------------------------------------------------------------------------------ |
| `Config.Locale`         | `'en'`       | `'en'` or `'pl'`                                                                     |
| `Config.Framework`      | `'auto'`     | `'auto'`, `'esx'`, `'qbcore'`, `'qbox'`                                              |
| `Config.Inventory`      | `'auto'`     | `'auto'`, `'ox_inventory'`, `'qb-inventory'`, `'esx'`                                |
| `Config.Target`         | `'auto'`     | `'auto'`, `'qb-target'`, `'ox_target'`                                               |
| `Config.Notify`         | `'ox_lib'`   | `'ox_lib'` or `'custom'` (built-in toasts). Falls back to `'custom'` without ox\_lib |
| `Config.SimItem`        | `'sim_card'` | Item name                                                                            |
| `Config.PaymentAccount` | `'any'`      | `'bank'`, `'cash'` or `'any'` (bank first, the rest from cash)                       |

### Prices

| Option                    | Default | Description                    |
| ------------------------- | ------- | ------------------------------ |
| `Config.Prices.NewSim`    | `500`   | A new card with a new number   |
| `Config.Prices.Block`     | `0`     | Reporting a card stolen        |
| `Config.Prices.Duplicate` | `750`   | A new card for the same number |

### No number without a SIM - `Config.RequireSim`

| Option                | Default           | Description                                                     |
| --------------------- | ----------------- | --------------------------------------------------------------- |
| `Enabled`             | `true`            | Phones have no number until a SIM is inserted                   |
| `AutoInsertOnBuy`     | `true`            | Bought / duplicate cards go straight into an empty phone        |
| `ReplaceLegacyNumber` | `false`           | Allow inserting a card into a phone with an old lb-phone number |
| `StripLegacyNumbers`  | `false`           | Remove all old lb-phone numbers                                 |
| `MoveLbData`          | `true`            | Move contacts / messages when a number changes                  |
| `PhoneItems`          | `nil`             | Phone item names; `nil` reads them from the lb-phone config     |
| `NumberFormat`        | `'({3}) {3}-{4}'` | Used only if the lb-phone format can't be read                  |

### Custom numbers - `Config.CustomNumber`

| Option                    | Default                                 | Description                                                            |
| ------------------------- | --------------------------------------- | ---------------------------------------------------------------------- |
| `Enabled`                 | `true`                                  | Show custom numbers at the vendor (the admin command works either way) |
| `Price`                   | `5000`                                  | Price of a custom number                                               |
| `MinLength` / `MaxLength` | `6` / `10`                              | Allowed number of digits                                               |
| `AllowedPrefixes`         | `{}`                                    | e.g. `{ '205', '555' }`; empty = any                                   |
| `Blacklist`               | `{ '911', '112', '999', '997', '998' }` | Numbers players can't pick                                             |
| `CheckLbPhone`            | `true`                                  | Also check lb-phone tables for taken numbers                           |
| `AdminCommand`            | `'setnumber'`                           | Admin command name                                                     |
| `AdminAce`                | `'rayn_simcards.admin'`                 | ACE permission                                                         |
| `AdminGroups`             | `{ 'admin', 'superadmin', 'god' }`      | ESX groups / QB permissions                                            |

### Vendor - `Config.Vendor`

| Option                                    | Description                                                         |
| ----------------------------------------- | ------------------------------------------------------------------- |
| `Coords`                                  | `vec4` position and heading of the NPC                              |
| `PedModel`, `Scenario`                    | NPC model and animation                                             |
| `Interaction`                             | `'auto'` (target if available, else marker), `'target'`, `'marker'` |
| `InteractDistance`                        | Marker interaction distance                                         |
| `MarkerType`, `MarkerColor`, `MarkerSize` | Marker look                                                         |
| `MaxServerDistance`                       | The server rejects vendor actions from further away                 |
| `Blip`                                    | `Sprite`, `Color`, `Scale`, `Label` (`nil` = locale text)           |

### lb-phone - `Config.LBPhone`

| Option                           | Description                                                 |
| -------------------------------- | ----------------------------------------------------------- |
| `AssumeUniqueMode`               | Fallback when lb-phone's `Config.Item.Unique` can't be read |
| `NumberPrefixes`, `NumberLength` | Must match `Config.PhoneNumber` in lb-phone                 |
| `WriteMirrorTable`               | Also write `phone_last_phone` (keep on)                     |
| `DatabaseFallback`               | Classic mode only: also write `phone_phones` directly       |


---

# 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://rayn-scripts.gitbook.io/rayn-scripts-docs/rayn_simcards/configuration.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.