Skip to main content
sh-notify renders clean, stacked toast notifications in the top-right corner of the screen, giving players immediate visual feedback for in-game events. Each notification plays a short UI sound on appearance, displays for a configurable duration, and then auto-dismisses without any additional code on your end. Because the resource exposes a single Lua export, you can trigger notifications from any client-side script on your server — including your own custom resources and other SH Development scripts that support it.

​
Installation

1

Add the resource to your server

Place the sh-notify folder inside your server’s resources directory.
2

Start sh-notify before dependent scripts

Open server.cfg and ensure sh-notify is listed before any resource that calls its export. FiveM resolves exports at runtime, but starting it first avoids race conditions on server boot.
server.cfg
Many SH Development scripts use sh-notify as their default notification handler. Set Config.Notify = 'sh' inside those scripts’ config files to route their alerts through sh-notify automatically.

​
Export Reference

Trigger a notification from any client-side Lua script using the shnotif export:

​
Parameters

​
string
required
A Font Awesome 5 class string that determines the icon displayed on the left side of the notification. Use the full class string as it appears in Font Awesome’s documentation.Example: 'fas fa-check-circle'
​
string
required
The bold heading displayed above the horizontal divider inside the notification card.Example: 'Vehicle Spawned'
​
string
required
The body text displayed below the divider. Use this to provide detail or context for the notification.Example: 'Your vehicle has been delivered to the garage.'
​
string
required
Controls the color theme of the notification card. Must be one of the three values below.
​
number
required
How long the notification stays on screen, in milliseconds. After this duration the card fades out and is removed from the stack automatically.Example: 5000 (5 seconds)

​
Usage Examples

The following examples demonstrate all three notification types. Copy the relevant line into your client-side script and adjust the text to suit your use case.
Use success to confirm that an action completed without errors.

​
Notification Stacking

When multiple notifications are triggered in quick succession, sh-notify stacks them vertically in the top-right corner of the screen. Each card is independent — it starts its own dismiss timer when it appears, so earlier notifications expire first regardless of how many are queued behind them.
Browse the full Font Awesome 5 free icon library at fontawesome.com/icons to find icon class strings. Only the free tier icons are available in NUI without additional setup.