Page cover image

Installation

Qubit Notification Installation documentation

Required scripts

1. Edit xSound fxmanifest.lua

We are using the xSound script for sound effects, please make the necessary settings for it to work within RedM.

fx_version 'cerulean'
games { 'gta5', 'rdr3' }
rdr3_warning 'I acknowledge that this is a prerelease build of RedM, and I am aware my resources *will* become incompatible once RedM ships.'

client_scripts {
    "config.lua",
    "client/main.lua",
    "client/events.lua",
    "client/commands.lua",
    "client/exports/info.lua",
    "client/exports/play.lua",
    "client/exports/manipulation.lua",
    "client/exports/events.lua",
    "client/effects/main.lua",
    "client/emulator/interact_sound/client.lua",
    "addon/**/client/*.lua"
}

server_scripts {
    "config.lua",
    "server/exports/play.lua",
    "server/exports/manipulation.lua",
    "server/emulator/interact_sound/server.lua",
    "addon/**/server/*.lua"
}

ui_page "html/index.html"

files {
    "html/index.html",
    "html/scripts/listener.js",
    "html/scripts/SoundPlayer.js",
    "html/scripts/functions.js",
    
	"html/sounds/*.ogg",
	"html/sounds/*.mp3",
}

2. Add Sound effect to xSound

You need download and add sound fx file to xsound/html/sounds folder

3. Usage Client/Server

You can use the script on either the client or server side. The events are as follows.

Server-Side Usage

Event Usage:

TriggerClientEvent("qubit-notification:client:send", src, type, message, title, timeout)

Example :

TriggerClientEvent('qubit-notification:client:send', src, 'TELEGRAPH', 'WE NEED HELP ON TUMBLEWEED', 'MESSAGE', 6000)
TriggerClientEvent('qubit-notification:client:send', src, 'ALERT', 'VALENTINE MARKET IS ROBBERING', 'ROBBERY', 6000)
TriggerClientEvent('qubit-notification:client:send', src, 'INFO', 'SERVER IS RESTARTIN IN 5 MINUTES', 'ANNOUNCEMENT', 6000)

Client-Side Usage

TriggerEvent('qubit-notification:client:send', type, type, message, title, timeout)

Example :

TriggerEvent('qubit-notification:client:send', 'TELEGRAPH', 'WE NEED HELP ON TUMBLEWEED', 'MESSAGE', 6000)
TriggerEvent('qubit-notification:client:send', 'ALERT', 'VALENTINE MARKET IS ROBBERING', 'ROBBERY', 6000)
TriggerEvent('qubit-notification:client:send', 'INFO', 'SERVER IS RESTARTIN IN 5 MINUTES', 'ANNOUNCEMENT', 6000)

5. Done 🎉

You are ready to use notification system.

Last updated