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

# ⚙️  Configuration

All public settings are located in:

```
kc_carplay/config.lua
```

## Command

```lua
Config.Command = 'carplay'
```

Default command:

```
/carplay
```

## Open keybind

```lua
Config.Keybind = 'J'
```

Players can rebind this in **FiveM Settings > Key Bindings > FiveM**.

## Volume keybinds

```lua
Config.VolumeUpKey = 'PAGEUP'
Config.VolumeDownKey = 'PAGEDOWN'
```

Players can rebind these in **FiveM Settings > Key Bindings > FiveM**.

## Volume key step

```lua
Config.VolumeKeyStep = 0.05
```

`0.05` changes the volume by 5% per press.

For 10% per press:

```lua
Config.VolumeKeyStep = 0.10
```

## Driver outside volume control distance

```lua
Config.NearbyVolumeControlDistance = 10.0
```

After the driver exits the vehicle, Page Up and Page Down continue controlling only that driver's linked vehicle music session while the vehicle remains within this distance.

The script does not automatically select another nearby vehicle.

## Audio distance

```lua
Config.AudioDistance = 25.0
```

This controls the maximum audible distance for positional vehicle audio.

The audio naturally becomes quieter as the listener moves away and louder as the listener approaches.

## Default volume

```lua
Config.DefaultVolume = 0.20
```

`0.20` equals 20% volume.

## Maximum volume

```lua
Config.MaxVolume = 0.50
```

`0.50` equals a maximum selectable volume of 50%.

## Default passenger control

```lua
Config.AllowPassengers = false
```

When `false`, new vehicle sessions begin with passenger controls disabled.

The driver can toggle passenger controls directly from the Vehicle Music System interface.

## Debug mode

```lua
Config.Debug = false
```

Keep debug mode disabled on a production server unless troubleshooting an issue.
