> For the complete documentation index, see [llms.txt](https://sbscripts.gitbook.io/sb-scripts/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sbscripts.gitbook.io/sb-scripts/sb-notify/configuration/config.md).

# Config

```lua
Config = {}

-- ─── Position ────────────────────────────────────────────────────────────────
-- Where notifications appear on screen.
-- Options: 'top-right' | 'top-left' | 'top-center' | 'bottom-right' | 'bottom-left' | 'bottom-center' | 'center-left' | 'center-right'
Config.Position = 'center-right'

-- ─── Behaviour ───────────────────────────────────────────────────────────────
Config.MaxNotifications = 6        -- Maximum on-screen at once (oldest auto-dismissed)
Config.DefaultLength    = 5000     -- Fallback duration in ms if none provided
Config.ClickToDismiss   = true     -- Allow clicking a notification to remove it early only if another ui is present. ie weapon crafting
Config.SoundEnabled     = true     -- Play a sound when a notification appears

-- ─── Notification Types ──────────────────────────────────────────────────────
-- Each type requires:
--   highlightColor  → any valid CSS color (hex, rgb, rgba, hsl …)
--   icon            → FontAwesome 6 class string (see https://fontawesome.com/icons)
--   label           → Short uppercase label shown above the message (optional)
--
-- You can add as many custom types as you want below the defaults.
Config.Types = {
    success = {
        highlightColor = '#22d27a',
        icon           = 'fa-solid fa-circle-check',
        label          = 'SUCCESS',
    },
    info = {
        highlightColor = '#4d9fff',
        icon           = 'fa-solid fa-circle-info',
        label          = 'INFO',
    },
    warning = {
        highlightColor = '#f0a500',
        icon           = 'fa-solid fa-triangle-exclamation',
        label          = 'WARNING',
    },
    error = {
        highlightColor = '#ff3b3b',
        icon           = 'fa-solid fa-circle-xmark',
        label          = 'ERROR',
    },
    police = {
        highlightColor = '#4488ff',
        icon           = 'fa-solid fa-shield-halved',
        label          = 'POLICE',
    },
    ems = {
        highlightColor = '#ff4f6a',
        icon           = 'fa-solid fa-heart-pulse',
        label          = 'EMS',
    },
    cash = {
        highlightColor = '#2ecc71',
        icon           = 'fa-solid fa-money-bill-wave',
        label          = 'CASH',
    },
    phone = {
        highlightColor = '#f38847',
        icon           = 'fa-solid fa-phone',
        label          = 'PHONE',
    },
    neutral = {
        highlightColor = '#8899aa',
        icon           = 'fa-solid fa-keyboard',
        label          = 'SYSTEM',
    },

    -- ── Custom example (uncomment to enable) ────────────────────────────────
    --[[
    mechanic = {
        highlightColor = '#e67e22',
        icon           = 'fa-solid fa-wrench',
        label          = 'MECHANIC',
    },
    ]]--
}

```