> ## Documentation Index
> Fetch the complete documentation index at: https://coolcars.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Global Config (config.yml)

> Global settings for CoolCars: database, language, key system, and UI.

The `config.yml` file is located in the plugin's root folder (`plugins/CoolCars/config.yml`) and contains settings that affect the entire plugin.

## Key System (`keys`)

This section defines how players access vehicles. You can create a GTA-style server where cars can be started without a key, or an RP-style server where a key is mandatory.

```yaml theme={null}
keys:
  enabled: true                         # Enable the key system
  require-key-to-start-engine: true     # Is a key required to start
  allow-owner-start-without-key: true   # Owner can start without a key
  check-entire-inventory: true          # Search for key in the entire inventory
```

<Info>
  If `check-entire-inventory` is disabled, the player must hold the key in their main or off-hand to start the engine.
</Info>

***

## User Interface (Action Bar)

CoolCars displays important information (speed, fuel, status) directly above the player's hotbar.

### Speedometer Settings (`ui.action-bar.car`)

* **format**: The string displayed to the player. Supports many placeholders.
* **update-ticks**: Update frequency. `2` ticks is the ideal balance between smoothness and performance.

**Available Placeholders:**

* `{speed_kmh}` — Speed in km/h.
* `{hp_bar}` — Health bar.
* `{fuel_percent}` — Fuel percentage.
* `{engine}` — Engine status (On/Off).

<Frame caption="Action Bar example while driving">
  <img src="https://mintcdn.com/coolcars/2OnMYzpvWPxiQePr/images/coolcars/actionbar-preview.png?fit=max&auto=format&n=2OnMYzpvWPxiQePr&q=85&s=967b4fda42c71e3b6de7b36498bf2084" width="1883" height="147" data-path="images/coolcars/actionbar-preview.png" />
</Frame>

***

## Language Settings (`language`)

The plugin supports automatic player language detection.

* **global**: If `true`, all players will see messages in the language specified in `default`.
* **use-player-locale**: If `true`, the plugin will check the language selected in the player's Minecraft client (EN, RU, etc.).

***

## Database (`database`)

CoolCars saves data about car owners, their condition, and location.

* **type**: `sqlite` (file) or `mysql` (for cross-server sync).
* **telemetry**: If enabled, the plugin records event history (crashes, refueling) that can be viewed later.

***

## Commands (`commands`)

You can restrict the use of certain administrative commands.
For example, `car-heal` allows instantly repairing a car. You can allow or deny the use of this command from the server console in the config.

```yaml theme={null}
commands:
  car-heal:
    enabled: true
    allow-console: true
```
