Skip to content
BranchesTags

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
NUI
NUI
 
 
client
client
 
 
config
config
 
 
server
server
 
 
stream
stream
 
 
.gitattributes
.gitattributes
 
 
README.md
README.md
 
 
fxmanifest.lua
fxmanifest.lua
 
 
index.html
index.html
 
 

Repository files navigation

CB SIRENS

Apocalyptic Alert & Warning System

██████╗ ███████╗██████╗     ███████╗██╗██████╗ ███████╗███╗   ██╗███████╗
██╔══██╗██╔════╝██╔══██╗    ██╔════╝██║██╔══██╗██╔════╝████╗  ██║██╔════╝
██████╔╝█████╗  ██████╔╝    ███████╗██║██████╔╝█████╗  ██╔██╗ ██║███████╗
██╔══██╗██╔══╝  ██╔══██╗    ╚════██║██║██╔══██╗██╔══╝  ██║╚██╗██║╚════██║
██║  ██║███████╗██║  ██║    ███████║██║██║  ██║███████╗██║ ╚████║███████║
╚═╝  ╚═╝╚══════╝╚═╝  ╚═╝    ╚══════╝╚═╝╚═╝  ╚═╝╚══════╝╚═╝  ╚═══╝╚══════╝

CB Sirens is an immersive apocalyptic warning and emergency alert system for FiveM survival environments.

Overview

CB Sirens transforms sirens into dynamic world events designed for:

  • 🧟 Zombie survival servers
  • ☣️ Apocalyptic environments
  • 🏚️ Survival gameplay
  • 🌎 PvE worlds
  • 🚨 Emergency warning systems
  • 🎮 Custom scripted events

The system provides synchronized, area-based alerts with immersive 3D spatial audio, configurable warning zones, multiple sound profiles and a real-time control interface.

It can be used to create events such as:

  • City-wide emergency warnings
  • Evacuation alerts
  • Infection outbreaks
  • Horde warnings
  • Safe-zone alerts
  • Military or government warnings
  • Nuclear or environmental emergencies
  • Custom scripted world events

Features

🔊 Immersive Audio

  • Multi-source 3D spatial audio
  • Distance-based volume falloff
  • Head-tracking audio positioning
  • HRTF spatial audio
  • Smooth audio transitions
  • Multiple simultaneous sound sources
  • Configurable sound range
  • Per-area volume control

🚨 Alert System

  • Area-based warning activation
  • Multiple active areas
  • Individual area sound configuration
  • Global alert activation
  • Global alert deactivation
  • Area-specific deactivation
  • Sound overrides
  • Persistent multiplayer state
  • Join-in-progress synchronization

🗺️ Warning Zones

Each configured area can define its own:

  • Alert sound
  • Audio range
  • Volume
  • Activation state
  • Warning objects
  • Multiple physical alert locations

This allows large survival maps to have different warning systems depending on the location.

🖥️ Control Panel

The integrated NUI control panel provides:

  • Master alert controls
  • Area management
  • Sound selection
  • Active area monitoring
  • Active pole monitoring
  • System status
  • Sound overrides

🎮 Player Controls

Players can locally mute or restore CB Sirens without affecting the alert state of other players.

🔌 Developer Integration

External resources can trigger and control alerts through exports, allowing CB Sirens to become part of larger gameplay systems.

Examples include:

  • Zombie horde systems
  • Dynamic events
  • Mission systems
  • Infection systems
  • Evacuation events
  • Safe-zone systems
  • Custom survival mechanics

Resource Structure

cb_sirens/
│
├─ fxmanifest.lua
├─ README.md
│
├─ config/
│  └─ config.lua
│
├─ client/
│  └─ client files
│
├─ server/
│  └─ server files
│
├─ NUI/
│  ├─ interface files
│  └─ sounds/
│     └─ *.ogg
│
└─ stream/
   └─ streamed assets

The exact file structure may vary between releases.

Installation

1. Install the Resource

Place the cb_sirens folder inside your FiveM resources directory.

Example:

resources/[your_folder]/cb_sirens

2. Start the Resource

Add the following to server.cfg:

ensure cb_sirens

3. Restart

Restart the resource or restart the server:

restart cb_sirens

Configuration

The primary configuration file is:

config/config.lua

The configuration controls:

  • Alert controls
  • Sounds
  • Warning areas
  • Audio range
  • Volume
  • Alert objects
  • Permissions
  • Discord notifications
  • UI behaviour

Controls

Example:

Controls = {

    ToggleSirens = {
        command = "togglecbs",
        description = "Toggle CB Sirens audio.",
        keyMapping = "",
        input = "keyboard"
    },

    OpenCBSMenu = {
        command = "cbsmenu",
        description = "Open the CB Sirens control panel.",
        keyMapping = "",
        input = "keyboard"
    }

}

Custom Sounds

Custom .ogg audio files can be added to:

NUI/sounds/

Example:

SirenSoundFileList = {

    [1] = {
        SoundFile = "general-siren",
        DisplayName = "Default Alert"
    },

    [2] = {
        SoundFile = "your-sound",
        DisplayName = "Custom Warning"
    }

}

The configured SoundFile must match the filename inside NUI/sounds/.

For example:

NUI/sounds/horde-warning.ogg

would use:

SoundFile = "horde-warning"

Warning Areas

Each area can define its own alert behaviour.

Example:

SirenObjectLocations = {

    ["Example Area"] = {

        enabled = true,

        soundFile = "general-siren",

        soundReach = 1250.0,

        soundVolume = 0.11,

        poles = {

            {
                x = 100.0,
                y = 200.0,
                z = 30.0,
                w = 0.0
            }

        }

    }

}

Each warning area can have:

  • Independent sounds
  • Independent audio range
  • Independent volume
  • Multiple alert objects
  • Individual activation state

Permissions

CB Sirens supports multiple permission methods.

Standalone

No framework is required.

ACE

FiveM ACE permissions can be used to restrict control access.

QBCore

Optional support for:

  • Job-based permissions
  • Permission/group-based access

ESX

Optional support for job-based permissions.

Discord

Optional Discord role-based permissions can be used through the supported Discord integration.

Permission behaviour is configured through:

config/config.lua

Player Controls

Players can configure their FiveM keybindings through:

Settings → Key Bindings → FiveM

Toggle Siren Audio

/togglecbs

This only changes the local player's audio.

It does not deactivate the global alert.

Control Panel

Authorized operators can open the control panel with:

/cbsmenu

Alert Control

Authorized operators can control the warning system through the NUI panel.

Available functionality includes:

  • Activate individual warning areas
  • Activate multiple areas
  • Deactivate individual areas
  • Deactivate all active areas
  • Select alert sounds
  • Override active sounds
  • Monitor active areas
  • Monitor active alert objects
  • Manage the global alert state

Developer API

CB Sirens provides exports for integration with other FiveM resources.

This allows external systems to trigger alerts dynamically.

Activate Specific Areas

exports['cb_sirens']:TriggerCBSirensByAreaExport(
    "general-siren",
    {
        "Fort Zancudo",
        "Paleto Bay"
    }
)

Deactivate Areas

exports['cb_sirens']:DeactivateCBSirensByAreaExport(
    {
        "Fort Zancudo"
    }
)

Deactivate All Areas

exports['cb_sirens']:DeactivateAllCBSirensExport()

Get Available Areas

local areas = exports['cb_sirens']:GetAvailableAreas()

These exports can be used by external resources to connect CB Sirens with:

  • Dynamic events
  • Zombie systems
  • Missions
  • Horde events
  • Evacuation systems
  • Infection mechanics
  • Custom gameplay scripts

Dependencies

CB Sirens does not require an external framework.

Required

  • FiveM server
  • One compatible FiveM server environment

Optional

  • QBCore
  • ESX
  • Discord role integration

Framework integrations are only required when their respective permission systems are enabled.

Compatibility

CB Sirens is designed to operate independently of a specific framework.

Supported environments include:

  • Standalone
  • QBCore
  • ESX
  • Custom FiveM frameworks

The alert system itself does not require QBCore or ESX.

Performance

CB Sirens is designed to remain lightweight during normal operation.

Typical client performance may remain around:

0.00–0.02ms

Actual performance depends on:

  • Number of configured alert areas
  • Number of active areas
  • Number of alert objects
  • Audio sources
  • Player conditions
  • Server configuration

Performance values should be considered approximate rather than guaranteed.

Troubleshooting

Resource Does Not Start

Verify:

  • The resource folder is named cb_sirens
  • The resource is inside the server resources directory
  • ensure cb_sirens exists in server.cfg
  • The resource structure is correct
  • The server console contains no startup errors

No Audio

Check:

  • The .ogg file exists
  • The configured sound name matches the file
  • The player is within soundReach
  • The player has not locally muted the system
  • The NUI is loading correctly
  • The F8 console contains no errors

For additional diagnostics:

Config.Debug = true

Warning Area Does Not Activate

Verify:

  • The area exists in SirenObjectLocations
  • The area is enabled
  • The area name matches exactly
  • The operator has the required permission
  • The server has successfully loaded the configuration
  • No server-side errors are present

Alert Objects Are Not Spawning

Verify:

Config.EnableObjects = true

Then check:

  • The configured model exists
  • The streamed assets are installed
  • The player is within ObjectRenderDistance
  • The stream/ directory is present
  • The FiveM console contains no model errors

Custom Audio Does Not Load

Verify:

  • The file is inside NUI/sounds/
  • The file uses .ogg
  • The filename matches SoundFile
  • The resource has been restarted after adding the file
  • The browser/NUI console contains no audio errors

Technical Architecture

CB Sirens uses browser-based Web Audio functionality for spatial audio processing.

The audio system supports:

  • Multiple simultaneous audio sources
  • Distance-based falloff
  • Spatial positioning
  • Head-tracked positioning
  • HRTF audio
  • Smooth volume transitions
  • Multiplayer synchronization

The server controls the synchronized alert state while clients handle local audio playback and spatial positioning.

Updating

Before updating CB Sirens:

  1. Stop the resource.
  2. Back up the current installation.
  3. Replace the resource files.
  4. Review configuration changes.
  5. Review the release notes.
  6. Restart the resource.

Example:

restart cb_sirens

Always back up your existing configuration before applying major updates.

Compatibility Notes

Do not rename internal configuration keys, events or exports unless you understand their dependencies.

External resources may rely on:

  • Resource name
  • Export names
  • Event names
  • Configuration keys
  • Server integrations

Changing these values can break existing integrations.

Support

When requesting support, provide:

Resource:
CB Sirens

Version:
1.2.1

Server Build:
[Your build]

Framework:
[Standalone / QBCore / ESX / Other]

Issue:
[Describe the problem]

Error Logs:
[Relevant console output]

Configuration:
[Relevant configuration section]

Do not include private credentials, Discord webhook URLs or other sensitive information.

CB STUDIOS

CB Sirens is developed and maintained by CB Studios.

Store
https://pichirin-cb.tebex.io/

Documentation
https://docs.pichirincb.com/

Support Discord
https://discord.gg/hsx6AvBg5s

CB STUDIOS

Apocalyptic Systems • Survival Resources • FiveM Development

About

Advanced apocalyptic warning and emergency alert system for FiveM survival servers, featuring synchronized area-based alerts, immersive 3D spatial audio, dynamic warning zones and developer integrations.

Resources

Readme
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

Packages

Contributors

Languages