# Config Settings

## Configuration Settings

The system offers a flexible `shared/config.lua` allowing server administrators to tailor the overall functionality and performance load to their specific operational needs.

Below is a detailed breakdown of every configuration option.

### Core Settings

| Setting          | Type      | Default    | Description                                                                                                                                                           |
| ---------------- | --------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Locale`         | `string`  | `'en'`     | The active language for the menu and in-game text. Available options: `'tr'`, `'en'`, `'de'`, `'ru'`.                                                                 |
| `RequireVehicle` | `boolean` | `true`     | When set to `true`, the holographic route system will only activate if the player sets a waypoint while driving a vehicle. If `false`, the system also works on foot. |
| `MenuCommand`    | `string`  | `'armenu'` | The chat command players use to open the comprehensive UI settings panel.                                                                                             |
| `UnitSystem`     | `string`  | `'km'`     | The geographical measurement metric for distance calculations. Use `'km'` for Kilometers or `'mil'` for Miles.                                                        |

### Visual Parameters

| Setting         | Type     | Default | Description                                                                                                                 |
| --------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------- |
| `DrawDistance`  | `number` | `150.0` | The maximum distance (in GTAV units) that 3D path markers (chevrons) will dynamically render ahead of the player's vehicle. |
| `MarkerZOffset` | `number` | `2.5`   | Sets how high the final destination hologram floats above the exact ground coordinates.                                     |

### System Optimization (Tick Rates)

The system has been heavily optimized with dynamic thread sleeping to prevent CPU spikes. The `TickRates` table controls the milliseconds (ms) delay of various resource loops.

> **Important**: Increasing these values saves more CPU processing power (Resmon), whereas decreasing them provides faster, sharper data updates for the visual elements.

* **`RouteDistanceCalc`** (`2000`): Determines how frequently the script calculates the exact remaining distance to the waypoint.
* **`VehicleCheck`** (`200`): The thread delay used to verify vehicle entry/exit status when `RequireVehicle` is enabled.
* **`NoWaypoint`** (`1000`): The sleep time when the system idles waiting for a player to place a map waypoint.
* **`SystemDisabled`** (`1000`): The sleep time when the player manually toggles off the entire system via the UI settings.
* **`TurnCalculation`** (`500`): The core engine frequency for scanning street paths ahead and generating the 3D curves.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.0resmon.org/0resmon/frkn-resources/frkn-waypoint/config-settings.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.