aura_notify

Aura Notify v2 Documentation

Features

• 8 Notification Types: Success, Error, Warning, Cash, Bank, Police, EMS, and Info notifications

• Smooth Animations: Clean & Neat transitions for reactiveness.

• Sound Effects: Alert Sound FX on notification show.

• Progress Bars: Visual duration indicators for notifications

• Customizable Positions: Fully customizable from a player's POV, allowing total freedom

• Standalone: Works with all frameworks

Installation

1. Download the Resource:

   • Purchase and download the aura_notify-v2 resource from the official tebex store.

2. Extract Files:

   • Extract the aura_notify-2 folder into your server's resources directory.

   • Place it in the resources folder for organization.

3. Add to Server Configuration:

   • Open your server.cfg file.

   • Add the following line:

     ensure aura_notify

4. Restart Server:

   • Restart your server to load the resource.

Usage

Snippets For Frameworks

ESX Legacy

Replace the ESX.ShowNotification function in es_extended/client/functions.lua:

---@param message string The message to show
---@param notifyType? string The type of notification to show
---@param length? number The length of the notification
---@param title? string The title of the notification
---@param position? string The position of the notification
---@return nil
function ESX.ShowNotification(message, notifyType, length, title, position)
    return IsResourceFound('aura_notify-v2') and exports['aura_notify-v2']:Notify({
        type = notifyType or "info",
        message = message,
        duration = length or 5000,
    })
end

This replaces all existing ESX notifications to use Aura Notify.

QB-Core

Replace the QBCore.Functions.Notify function in qb-core/client/functions.lua:

---@param text string The notification text
---@param texttype? string The type of notification
---@param length? number The duration in milliseconds
---@param title? string The title of the notification
---@param position? string The position of the notification
---@return nil
   function QBCore.Functions.Notify(text, texttype, length, icon)
       local notifyText = text
       if type(text) == 'table' then
           notifyText = text.text or 'Aura Roleplay'
       end

       local typeMap = {
           primary = 'info',
           success = 'success',
           error = 'error',
           warning = 'warning',
           cash = 'cash',
           bank = 'bank',
           police = 'police',
           ems = 'ems'
       }

       local mappedType = typeMap[texttype] or 'info'
       local duration = length or 5000

       exports['aura_notify-v2']:Notify(notifyText, mappedType, duration)
   end

This ensures all QB-Core notifications use Aura Notify.

Example Usage in Scripts

-- Trigger a success notification
exports['aura_notify-v2']:Notify({
   type = 'success',
   message = 'Action completed successfully.',
   length = 5000
})

-- Trigger an error notification
exports['aura_notify-v2']:Notify({
   type = 'error',
   message = 'Something went wrong.',
   length = 5000
})

Notification Types

• success: Green notification for positive actions

• error: Red notification for errors

• warning: Yellow notification for warnings

• cash: Cash-related notifications

• bank: Bank-related notifications

• police: Police department notifications

• ems: Emergency medical services notifications

• info: General information notifications

Parameters

• type: The notification type (string)

• message: The notification message (string)

• length: Duration in milliseconds (number, optional)

Support

For support, join our Discord server: https://discord.gg/2q8ZBSWPv7

Version

Current Version: 2.0