> For the complete documentation index, see [llms.txt](https://ayccoes-assets.gitbook.io/ayccoes-assets/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ayccoes-assets.gitbook.io/ayccoes-assets/ayc-hud/translations.md).

# Translations

This section defines all text labels used throughout the HUD, including compass directions, weather names, and UI text for the settings menu.

The `Labels` table is used to control all user-facing text, making it easy to translate or customize the HUD interface without modifying core logic.

You can find these translations in `shared/translation.lua`.

***

## Compass Labels

Defines shorthand direction labels used in the HUD compass.

```lua
Labels.Compass = {
    north = "N",
    northEast = "NE",
    east = "E",
    southEast = "SE",
    south = "S",
    southWest = "SW",
    west = "W",
    northWest = "NW"
}
```

### Description

| Key       | Label |
| --------- | ----- |
| north     | N     |
| northEast | NE    |
| east      | E     |
| southEast | SE    |
| south     | S     |
| southWest | SW    |
| west      | W     |
| northWest | NW    |

***

## Weather Labels

Defines readable names for in-game weather types.

```lua
Labels.Weather = {
    EXTRASUNNY = "Extra Sunny",
    CLEAR = "Clear",
    NEUTRAL = "Neutral",
    SMOG = "Smog",
    FOGGY = "Foggy",
    OVERCAST = "Overcast",
    CLOUDS = "Cloudy",
    CLEARING = "Clearing",
    RAIN = "Rainy",
    THUNDER = "Thunder",
    SNOW = "Snow",
    BLIZZARD = "Blizzard",
    SNOWLIGHT = "Light Snow",
    XMAS = "Snow",
    HALLOWEEN = "Spooky"
}
```

### Usage

These labels are displayed in world information UI elements when showing current weather conditions.

***

## Settings Labels

Defines all text used in the HUD settings menu UI.

```lua
Labels.Settings
```

This section controls every label, button text, and UI string displayed in the settings interface.

***

### Main UI Text

| Key              | Label              |
| ---------------- | ------------------ |
| hudSettings      | HUD Settings       |
| customizeYourHUD | Customize your HUD |

***

### Section Titles

| Key         | Label        |
| ----------- | ------------ |
| general     | General      |
| visibility  | Visibility   |
| cinematic   | Cinematic    |
| colors      | Colors       |
| editOverlay | Edit Overlay |

***

### General Buttons

| Key | Label |
| --- | ----- |
| off | Off   |
| on  | On    |

***

### Color Labels

Defines names for HUD color customization options.

| Key              | Label                |
| ---------------- | -------------------- |
| theme            | Primary              |
| armor            | Armor                |
| hunger           | Hunger               |
| thirst           | Thirst               |
| stress           | Stress               |
| talking          | Talking              |
| RPMMed           | Vehicle RPM Medium   |
| RPMHigh          | Vehicle RPM High     |
| danger           | Danger               |
| gearReverse      | Vehicle Gear Reverse |
| gearNeutral      | Vehicle Gear Neutral |
| bankBalance      | Bank Balance         |
| cinematicBars    | Cinematic Bars       |
| weaponDurability | Weapon Durability    |

***

### Style Options

| Key   | Label |
| ----- | ----- |
| style | Style |
| sharp | Sharp |
| round | Round |

***

### Perspective

| Key         | Label       |
| ----------- | ----------- |
| perspective | Perspective |

***

### Color Mode

| Key        | Label      |
| ---------- | ---------- |
| colorMode  | Color Mode |
| monochrome | Monochrome |
| colorful   | Colorful   |

***

### Speedometer Units

| Key             | Label            |
| --------------- | ---------------- |
| speedometerUnit | Speedometer Unit |
| kmh             | KM/H             |
| mph             | MPH              |

***

### Compass Settings

| Key         | Label        |
| ----------- | ------------ |
| compass     | Compass      |
| compassBase | Compass Base |
| camera      | Camera       |
| character   | Character    |

***

### Visibility Options

| Key     | Label   |
| ------- | ------- |
| always  | Always  |
| vehicle | Vehicle |
| command | Command |
| dynamic | Dynamic |

***

### HUD Components

| Key           | Label         |
| ------------- | ------------- |
| worldInfo     | World Info    |
| balance       | Balance       |
| map           | Map           |
| playerStatus  | Player Status |
| vehicleHUD    | Vehicle HUD   |
| weaponHUD     | Weapon HUD    |
| notifications | Notifications |

***

### Cinematic Options

| Key           | Label          |
| ------------- | -------------- |
| cinematicMode | Cinematic Mode |
| cinematicBars | Cinematic Bars |

***

### Edit Mode

| Key      | Label     |
| -------- | --------- |
| editMode | Edit Mode |
| done     | Done      |

***

### Notifications Preview

Example placeholder text used in edit overlay UI preview:

```lua
notificationsPreview = {
    "Your Notifications go here.",
    "And also here.",
    "And goes up."
}
```

***

## Commands

Defines command hints shown in help text in settings menu.

```lua
Labels.Commands = {
    compass = "/compass",
    world = "/worldinfo",
    balance = "/cash or /bank",
    cinematicMode = "/cinematic",
    cinematicBars = "/cinematicbars",
    guide = "Use [command] to toggle."
}
```