📌NOXEN NOTIFY

Noxen Notify

A simple, standalone, and highly customizable notification system for FiveM

📖 Introduction

Noxen Notify is a modern and flexible notification system designed to enhance communication on your FiveM server. With an elegant interface and extensive customization options, you can precisely control where and how your notifications appear on the screen.

✨ Features

🎯 Custom Positioning

Choose from 8 different positions for your notifications:

• top-left - Top left corner

• top-right - Top right corner

• bottom-left - Bottom left corner

• bottom-right - Bottom right corner

• center-top - Center top

• center-left - Center left

• center-right - Center right

• center-bottom - Center bottom

🔧 Standalone

• No dependencies required

• Works autonomously

• Easily adaptable to any server

🎨 Highly Customizable

• 4 notification types: success, error, info, warning

• Configurable display duration

• Custom sound support

• Image support

⚡ Easy to Use

• Quick installation

• Simple and intuitive API

• Built-in test command

📦 Installation

1. Download the resource

2. Place the noxen_notify folder in your resources directory

3. Add ensure noxen_notify to your server.cfg

4. Restart your server

⚙️ Configuration

The config.lua file allows you to customize the system behavior:

Config = {}

-- Default notification position
Config.Position = "center-left"

-- Enable /notify command for testing
Config.CommandTest = true

Configuration Options

Option	Type	Default	Description
Position	string	"center-left"	Notification position on screen
CommandTest	boolean	true	Enable/disable test command

💻 Usage

Main Event

The noxen:notify event is used to trigger a notification.

Parameters

Parameter	Type	Default	Description
title	string	"Notification"	Notification title
message	string	"Message"	Notification content
type	string	"info"	Type: success, error, info, warning
time	number	5000	Display duration in milliseconds
playSound	boolean	false	Play sound with notification
image	string	false	Image URL to display

Usage Examples

📱 Client Side

-- Simple notification
TriggerEvent("noxen:notify", "Success", "Action completed successfully", "success", 5000, true)

-- Notification with image
TriggerEvent("noxen:notify", "Information", "New message received", "info", 7000, true, "https://example.com/image.png")

-- Error notification
TriggerEvent("noxen:notify", "Error", "An error occurred", "error", 5000, true)

🖥️ Server Side

-- Notify a specific player
TriggerClientEvent("noxen:notify", source, "Welcome", "Good to see you back!", "success", 5000, true)

-- Notify all players
TriggerClientEvent("noxen:notify", -1, "Announcement", "Server will restart in 10 minutes", "warning", 10000, true)

🧪 Test Command

If Config.CommandTest is enabled, you can test the system with:

/notify [title] [message] [type] [duration] [sound] [image]

Example:

/notify "Test" "This is a test" "success" 5000 true

🎨 Notification Types

Success

TriggerEvent("noxen:notify", "Success", "Operation successful", "success", 5000, true)

• Color: Green

• Icon: Check

• Sound: success.mp3

Error

TriggerEvent("noxen:notify", "Error", "Something went wrong", "error", 5000, true)

• Color: Red

• Icon: Error

• Sound: error.mp3

Info

TriggerEvent("noxen:notify", "Info", "Important information", "info", 5000, true)

• Color: Blue

• Icon: Info

• Sound: info.mp3

Warning

TriggerEvent("noxen:notify", "Warning", "Be careful", "warning", 5000, true)

• Color: Orange

• Icon: Warning

• Sound: warning.mp3

🔊 Sounds

The system includes 4 preloaded sounds:

• sound/success.mp3

• sound/error.mp3

• sound/info.mp3

• sound/warning.mp3

Sounds can be customized by replacing the files in the sound/ folder.

🖼️ Images

You can add images to your notifications by providing a URL:

TriggerEvent("noxen:notify", "Title", "Message", "info", 5000, false, "https://example.com/image.png")

Recommendations:

• Use lightweight images (< 500 KB)

• Supported formats: PNG, JPG, GIF, WEBP

• Recommended ratio: square (1:1)

🎯 Use Cases

Mission System

-- Mission start
TriggerEvent("noxen:notify", "Mission", "New mission available", "info", 5000, true)

-- Mission success
TriggerEvent("noxen:notify", "Mission Completed", "You earned $500", "success", 7000, true)

Inventory System

-- Item added
TriggerEvent("noxen:notify", "Inventory", "You received 5x Bread", "success", 5000, true)

-- Inventory full
TriggerEvent("noxen:notify", "Inventory", "Your inventory is full", "error", 5000, true)

Administrative System

-- Player banned
TriggerClientEvent("noxen:notify", source, "Sanction", "You have been banned", "error", 10000, true)

-- Maintenance
TriggerClientEvent("noxen:notify", -1, "Maintenance", "Restarting in 5 minutes", "warning", 10000, true)

🛠️ Support & Community

Need help? Join our Discord community!

📝 License

This project is created by Noxen Scripts.

🔄 Changelog

Version 1.0.0

• ✅ Initial release

• ✅ Support for 8 positions

• ✅ 4 notification types

• ✅ Sound support

• ✅ Image support

• ✅ Test command

---

Noxen Notify - Because a well-placed message can make all the difference.