Notifications

Download Here

FiveM Forums Post

INSTALLATION GUIDE

Step 0 - First Steps

WARNING

1. Download your resource from Our Website or GitHub.

2. Unzip the cd_notifications.zip folder and place this folder in your server's resource folder.

3. Add the resource to your server start config (server.cfg): ensure cd_notifications.

Step 1 - Configure Resource

WARNING

You MUST read all configurable options inside the [cd_notifications/configs/config.lua] file and configure them to suit your server's needs. Please read the ”commented out help text” at the end of each line so you can understand what each config option does.

Step 2 - Adding Notifications

WARNING

Basic Notification

What are basic notifications?

Basic notifications require only the essential data to be filled in.

WARNING

Intermediate Notification

What are intermediate notifications?

Intermediate notifications provide more customizability, but for newer developers, they can be confusing.

WARNING

Advanced Notification

What are advanced notifications?

Advanced notifications provide complete customizability, but only experienced developers should use these.

INFORMATION

Chat Commands

These chat commands can be renamed and/or disabled in the Keys and Commands section of the [configs/config.lua].

The exact usage for each command will be displayed in the chat suggestions when using the commands in-game.

Command	Description
/notifsettings	Open the notification's settings UI.
/notif_test	(Test Command) This is a test command to test the notifications.

Events

These events are completely optional; you can use them if needed.

COMMON ISSUES

Please check out our Troubleshooting Guide before contacting our support.

🔔 Folder Name Make sure the name of the folder is cd_notifications.

ERROR CODES

If you see an error code not listed below, please open a script support ticket in the Codesign Discord.

CHANGELOG

Files Changed

Not every update requires you to replace the whole folder. We do this because we understand it's a pain to redo the configs for every update.

• All Files - This means you should delete your old cd_notifications folder, download and add in the latest version, reconfigure the configs folder and restart your server.
• All Files Except config.lua - This means you should do all of the above (in the All Files section) but additionally make a backup of the config.lua file and replace the new config.lua file with the one you made a backup of.
• Specific Files - This means you can copy and paste the SPECIFIC new files over the old ones and restart the server.

Update Type

On rare occasions, you are forced to update to the latest version. Mostly due to authentication updates where the old versions will no longer work.

• Mandatory - This means you MUST update to this new version, or the old versions will no longer work.
• Optional - This means it's completely your choice whether you wish to update to the latest version. But we do not offer support for old versions for obvious reasons; they are old.

WARNING

Skipping Updates

If you are attempting to update to the latest version but have skipped previous updates, you should update all files just to be safe. For example., let's say you are currently on v4.0.1, you did not update when v4.0.2 was released, and now v4.0.3 is released, and you want to update; you should always use the “All Files” update method.