> For the complete documentation index, see [llms.txt](https://crimvex-studio.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://crimvex-studio.gitbook.io/docs/scripts/crimvex-notify/configuration.md).

# Configuration

This page explains all available configuration options for Crimvex Notify (FiveM Notification Script). The script uses FiveM Asset Escrow, but the configuration file is fully editable.

### 🔒 Escrow Information

* Core logic is protected
* UI (HTML, CSS, JS) is encrypted
* Only the configuration file is editable

***

### 📁 Config File Location

```id="cfgpath01"
shared/config.lua
```

***

### ⚙️ Full Configuration

```lua
Config = {}

Config.Debug = {
    enable = true,
    commandName = "testNoti"
}

Config.Position = "middle-right"

Config.NotificationSound = true

Config.DefaultNotificationDisplayTime = 5000

Config.NotificationColors = {
    backgroundColor = "#151515",
    success = "#2eb61d",
    info = "#2183DE",
    warn = "#DEBD21",
    error = "#DE2E21",
}

Config.DefaultNotificationIcons = {
    success = "fa-regular fa-circle-check",
    info = "fa-solid fa-circle-info",
    warn = "fa-solid fa-triangle-exclamation",
    error = "fa-solid fa-circle-xmark",
}
```

***

### 🧠 Configuration Breakdown

#### 🔹 Debug Settings

```lua
Config.Debug = {
    enable = true,
    commandName = "testNoti"
}
```

* **enable (boolean)**\
  Enables debug mode\
  Useful for testing notifications
* **commandName (string)**\
  Command to trigger test notification\
  Example:

  ```
  /testNoti
  ```

***

#### 📍 Notification Position

```lua
Config.Position = "middle-right"
```

Defines where notifications appear on screen.

**Available Positions:**

* `middle-right`
* `middle-left`
* `top-left`
* `top-right`
* `top-middle`
* `bottom-left`
* `bottom-middle`
* `bottom-right`

💡 Choose based on your UI layout to avoid overlap with HUD elements.

***

#### 🔊 Notification Sound

```lua
Config.NotificationSound = true
```

* **true** → sound enabled
* **false** → sound disabled

💡 Disable if you want a silent UI experience.

***

#### ⏱ Default Display Time

```lua
Config.DefaultNotificationDisplayTime = 5000
```

* Time in milliseconds
* Example:
  * `5000` = 5 seconds
  * `3000` = 3 seconds

💡 Used when no custom duration is provided.

***

#### 🎨 Notification Colors

```lua
Config.NotificationColors = {
    backgroundColor = "#151515",
    success = "#2eb61d",
    info = "#2183DE",
    warn = "#DEBD21",
    error = "#DE2E21",
}
```

Customize notification appearance using HEX colors.

* **backgroundColor** → main background
* **success** → success notifications
* **info** → info notifications
* **warn** → warning notifications
* **error** → error notifications

💡 Use HEX format (`#RRGGBB`)

***

#### 🎯 Default Icons (FontAwesome)

```lua
Config.DefaultNotificationIcons = {
    success = "fa-regular fa-circle-check",
    info = "fa-solid fa-circle-info",
    warn = "fa-solid fa-triangle-exclamation",
    error = "fa-solid fa-circle-xmark",
}
```

* Uses **FontAwesome icons**
* You can replace with any valid class

🔗 Icon Library: <https://fontawesome.com/icons>

***

### 💡 Best Practices

* Keep colors consistent with your server theme
* Avoid very bright colors (bad UX)
* Match notification position with HUD layout
* Disable debug mode in production

***

### ⚠️ Important Notes

* UI layout cannot be modified
* Only config values can be changed
* Restart resource after editing config

```id="restartcfg01"
ensure crimvex-notify
```

***