gm_notify

Join our new community if you need help

Join today!

Please read the docs first!

Visit gm_notify documentation

Features

• Multiple Notification Types: Supports different types of notifications (e.g., warning, primary, error, etc.).
• Custom Duration: Set custom display duration for each notification.
• Ox Library Integration: Optional integration with the ox_lib library for extended functionality.
• HTML/CSS/JavaScript Interface: Uses a web interface for rendering the notifications, allowing easy customization of the appearance.

Installation

1. Download or clone this repository.

2. navigate into the web folder and run

   npm i

3. once that's complete run

   npm run build

4. This will build the files found in the releases and the script should function normaly.

5. Add the following line to your server configuration (server.cfg):

   start gm_notify

6. If you want the script to function normaly you should probably not change the scripts name!

Usage

In your client scripts, you can trigger notifications using the following event:

Client side

TriggerEvent("ws_notify:client:Nofity", "notifyType", "message", duration)

Server side

TriggerClientEvent("ws_notify:client:Nofity", source, "notifyType", "message", duration)

• notifyType: The type of notification (e.g., warning, primary, etc.).
• message: The message you want to display.
• duration: (Optional) The duration of the notification display in milliseconds (default is 5000ms).

Ox Library Notification

If using ox_lib, notifications can be triggered using:

TriggerEvent("ox_lib:notify", data)

Where data is a table that can include the following fields:

• type: Notification type (e.g., success, error, etc.).
• title: The title of the notification.
• description: The description of the notification.
• duration: (Optional) The duration of the notification.

HTML Interface

The notifications are rendered using an HTML interface, allowing for customization of the look and feel of notifications. You can find the HTML, CSS files in the web directory.

Configuration

Configuration options are stored in the shared/client.lua file. You can modify options such as:

• ox_lib_replacement: Set this to true if you're using the ox_lib to handle notifications. Please visit our documentation for more info.

File Structure

gm_notify/
│
├── client/
│   ├── client.lua            # Handles the client-side notification logic.
│   ├── debug.lua             # Debugging tools for the notification system.
│
├── shared/                   # Shared configuration files between client and server.
│   └── client.lua
│
├── fxmanifest.lua             # Resource manifest for FiveM.
├── web/                      # web assets.

Development

1. Modifying Notification UI: You can customize the HTML/CSS files in the web folder to change the look and feel of the notifications.
2. If you want to make changes to the script you can run it on a browser with:

   npm run dev

Requirements

• ox_lib

Contributing

Feel free to contribute by submitting issues or pull requests.