> For the complete documentation index, see [llms.txt](https://mango-5m.gitbook.io/mango5m-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://mango-5m.gitbook.io/mango5m-docs/free-resources/mango-notify/getting-started/quick-start.md).

# Quick Start

Your first notifications — from a client script, a server script, and an event.

Every field in every call below is **optional** — Mango Notify fills in sensible defaults from `config.lua` for anything you leave out.

## From a client script

```lua
-- The simple helpers: (title, description, duration)
exports.mango_notify:Success('Vehicle stored', 'Your Sultan RS is now in garage B.')
exports.mango_notify:Error('Access denied', 'You do not have the keys for this vehicle.')
exports.mango_notify:Warning('Low fuel', 'Your vehicle is running below 10% fuel.')
exports.mango_notify:Info('New message', 'You have received a new text message.')

-- Money: the sign picks the direction automatically
exports.mango_notify:Money(2500)    -- "You received: 2,500$" (green)
exports.mango_notify:Money(-800)    -- "You paid: 800$" (red)
```

The full `Notify` export takes a table and unlocks every feature:

```lua
exports.mango_notify:Notify({
    type        = 'dispatch',
    title       = 'Officer Smith',
    subtitle    = 'LSPD',
    description = 'Shots fired reported.',
    location    = 'Alta Street',
    distance    = '1.2km',
    badge       = 'Priority 2',
    badgeColor  = '#FF4B4B',
    icon        = 'fa-solid fa-shield-halved',
    progress    = true,
    duration    = 8000,
    sound       = 'dispatch',
})
```

## From a server script

Server exports take the target player id first — use `-1` for everyone online:

```lua
exports.mango_notify:Success(playerId, 'Paycheck', 'You received your salary.')
exports.mango_notify:NotifyAll({ title = 'Server restart', description = 'Restarting in 5 minutes.' })
```

## From events

Prefer events? Everything is also exposed under both the `notify:*` and `mango_notify:*` prefixes:

```lua
-- client
TriggerEvent('notify:success', 'Saved', 'Your outfit has been saved.')

-- server (server-side scripts only)
TriggerEvent('notify:server:info', playerId, 'Welcome', 'Enjoy your stay!')
```

{% hint style="info" %}
The complete list of fields lives in Notification Fields; the full API surface is covered in Client Exports, Server Exports, and Events.
{% endhint %}