> For the complete documentation index, see [llms.txt](https://docs.rainmad.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.rainmad.com/resources/scale-peds-props-and-horses-fivem-and-redm/configuration.md).

# Configuration

Everything a server owner touches is in `cfg.lua`, outside escrow. Both resources share the same keys; the tabs show where the values differ.

***

## cfg.bridge

{% tabs %}
{% tab title="FiveM" %}

| Category       | Values                                                                                         |
| -------------- | ---------------------------------------------------------------------------------------------- |
| `framework`    | `auto`, `qb` (Qbox and QBCore), `esx`                                                          |
| `notification` | `builtin`, `ox_lib`, `qb`, `esx`, `okokNotify`, `ps-ui`, `lation_ui`, `wasabi_notify`, `zsxui` |
| `textUI`       | `builtin`, `ox_lib`, `qb`, `esx`, `okokTextUI`, `jg-textui`                                    |
| {% endtab %}   |                                                                                                |

{% tab title="RedM" %}

| Category       | Values                              |
| -------------- | ----------------------------------- |
| `framework`    | `auto`, `vorp`, `rsg`, `standalone` |
| `notification` | `builtin`, `ox_lib`, `vorp`, `rsg`  |
| `textUI`       | `builtin`, `ox_lib`                 |

`auto` picks RSG or VORP when one is running, otherwise standalone (ace only).
{% endtab %}
{% endtabs %}

`builtin` uses the script's own UI, styled to match the editor.

***

## cfg.access

| Field            | Default           | What it does                                            |
| ---------------- | ----------------- | ------------------------------------------------------- |
| `ace`            | `'rm_scaler.use'` | Ace that grants the editor. `false` disables ace checks |
| `frameworkAdmin` | `true`            | Framework admins get access too                         |

`cfg.command` (default `'scaler'`) is the command that opens the editor.

***

## cfg.scale

| Field | Default | What it does                     |
| ----- | ------- | -------------------------------- |
| `min` | `0.05`  | Smallest scale the editor allows |
| `max` | `20.0`  | Largest scale                    |

***

## cfg.source

| Field           | Default | What it does                                         |
| --------------- | ------- | ---------------------------------------------------- |
| `scanResources` | `true`  | Index the `stream/` folder of every started resource |
| `ignore`        | `{}`    | Resource names never indexed                         |

The scaler's own `source/` folder is always indexed. See [Source Files](https://docs.rainmad.com/resources/scale-peds-props-and-horses-fivem-and-redm/source-files.md).

***

## cfg.output

| Field        | Default                                                        | What it does                                    |
| ------------ | -------------------------------------------------------------- | ----------------------------------------------- |
| `resource`   | `'rm_scaler_output'` (FiveM), `'rm_scaler_redm_output'` (RedM) | Where copies are written, created on first save |
| `autoEnsure` | `true`                                                         | Restart it after every save and delete          |
| `suffix`     | `'_s'`                                                         | Default clone name: `<model><suffix><n>`        |
| `pedScaleIn` | `'outfit'`                                                     | RedM only, see below                            |

{% hint style="danger" %}
`resource` must be a resource the scaler created. Pointing it at an existing resource is refused (`err_output_foreign`), so a typo can never overwrite another script.
{% endhint %}

### pedScaleIn (RedM)

Where a ped or horse copy's size is written: `'outfit'` (every outfit's `scale`), `'model'` (the ped entry's `Scale`) or `'both'`.

{% hint style="info" %}
RDR2 has a size value in two places: one per ped model and one per outfit (Rockstar sets the outfit one per horse coat). The outfit one is what sizes a ped in game, so keep `'outfit'`. With `'model'` alone a copy spawns at its normal size.
{% endhint %}

***

## cfg.playerScale

| Field     | Default      | What it does           |
| --------- | ------------ | ---------------------- |
| `enabled` | `true`       | Registers the command  |
| `command` | `'setscale'` | Command name           |
| `min`     | `0.3`        | Smallest allowed scale |
| `max`     | `3.0`        | Largest allowed scale  |

See [Live Player Scale](https://docs.rainmad.com/resources/scale-peds-props-and-horses-fivem-and-redm/player-scale.md).

***

## cfg.nui

| Field             | Default                 | What it does                                                                                                                                                   |
| ----------------- | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `primaryColor`    | `'#ffffff'`             | Accent colour: hex, rgba or `{ r, g, b, a }`                                                                                                                   |
| `mediaUrl`        | `'https://fivemad.com'` | FiveM: catalogue and pictures for the Peds / Props tabs. RedM: the ped list for the Peds tab and the base-game ped data used on save. `false` hides those tabs |
| `overlays.editor` | `'right-center'`        | Where the editor panel sits on screen                                                                                                                          |

***

## cfg.locale

`'en'` ships. Add `locales/<lang>.json` and set its name here.

***

## cfg.dev

Keep it `false`. When `true`, **every player** can use the scaler and the test commands (`/scalerdev`, `/scalerspawn`, `/scalermodel`, `/scalerclear`) register.
