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

# 🧰Configuration

### Configuration

All configuration is done through the `config.lua` file:

#### Basic Settings

```lua
-- Main Settings
Config.MaxDistance = 10.0 -- Maximum distance for displaying descriptions
Config.KeyBind = 20 -- Key to display descriptions (20 = Z)
Config.TextScale = 0.35 -- Text size
Config.TextFont = 4 -- Text font
Config.DefaultColor = "#ffffff" -- Default text color
Config.RefreshRate = 200 -- Refresh rate in ms when key is not pressed
Config.Command = "desc" -- Command name (without /) - change to "desc" for /desc
```

#### Display Settings

* **MaxDistance**: How close players need to be to see descriptions (in game units)
* **KeyBind**: The key code for displaying descriptions
  * Common key codes:
    * 20 = Z
    * 21 = Left Shift
    * 19 = Alt
    * 289 = F2
    * 170 = F3
* **TextScale**: Size of the description text (0.1 - 1.0)
* **TextFont**: Font style (0-8, see GTA V text fonts)
* **DefaultColor**: Default hex color for descriptions (#ffffff = white)
* **RefreshRate**: Performance optimization - how often to check when key is not pressed

#### Command Configuration

* **Command**: The chat command players use to set descriptions
  * Example: "desc" creates `/desc` command
  * Players can change this to any preferred command name

#### Translation System

The script includes a translation system in `config.lua`:

```lua
Config.Translations = {
    -- Commands
    command_description = "Set your character description",
    
    -- Dialog
    dialog_title = "Set Description",
    dialog_description_label = "Description",
    dialog_description_placeholder = "Enter your description (leave empty to remove)",
    dialog_color_label = "Color",
    
    -- Notifications
    notify_title = "Description",
    notify_removed = "Description removed",
    notify_set = "Description set!",
    
    -- Notification types
    notify_type_info = "info",
    notify_type_success = "success",
    notify_type_error = "error"
}
```