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

# Full Configuration Breakdown

### 🌍 Server-Side Configuration (`config.lua`)

#### Default Key Testing

```lua
Config.DefaultKey = 'E' -- Default key to show in notifications if none specified
```

#### Test Point

```lua
Config.EnableTestPoint = true -- Set to false to disable the test point

Config.TestPoint = {
    coords = vector3(-269.4, -955.3, 30.2), -- Coordinates for the test point
    distance = 3.5, -- Distance threshold for displaying the notification
    helpText = "Press to interact", -- Text displayed in the notification
    marker = {
        type = 1, -- Type of marker (1 = arrow)
        size = vector3(3.0, 3.0, 0.5), -- Size of the marker
        color = {r = 0, g = 255, b = 0, a = 25}, -- Color of the marker (green with transparency)
        bobUpAndDown = false, -- Whether the marker should bob up and down
        faceCamera = false, -- Whether the marker should face the camera
        rotate = false -- Whether the marker should rotate
    }
}
```

#### Text Cleaning Function

```lua
function CleanText(text, key)
    local cleanedKey = type(key) == "string" and key:gsub("~%l~", "") or Config.DefaultKey
    local cleanedText = "Standard help text"
    
    if type(text) == "string" then
        cleanedText = text
            :gsub("~INPUT_CONTEXT~", "E") -- Replace "~INPUT_CONTEXT~" with "E"
            :gsub("~%l~", "") -- Remove other special characters
    end
    
    return cleanedKey, cleanedText
end
```

***

### 🎨 Frontend UI Configuration (`html/config.js`)

#### Notification Settings

```javascript
const Config = {
    // Default position of the notification
    DefaultPosition: 'bottom-middle', // Options: top-left, top-middle, top-right, middle-left, center, middle-right, bottom-left, bottom-middle, bottom-right
    
    // Position percentages for fine-tuning
    PositionPercentages: {
        top: 20, // % from top (when using top positions)
        bottom: 7, // % from bottom (when using bottom positions)
        left: 5, // % from left (when using left positions)
        right: 5, // % from right (when using right positions)
    },
    
    // Scale of the notification
    DefaultScale: 1.0 // 1.0 is default, adjust for larger/smaller notifications
}
```

#### Appearance Settings

```javascript
// Background color with opacity (RGBA format)
BackgroundColor: {r: 0, g: 0, b: 0, a: 0.4},
TextColor: {r: 255, g: 255, b: 255, a: 1.0}, // Text color
ButtonColor: {r: 0, g: 255, b: 0, a: 0.1}, // Button color with transparency
BorderRadius: '8px', // Rounded corners
FontFamily: 'Poppins, sans-serif', // Font family for the UI
```

#### Button Size

```javascript
ButtonSize: {
    width: 50, // Width of the button in pixels
    height: 50, // Height of the button in pixels
    fontSize: 26 // Font size of the button text in pixels
}
```

#### Glass Effect

```javascript
GlassEffect: true, // Enable/disable glass effect
GlassBlur: 4, // Strength of the blur effect in pixels
GlassOpacity: 0.6, // Opacity of the glass effect
```

#### Glow Effect

```javascript
GlowEffect: true, // Enable/disable glow effect
GlowColor: {r: 0, g: 255, b: 0, a: 0.7}, // Color of the glow effect (RGBA format)
GlowSpread: '10px', // Spread of the glow effect
```

***

### 🔄 Usage Examples

#### Basic Usage

```lua
-- Show a help notification with a key and text
exports['X_HUD_HelpNotification']:ShowHelpNotification('E', 'Press to interact')
```

#### Event Trigger

```lua
-- Trigger the notification event with a key and text
TriggerEvent('helpnotify', 'E', 'Press to interact')
```

#### Alternative Event

```lua
-- Alternative event name
TriggerEvent('X_HUD_HelpNotification:showHelpNotification', 'E', 'Press to interact')
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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://fiveworld.gitbook.io/fiveworld-docs/x_hud_helpnotify/full-configuration-breakdown.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.