> 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_playerped/configuration.md).

# Configuration

Every option in config.lua.

All settings are in `config.lua`.

| Option                         | Default                         | Description                                                    |
| ------------------------------ | ------------------------------- | -------------------------------------------------------------- |
| `Config.language`              | `'pl'`                          | `en`, `pl`, `de` or your own file in `locales/`                |
| `Config.framework`             | `'auto'`                        | `auto`, `esx`, `qb`, `qbx` or `standalone`                     |
| `Config.commands`              | `pedmenu`, `pedadmin`, `setped` | Command names                                                  |
| `Config.adminAce`              | `'rayn_playerped.admin'`        | ACE permission for admins                                      |
| `Config.adminGroups`           | `{'admin','superadmin','god'}`  | Framework groups that also have access                         |
| `Config.allowUnlisted`         | `false`                         | Admins can give models that are not in `shared/peds.lua`       |
| `Config.keepHealth`            | `true`                          | Keep health and armour when the model changes                  |
| `Config.applyDelay`            | `2500`                          | ms after the character loads before the default ped is applied |
| `Config.accent`                | `'#8a7cff'`                     | Accent colour of the panel                                     |
| `Config.thumbnails.vanillaUrl` | FiveM docs                      | Where vanilla thumbnails come from (`''` = off)                |

## Going back to the character

`Config.ResetSkin` loads the player's normal skin. It works out of the box with **illenium-appearance**, **esx\_skin / skinchanger** and **qb-clothing**. For another clothing script change this function.

`Config.AfterApply` runs after a ped is applied, by default it gives ESX weapons back.

## Translations

Texts are in `locales/en.lua`, `pl.lua` and `de.lua`. To add a language copy `en.lua`, translate it and set `Config.language`. Missing lines fall back to English.

## escrow

`config.lua`, `shared/peds.lua` and `locales/*.lua` are open. The `html/` folder is never encrypted, so you can add files to `html/thumbs/`.


---

# 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_playerped/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.