# BraveNotify

<figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2FzgKdKkCroe9XjIkloS5M%2FBraveNotify%20Discord%20Banner.png?alt=media&#x26;token=953fd38f-f3cc-45cd-8930-9eeb064a25b2" alt=""><figcaption></figcaption></figure>

A **simple** but **powerful** **modern** looking FiveM **Notification-System**.

## Preview / Showcase

{% embed url="<https://www.youtube.com/watch?v=PjH8GkDQaDo>" %}

## Displaying a Notification

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2FNXNB0QQ9Pw2OOvNjD9Es%2FFrame%20486.png?alt=media&#x26;token=ab38fbde-20ca-4322-86b9-41308bc3e43d" alt=""><figcaption></figcaption></figure></div>

#### Client Side

```lua
TriggerEvent('BraveNotify:Notify', 'type', "Title", "Message", time)
```

#### Server Side

```lua
TriggerClientEvent('BraveNotify:Notify', source, 'type', "Title", "Message", time)
```

### Arguments

#### Types

```
success
```

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2FNXNB0QQ9Pw2OOvNjD9Es%2FFrame%20486.png?alt=media&#x26;token=ab38fbde-20ca-4322-86b9-41308bc3e43d" alt=""><figcaption></figcaption></figure></div>

```
info
```

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2FRuzJtdPiomvcFeDtRGX1%2FFrame%20488.png?alt=media&#x26;token=5c06f044-0dc4-42fc-a633-1e8a43cdc709" alt=""><figcaption></figcaption></figure></div>

```
warning
```

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2FqiUDSQ0DvIrWVLfSS9FH%2FFrame%20492.png?alt=media&#x26;token=1d9a8789-cd63-404d-94e1-f4212739557f" alt=""><figcaption></figcaption></figure></div>

```
error
```

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2F0KkOAwBzS28K8TQwHm9J%2FFrame%20487.png?alt=media&#x26;token=5306dacc-9d1b-4af3-857a-7e7deab1ac4e" alt=""><figcaption></figcaption></figure></div>

```
message
```

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2Fynh3CO747gJMwS5DIB2O%2FFrame%20489.png?alt=media&#x26;token=500f6949-feab-4aeb-825d-e4d7c9a14f48" alt=""><figcaption></figcaption></figure></div>

```
lock
```

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2FpBwWLr7QLp4lHSSozkUC%2FFrame%20490.png?alt=media&#x26;token=fa9c7b67-7aa2-472c-8a17-4c2c4b8504ef" alt=""><figcaption></figcaption></figure></div>

```
unlock
```

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2Fnl5fSCYtQpU4JqWaO5BW%2FFrame%20491.png?alt=media&#x26;token=0eeb51b2-f335-4ff6-a065-5cc01c3e14d6" alt=""><figcaption></figcaption></figure></div>

#### Time

```
1000  (1 second)
5000  (5 seconds)
...
```

### Example

```lua
TriggerEvent('BraveNotify:Notify', 'success', "Bank", "Deposit successfull", 5000)
```

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2FXZIJvXxliY3JX6XWVzDa%2FFrame%20496.png?alt=media&#x26;token=c8e10dc5-88a2-4f91-b998-ac0ac91d4eb9" alt=""><figcaption></figcaption></figure></div>

## Displaying a custom Notification

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2FT1oy5LlK9bYbSzke5tnr%2FFrame%20495.png?alt=media&#x26;token=b4c9f41b-0d8f-4229-9964-b7edab3337b0" alt=""><figcaption></figcaption></figure></div>

#### Client Side

```lua
TriggerEvent('BraveNotify:CustomNotify', "Icon", "Color", "Title", "Message", time)
```

#### Server Side

```lua
TriggerClientEvent('BraveNotify:CustomNotify', source, "Icon", "Color", "Title", "Message", time)
```

### Arguments

#### Icon

You can chose every icon from Google Material Icons

{% embed url="<https://fonts.google.com/icons?icon.style=Rounded>" %}

```
check_circle
cancel
...
```

#### Color

```
#ffffff (White)
#000000 (Black)
...
```

#### Time

```
1000  (1 second)
5000  (5 seconds)
...
```

### Example

{% code overflow="wrap" %}

```lua
TriggerEvent('BraveNotify:CustomNotify', "settings", "#00E0FF", "Info", "You have changed your settings", 5000)
```

{% endcode %}

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2FLlR1trLMWk7tFy7vXK1Y%2FFrame%20497.png?alt=media&#x26;token=b9198fb4-1e2c-43e4-94bb-0227fc6b6b5f" alt=""><figcaption></figcaption></figure></div>

## Display an Announcement

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2FdvdFDqpJ9FIIUImHaAXD%2FFrame%20494.png?alt=media&#x26;token=beb8ab81-7582-4f3e-9915-51c6db85370c" alt=""><figcaption></figcaption></figure></div>

#### Client Side

```lua
TriggerEvent('BraveNotify:Announcement', "Icon", "Color", "Title", "Message", time)
```

#### Server Side

```lua
TriggerClientEvent('BraveNotify:Announcement', source, "Icon", "Color", "Title", "Message", time)
```

### Arguments

#### Icon

You can chose every icon from Google Material Icons

{% embed url="<https://fonts.google.com/icons?icon.style=Rounded>" %}

```
check_circle
cancel
...
```

#### Color

```
#ffffff (White)
#000000 (Black)
...
```

#### Time

```
1000  (1 second)
5000  (5 seconds)
...
```

### Example

{% code overflow="wrap" %}

```lua
TriggerClientEvent('BraveNotify:Announcement', source, "warning", "#fc2604", "Alert", "Server will restart in 10 minutes", 10000)
```

{% endcode %}

<div align="left"><figure><img src="https://1339164411-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMlIrE1gJVhyBbnpvXAqX%2Fuploads%2FzGTB9ZqjzfSrLJorXtWL%2FFrame%20498.png?alt=media&#x26;token=75d9222e-c94e-4db4-8bff-54f6fdd527c2" alt=""><figcaption></figcaption></figure></div>

## Customization

For more customization edit the config file :

{% content-ref url="bravenotify/config-file" %}
[config-file](https://bravescripts.gitbook.io/bravescripts/bravenotify/config-file)
{% endcontent-ref %}
