gfx-notify

Info

Dependencies

• None (standalone script)

Installation

1. Copy Files

Place the gfx-notify folder into your server's resources directory.

2. server.cfg

ensure gfx-notify

Configuration

Configuration is done in config.lua.

Default Key

Config.DefaultKey = "F4"

The key used to enable mouse cursor for interacting with notifications (e.g., answering question prompts). Players can rebind this in FiveM keybind settings.

Settings Command

Config.SettingsCommand = "notifysettings"

The command that opens the in-game notification settings panel.

Notification Types

Custom notification types are defined in Config.Types. Each type has a color theme, icon, default duration, and sound.

Config.Types = {
    ["police"] = {
        color = "blue",           -- Color theme (blue, yellow, darkblue, orange, purple)
        icon = "assets/icon1.png", -- Icon image path (relative to nui/)
        time = 1000,              -- Default duration in ms
        sound = "NAV",            -- GTA sound name
        soundDirectory = "HUD_AMMO_SHOP_SOUNDSET" -- GTA sound set
    },
    ["ambulance"] = {
        color = "yellow",
        icon = "assets/icon3.png",
        time = 5000,
        sound = "NAV",
        soundDirectory = "HUD_AMMO_SHOP_SOUNDSET"
    },
}

Available Colors

Available Icons

You can add your own icons to the nui/assets/ folder and reference them in the config.

Exports

Notify (Client)

Displays a notification on screen.

exports['gfx-notify']:Notify(type, title, text, duration, icon)

Example:

exports['gfx-notify']:Notify("police", "Police Alert", "Suspicious activity reported nearby", 5000)

Question (Client)

Displays an interactive yes/no question prompt. The player can respond via mouse click or keyboard (Y/N) depending on their settings.

exports['gfx-notify']:Question(text, duration, successCallback, failCallback)

Example:

exports['gfx-notify']:Question("Do you want to accept this offer?", 10000, function()
    print("Player accepted")
end, function()
    print("Player declined")
end)

Events

gfx-notify:Notify (Client)

Triggers a notification on the target client. Can be called from server-side to send notifications to specific players.

-- From server-side:
TriggerClientEvent("gfx-notify:Notify", targetSource, type, title, text, duration, icon)

-- From client-side:
TriggerEvent("gfx-notify:Notify", type, title, text, duration, icon)

Example (server-side):

-- Send to a specific player
TriggerClientEvent("gfx-notify:Notify", source, "police", "Dispatch", "Report to station immediately", 5000)

-- Send to all players
TriggerClientEvent("gfx-notify:Notify", -1, "ambulance", "EMS Alert", "Mass casualty incident reported", 8000)

gfx-notify:Question (Client)

Triggers a question prompt on the target client.

-- From server-side:
TriggerClientEvent("gfx-notify:Question", targetSource, text, duration, successCallback, failCallback)

-- From client-side:
TriggerEvent("gfx-notify:Question", text, duration, successCallback, failCallback)

Note: Callback functions only work when triggered from client-side. When triggering from server-side, callbacks cannot be passed over the network. Use the export instead for callback functionality.

Commands

The mouse cursor keybind (default F4) is registered via RegisterKeyMapping and can be rebound by players in FiveM Settings > Key Bindings > GTA Online.

Features

• Styled Notifications -- Multiple color themes (blue, yellow, darkblue, orange, purple) with animated effects
• Question Prompts -- Interactive yes/no prompts with mouse and keyboard support (Y/N keys)
• Settings Panel -- In-game settings UI where players can:
  • Show/hide notifications
  • Mute/unmute notification sounds
  • Switch question controls between mouse and keyboard
  • Drag to reposition the notification area
  • Change notification stack direction (normal/reverse)
  • Save preferences (persisted in browser localStorage)
  • Restore defaults
• Sound Effects -- Configurable GTA native sounds per notification type
• Custom Icons -- Each notification type supports its own icon
• Standalone -- No framework dependency, works on any FiveM server
• Escrow Ready -- All Lua files are in escrow_ignore

Troubleshooting

Source

• GitHub: https://github.com/gfx-fivem/gfx-notify
• Organization: GFX-Fivem