> For the complete documentation index, see [llms.txt](https://cylexdev.gitbook.io/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cylexdev.gitbook.io/docs/scripts/cylex-notification/introduction.md).

# Introduction

Cylex Notification is a free notification system for FiveM. Five types, nine positions, sounds, a settings panel for every player, and exports for client and server scripts.

<div data-full-width="true"><figure><img src="https://2441530673-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtxqtJ91rcI0EHH3xURdT%2Fuploads%2F60id39zwrJJX0EdTNEiH%2Fcylex-notification.png?alt=media" alt="Cylex Notification"><figcaption></figcaption></figure></div>

Cylex Notification shows the messages of your scripts on the screen: a payment went through, a car is locked, a restart is coming.\
Your scripts send a notification with one export or event, and every player can change how notifications look for them in a settings panel.\
It is free, runs on every framework or without one, and all its Lua files are open to edit.

### Key Features

* Five types: success, error, warning, info and announcement. Each type has its own colour, icon, sound and time on screen.
* Nine positions, four animations (slide right, slide left, fade in, bounce) and three sizes (compact, normal, big).
* A progress bar that shows how long the notification stays.
* A settings panel for every player (`/notifysettings`): colour, icon, glow and sound per type, plus volume, width, opacity, size, animation, theme, position, spacing and more. With a live preview and a list of the last 10 notifications.
* Morning, evening or dynamic theme. Dynamic follows the game clock: morning from 06:00 to 18:00, evening the rest of the day.
* Player settings are saved on the player's PC and come back on the next join.
* Client and server exports, and events. A server script can send to one player or to everyone.
* Force the position, animation or size of one notification, for example a restart warning in the top centre.
* 8 languages: English, Turkish, Arabic, Spanish, French, Korean, Portuguese and Chinese.
* A test command that shows all five types.

### Installation Steps

{% content-ref url="/pages/OGcAo6j01sqWL4bcn23i" %}
[Installation & Configuration](/docs/scripts/cylex-notification/installation-and-configuration.md)
{% endcontent-ref %}

{% content-ref url="/pages/F8AkBblyRJCeubZ4d6HW" %}
[Exports & Events](/docs/scripts/cylex-notification/exports-and-events.md)
{% endcontent-ref %}

{% content-ref url="/pages/cZpkbNRizoQxFZcWxWN1" %}
[Replacing Framework Notifications](/docs/scripts/cylex-notification/replacing-framework-notifications.md)
{% endcontent-ref %}

### Dependencies

None. It does not need a framework, a database or any other script.

The notification page loads its fonts and icons from Google Fonts and cdnjs. Players need a normal internet connection for them.

### What You Can Edit

| File / Folder                                 | Editable?                                                    |
| --------------------------------------------- | ------------------------------------------------------------ |
| `config.lua`                                  | Yes — all settings                                           |
| `locales/*.lua`                               | Yes — the texts of the settings panel and the default titles |
| `client/main.lua`, `server/main.lua`          | Yes — open Lua                                               |
| `html/sounds/*.mp3`                           | Yes — replace them with your own sounds                      |
| `html/index.html`, `html/js/`, `html/assets/` | No — the built page. Any change is lost with the next update |

### Support

Store: <https://cylexdev.com>\
Discord: <https://discord.gg/cylexstore>