🛠️ Installations

Syntax Notify V2 - Complete Installation Guide

---

📋 Requirements

Server Requirements

• FiveM Server (Artifact 4752 or higher recommended)

• Operating System: Windows or Linux

• Framework (Optional): ESX, QBCore, vRP, or ox_core

Resource Dependencies

• No additional dependencies required

• Works standalone or with any framework

---

🚀 Installation Steps

Step 1: Download and Extract

1. Download the Syntax_NotifyV2 resource

2. Extract the folder to your server's resources directory

3. Ensure the folder is named exactly Syntax_NotifyV2

Step 2: File Structure Verification

Verify your installation has the following structure:

resources/[syntax]/Syntax_NotifyV2/
├── fxmanifest.lua
├── IDIOMAS.md
├── client/
│   └── main.lua
├── html/
│   ├── scripts.js
│   ├── styles.css
│   ├── ui.html
│   └── sounds/
│       ├── sound1.mp3
│       ├── sound2.mp3
│       ├── sound3.mp3
│       ├── sound4.mp3
│       └── sound5.mp3
├── locales/
│   ├── de.lua
│   ├── en.lua
│   ├── eng.lua
│   ├── es.lua
│   ├── fr.lua
│   ├── it.lua
│   ├── locale.lua
│   ├── nl.lua
│   ├── pt.lua
│   └── ru.lua
├── server/
│   └── main.lua
└── shared/
    └── config.lua

Step 3: Server Configuration

Add the resource to your server.cfg:

# Syntax Notify V2 - Premium Notification System
start Syntax_NotifyV2

Step 4: Restart Server

1. Save all configuration files

2. Restart your FiveM server

3. Verify the resource started successfully in console

---

⚙️ Configuration

Basic Configuration

Edit shared/config.lua to customize your notification system:

Config = {}

-- Framework Configuration (Auto-Detection Enabled)
Config.Framework = 'auto' -- Options: 'auto', 'esx', 'qbcore', 'vrp', 'ox_core', 'standalone'

-- Debug Mode (Enable for troubleshooting)
Config.Debug = true

-- Default Language (Multi-Language Support)
Config.Language = 'eng' -- Available: 'es', 'eng', 'fr', 'de', 'it', 'pt', 'ru', 'nl', 'pl'

Config.Notifications = {
    -- Timing Configuration
    defaultTime = 4000,                -- Default display time (milliseconds)
    
    -- Display Limits
    maxNotifications = 8,               -- Maximum simultaneous notifications
    
    -- Audio Settings
    soundEnabled = true,                -- Enable sound effects by default
    
    -- Visual Theme
    defaultTheme = 'minimal',           -- Default theme
    
    -- Position Settings
    defaultPosition = 'top-right',      -- Default position
}

Advanced Configuration Options

Theme Configuration

Config.Themes = {
    available = {
        'minimal',      -- Clean and compact design
        'modern',       -- Contemporary glass effect
        'neon',         -- Cyberpunk neon style
        'classic',      -- Traditional notification style
        'gaming',       -- Gaming-inspired design
        'luxury',       -- Premium golden theme
        'dark',         -- Dark mode aesthetic
        'retro',        -- Vintage computer style
        'corporate',    -- Professional business theme
        'cyberpunk',    -- Futuristic sci-fi design
        'nature'        -- Organic earth-tone theme
    },
    allowCustomThemes = true,
    saveUserPreferences = true
}

Sound Configuration

Config.Sounds = {
    available = {
        [0] = 'No Sound',
        [1] = 'Subtle Beep',
        [2] = 'Modern Chime',
        [3] = 'Classic Bell',
        [4] = 'Digital Alert',
        [5] = 'Notification Pop'
    },
    defaultVolume = 0.5,
    enableSpatialAudio = false
}

Permission System

Config.Commands = {
    permissions = {
        allowedGroups = {'admin', 'superadmin', 'mod'},
        allowedAces = {'command.notify'},
        restrictTestCommands = false,
        allowUserConfig = true
    }
}

---

🎯 Features Overview

🎨 11 Professional Themes

1. Minimal - Clean and compact design

2. Modern - Contemporary glass effect with blur

3. Neon - Cyberpunk-inspired neon glow

4. Classic - Traditional notification appearance

5. Gaming - Gaming-oriented design with effects

6. Luxury - Premium golden theme with elegance

7. Dark - Dark mode with subtle highlights

8. Retro - Vintage computer terminal style

9. Corporate - Professional business appearance

10. Cyberpunk - Futuristic sci-fi design

11. Nature - Organic earth-tone theme

📍 6 Position Options

• top-right - Upper right corner

• top-left - Upper left corner

• bottom-right - Lower right corner

• bottom-left - Lower left corner

• center-right - Middle right side

• center-left - Middle left side

🎵 6 Sound Effects

• 0 - No Sound (Silent)

• 1 - Subtle Beep (Soft notification)

• 2 - Modern Chime (Contemporary)

• 3 - Classic Bell (Traditional)

• 4 - Digital Alert (Tech-style)

• 5 - Notification Pop (Pop-style)

🏷️ 6 Notification Types

• Success ✅ - Green notifications for positive feedback

• Error ❌ - Red notifications for errors and failures

• Warning ⚠️ - Orange notifications for warnings

• Info ℹ️ - Blue notifications for information

• Phone Message 📱 - Special phone-style notifications

• Neutral ⚪ - Gray notifications for neutral messages

---

💻 Usage Examples

Client-Side Examples

Basic Notification

exports['Syntax_NotifyV2']:Alert('success', 'Operation Successful', 'Your action was completed successfully!', 3000)

Quick Notification Functions

-- Success notification
exports['Syntax_NotifyV2']:ShowSuccess('Success!', 'Action completed successfully')

-- Error notification
exports['Syntax_NotifyV2']:ShowError('Error!', 'Something went wrong')

-- Warning notification
exports['Syntax_NotifyV2']:ShowWarning('Warning!', 'Please check your input')

-- Info notification
exports['Syntax_NotifyV2']:ShowInfo('Information', 'Here is some useful information')

-- Phone message style
exports['Syntax_NotifyV2']:ShowPhoneMessage('Message', 'You have a new message')

-- Neutral notification
exports['Syntax_NotifyV2']:ShowNeutral('Notice', 'General notification')

Advanced Notification with Options

exports['Syntax_NotifyV2']:Notify({
    type = 'success',
    title = 'Mission Complete',
    message = 'You have successfully completed the mission!',
    duration = 5000,
    sound = 2,
    theme = 'gaming',
    position = 'center-right'
})

Configuration Functions

-- Open configuration menu
exports['Syntax_NotifyV2']:OpenConfig()

-- Change theme programmatically
exports['Syntax_NotifyV2']:SetTheme('cyberpunk')

-- Change position programmatically
exports['Syntax_NotifyV2']:SetPosition('bottom-left')

-- Clear all notifications
exports['Syntax_NotifyV2']:ClearAll()

Server-Side Examples

Send to Specific Player

-- Send notification to specific player
exports['Syntax_NotifyV2']:SendNotification(source, 'success', 'Welcome!', 'Welcome to our server!')

-- Alternative method
exports['Syntax_NotifyV2']:NotifyPlayer(source, {
    type = 'info',
    title = 'Server Info',
    message = 'Server will restart in 5 minutes',
    duration = 10000
})

Send to All Players

-- Send to all players
exports['Syntax_NotifyV2']:SendNotificationToAll('warning', 'Server Notice', 'Server restart in 10 minutes')

-- Alternative method
exports['Syntax_NotifyV2']:NotifyAll({
    type = 'info',
    title = 'Event Starting',
    message = 'Racing event starts in 2 minutes!',
    duration = 8000
})

Send to Specific Groups

-- Send to admin group
exports['Syntax_NotifyV2']:SendNotificationToGroup('admin', 'error', 'Admin Alert', 'Cheater detected in server')

---

🎮 Commands

User Commands

• /confignotify - Open notification configuration menu

• /testnotify - Test all notification types

• /language [lang] - Change language (es, eng, fr, de, it, pt, ru, nl, pl)

• /theme [theme] - Change theme directly

• /position [position] - Change position directly

Admin Commands (Requires Permissions)

• /success [message] - Send success notification

• /error [message] - Send error notification

• /warning [message] - Send warning notification

• /info [message] - Send info notification

• /phonemessage [message] - Send phone message

• /neutral [message] - Send neutral notification

Available Themes for Commands

/theme minimal
/theme modern
/theme neon
/theme classic
/theme gaming
/theme luxury
/theme dark
/theme retro
/theme corporate
/theme cyberpunk
/theme nature

Available Positions for Commands

/position top-right
/position top-left
/position bottom-right
/position bottom-left
/position center-right
/position center-left

---

📤 Exports

Client Exports

Primary Functions

-- Universal notification function
exports['Syntax_NotifyV2']:Alert(type, title, message, duration, sound, theme, position)

-- Advanced notification with full options
exports['Syntax_NotifyV2']:Notify(options)

-- Quick notification (ESX compatible)
exports['Syntax_NotifyV2']:ShowNotification(message, type, duration)

-- Lowercase compatibility
exports['Syntax_NotifyV2']:showNotification(message, type, duration)

Type-Specific Functions

-- Green success notifications
exports['Syntax_NotifyV2']:ShowSuccess(title, message, duration)

-- Red error notifications
exports['Syntax_NotifyV2']:ShowError(title, message, duration)

-- Orange warning notifications
exports['Syntax_NotifyV2']:ShowWarning(title, message, duration)

-- Blue info notifications
exports['Syntax_NotifyV2']:ShowInfo(title, message, duration)

-- Phone-style notifications
exports['Syntax_NotifyV2']:ShowPhoneMessage(title, message, duration)

-- Gray neutral notifications
exports['Syntax_NotifyV2']:ShowNeutral(title, message, duration)

Configuration Functions

-- Open configuration menu
exports['Syntax_NotifyV2']:OpenConfig()

-- Change theme programmatically
exports['Syntax_NotifyV2']:SetTheme(theme)

-- Change position programmatically
exports['Syntax_NotifyV2']:SetPosition(position)

-- Clear all active notifications
exports['Syntax_NotifyV2']:ClearAll()

Server Exports

Individual Player Notifications

-- Send to specific player
exports['Syntax_NotifyV2']:SendNotification(source, type, title, message, duration)

-- Alternative player notification
exports['Syntax_NotifyV2']:NotifyPlayer(source, options)

Group Notifications

-- Send to all players
exports['Syntax_NotifyV2']:SendNotificationToAll(type, title, message, duration)

-- Alternative all-players notification
exports['Syntax_NotifyV2']:NotifyAll(options)

-- Send to specific groups/permissions
exports['Syntax_NotifyV2']:SendNotificationToGroup(group, type, title, message, duration)

---

🌍 Multi-Language Support

Supported Languages

Language	Code	File	Status
Spanish	es	locales/es.lua	✅ Complete
English	eng	locales/eng.lua	✅ Complete
French	fr	locales/fr.lua	✅ Complete
German	de	locales/de.lua	✅ Complete
Italian	it	locales/it.lua	✅ Complete
Portuguese	pt	locales/pt.lua	✅ Complete
Russian	ru	locales/ru.lua	✅ Complete
Dutch	nl	locales/nl.lua	✅ Complete
Polish	pl	locales/pl.lua	✅ Complete

Changing Language

1. Via Configuration: Edit Config.Language in shared/config.lua

2. Via Command: Use /language [code] command in-game

3. Programmatically: Use the language change function

Dynamic Language Switching

-- Change language for specific player
TriggerClientEvent('syntax_notify:changeLanguage', source, 'es')

-- Change language for all players
TriggerClientEvent('syntax_notify:changeLanguage', -1, 'eng')

---

🔧 Framework Integration

ESX Integration

-- ESX notification replacement
ESX.ShowNotification = function(message, type, duration)
    exports['Syntax_NotifyV2']:ShowNotification(message, type or 'info', duration or 4000)
end

-- ESX advanced notification
ESX.ShowAdvancedNotification = function(title, message, type, duration)
    exports['Syntax_NotifyV2']:Alert(type or 'info', title, message, duration or 4000)
end

QBCore Integration

-- QBCore notification replacement
QBCore.Functions.Notify = function(text, texttype, length)
    exports['Syntax_NotifyV2']:ShowNotification(text, texttype or 'primary', length or 5000)
end

vRP Integration

-- vRP notification replacement
function vRP.notify(source, message, type, duration)
    exports['Syntax_NotifyV2']:SendNotification(source, type or 'info', 'Notification', message, duration or 4000)
end

---

🛠️ Troubleshooting

Common Issues

Resource Not Starting

Problem: Resource fails to start Solutions:

1. Check fxmanifest.lua for syntax errors

2. Verify file permissions

3. Ensure proper folder structure

4. Check server console for error messages

Notifications Not Appearing

Problem: Notifications don't show up Solutions:

1. Enable debug mode in config

2. Check browser console (F12) for JavaScript errors

3. Verify NUI is working properly

4. Test with basic notification commands

Sound Not Working

Problem: Sound effects not playing Solutions:

1. Check Config.Sounds.soundEnabled = true

2. Verify sound files are present in html/sounds/

3. Check browser audio permissions

4. Test with different sound indices

Framework Not Detected

Problem: Framework auto-detection fails Solutions:

1. Set Config.Framework to specific framework name

2. Ensure framework resource is started before Syntax_NotifyV2

3. Check framework resource names match expected values

Debug Mode

Enable debug mode for detailed troubleshooting:

Config.Debug = true

This will show detailed console logs including:

• Framework detection results

• Notification triggers

• Configuration changes

• Error messages

Performance Issues

If experiencing performance issues:

1. Reduce Config.Notifications.maxNotifications

2. Disable sound effects temporarily

3. Use simpler themes (minimal, classic)

4. Check for conflicting resources

---

📞 Support

Official Support Channels

• Discord: https://discord.gg/syntaxstore

• Store: https://syntax-shop.tebex.io

• Documentation: Available in Discord server

Support Guidelines

1. Before Requesting Support:

   • Read this complete installation guide

   • Check troubleshooting section

   • Enable debug mode to gather information

2. When Requesting Support:

   • Provide server console logs

   • Describe the exact issue and steps to reproduce

   • Include your configuration settings

   • Mention your framework and server version

3. Response Times:

   • Discord support: Usually within 24 hours

   • Critical issues: Priority support available

Update Policy

• Free Lifetime Updates: All purchasers receive free updates

• Backward Compatibility: Updates maintain compatibility with existing configurations

• Changelog: Available in Discord for each update

---

📝 Additional Information

Resource Metadata

• Version: 2.1.0 - Premium Edition

• Author: SyntaxStore Development Team

• Compatibility: FiveM Artifact 4752+

• Performance: Optimized (0.00ms idle)

• Size: Lightweight and efficient

Legal Information

• This is a premium resource from SyntaxStore

• Redistribution is prohibited

• Support is provided to legitimate purchasers only

• Terms of service available on store page

Future Updates

Planned features for upcoming versions:

• Custom theme builder

• Animation effects library

• Mobile responsive design

• Additional framework integrations

• Enhanced permission system

---

🎉 Thank You

Thank you for choosing Syntax Notify V2! This premium notification system has been carefully crafted to provide the best user experience with maximum compatibility.

For the latest updates and more premium resources, visit our store: https://syntax-shop.tebex.io

---

© 2025 SyntaxStore Development Team. All rights reserved.