# okokNotify

[**YouTube Video**](https://www.youtube.com/watch?v=xDqu0GAORwI)

## Installation Guide

### Displaying a notification

#### Client side

```lua
exports['okokNotify']:Alert('Title', 'Message', Time, 'type', playSound)
```

#### Server side

```lua
TriggerClientEvent('okokNotify:Alert', source, 'Title', 'Message', Time, 'type', playSound)
```

Time:

* 1000 = 1 second.

Types: 

* success (<mark style="color:green;">green</mark>);
* info (<mark style="color:blue;">blue</mark>);
* warning (<mark style="color:yellow;">yellow</mark>);
* error (<mark style="color:red;">red</mark>);
* phonemessage (<mark style="color:orange;">orange</mark>);
* neutral (grey).

playSound - true/false.

### Adding new colors/notification types

Navigate to the **config.lua** file and just replicate the existing examples.

### Server artifacts

Make sure your server artifacts version is above the **5181**.

* Windows: <https://runtime.fivem.net/artifacts/fivem/build_server_windows/master/>
* Linux: <https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/>