Radio V3

A modern handheld radio for pma-voice with everything your server needs for law enforcement, medic and civilian radio comms.

Table of Contents

1. Features
2. Requirements
3. Installation
4. Configuration
5. Data Files
6. Customising
7. Keybinds & Commands
8. Exports
9. Locales
10. Support

Features

Radio & UI

• Touchscreen radio with apps for tuning, channels, favorites, listening in, the player list and settings.
• Custom radio props, animations and item images included.
• Radio prop held in hand while the radio is open, with its screen also shown on the props screen.
• Movable and resizable radio and radio player list that saves.
• 18 preset colors, custom color picker, 4 finishes and 24 designs.
• Add-on design pack support.
• Selectable talk animations, with support for adding custom animations.
• Radio notifications that pop up on the radio UI.

Channels

• Channels from 1 to 999.99 with ability to add custom labels.
• Channels app with a list of configurable categories and channels.
• Channel locking by state bag, job/gang grade or ACE permissions, with an optional on duty check.
• Add up to 12 favorite channels.
• Automatic rejoin of the last channel when you power the radio on. (even after a server restart)
• You can listen in on up to 4 other channels, basically meaning you can be in up to 5 channels at once. You can also adjust this.
• Radio player list showing names, callsigns and who is talking on your channel and the channels you're listening in on.
• Editable names and callsigns (can be disabled in config, recommended for framework users), and muting of other players.
• Optional talkover protection with a busy tone.
• Optional transmission timeout to limit how long people can speak.

Emergency

• Panic button on configurable emergency channels.
• Alerts with a sound, radio notification and flashing map blip for everyone on the channel and anyone listening in.
• Configurable cooldown and blip duration.

Signal

• Voice quality based on distance.
• Worse signal in interiors, tunnels, under water, in bad weather and in configurable areas.
• Better signal when high up or in a vehicle.
• Optional, can be disabled for perfect audio everywhere.

Jammers

• Placeable signal jammers that block every channel except the ones whoever placed it allow.
• Item or command placement, with a green or red preview for valid and invalid spots.
• Jammer control screen with power, range and allowed channels.
• Pick up jammers with G, or you can also enable ox_target instead. (Support for your own custom interactions via export too)
• Destructible jammers with bullet impacts and sparks.
• Permanent jammers set in the config.

Battery

• Battery drains while powered on, drains faster while talking.
• Sitting in a vehicle charges your radio.
• Battery saved per radio item, or per player if you don't use the item system.
• Power bank items that charge radios over time and recharge in vehicles.
• Optional, can be disabled.

Items & Frameworks

• Optional radio item, with optional items for every color and design.
• ox_inventory and qb-inventory support.
• QBCore, Qbox, ESX and standalone support.

Exclusive Law Enforcement App

• Exclusive to scully_lawenforcement (opens in a new tab) customers.
• Duty toggle and on duty list.
• 10-code statuses shown on the radio player list.
• Automatic wellness check alerts for officers that haven't moved for a while.

Other

• Rebindable keybinds.
• Exports and events.
• Locale support.

Requirements

• A FiveM server with OneSync enabled.
• Server build set to the latest recommended build.
• pma-voice (opens in a new tab)

The resource manifest declares:

dependencies {
    '/server:35245', -- Server artifacts / build number
    '/onesync',
    'pma-voice'
}

Optional:

• QBCore, Qbox or ESX, for jobs and character names.
• ox_inventory or qb-inventory, if you want the radio to be an item.
• scully_lawenforcement, for the police app.

Installation

1. Download the resource from your FiveM Asset Grants (opens in a new tab).

2. Extract scully_radio3 into your server's resources folder.

3. Move scully_radio3.cfg out of the resource and place it next to your server.cfg.

4. Add this to the top of your server.cfg:

   exec scully_radio3.cfg

5. Start the resource:

   ensure pma-voice
   ensure scully_radio3

6. If you want the radio to be an item, add the items to your inventory (see Items).

7. Restart your server.

Permissions

Private channels and jammers can be locked by state bag, job, gang or ace permission. If you use aces, add them to your server.cfg:

add_ace group.police group.police allow
add_ace group.ems group.ems allow
add_ace group.police group.jammer allow

Configuration

Server-wide settings live in scully_radio3.cfg.

Core

setr scully_radio3:uniqueKvpId "change-me"
setr scully_radio3:locale "en"

Controls

setr scully_radio3:openCommand "radio"
setr scully_radio3:openKey "U"
setr scully_radio3:nextChannelKey "PAGEUP"
setr scully_radio3:previousChannelKey "PAGEDOWN"
setr scully_radio3:swapChannelKey ""
setr scully_radio3:scanKey ""
setr scully_radio3:powerKey ""
setr scully_radio3:volumeUpKey ""
setr scully_radio3:volumeDownKey ""

Leave a key empty to let players pick their own in their GTA key settings.

Items & looks

setr scully_radio3:useItem "false"
setr scully_radio3:itemColors "false"
setr scully_radio3:allowColors "true"
setr scully_radio3:allowCustomColors "true"
setr scully_radio3:enablePrideRadios "true"
setr scully_radio3:defaultColor "graphite"
setr scully_radio3:enableEditing "true"

Channels

setr scully_radio3:minFrequency 1
setr scully_radio3:maxFrequency 999.99
setr scully_radio3:maxFavorites 12
setr scully_radio3:maxScanChannels 4
setr scully_radio3:rememberChannel "true"
setr scully_radio3:talkoverProtection "true"
setr scully_radio3:transmitTimeout 60

Panic button

setr scully_radio3:enableEmergency "true"
setr scully_radio3:emergencyCooldown 30
setr scully_radio3:emergencyBlipTime 60

Signal & jammers

setr scully_radio3:enableSignal "true"
setr scully_radio3:enableJammers "true"

Battery

setr scully_radio3:enableBattery "true"
setr scully_radio3:batteryLife 120
setr scully_radio3:transmitDrain 3
setr scully_radio3:vehicleCharging "true"
setr scully_radio3:chargeTime 10

With radio items, every radio keeps its own charge, so it stays the same if it's dropped, traded or swapped. Without items, the charge is saved for each player.

Hands & animations

setr scully_radio3:holdAnimation "true"
setr scully_radio3:allowNoTalkAnimation "true"
setr scully_radio3:screenMirror "true"
setr scully_radio3:disableWhenDead "true"

Data Files

Customising

Department channels (data/channels.lua)

Group channels together for each department and lock them so only that department can join. Each group shows up on the radio with its own name, icon and color, and lists its named channels.

return {
    names = {
        [10] = 'Civ Main',
        [100] = 'Taxi'
    },
 
    zones = {
        {
            label = 'Law Enforcement',
            icon = 'shield-star',
            color = '#3b82f6',
            restrict = { 1, 5 },
            access = {
                states = { isLEO = true },
                jobs = { police = 0, sheriff = 0 },
                aces = { 'group.police' },
                onDuty = false
            },
            emergency = true,
            channels = {
                { frequency = 1, label = 'Dispatch' },
                { frequency = 2, label = 'Patrol 1' }
            }
        }
    }
}

Players only need to match one of the access options to get in.

Signal (data/signal.lua)

Every player has a signal strength, and when someone talks, how far apart you are plus both of your signals decides how clear they sound.

Jammers (data/jammers.lua)

Jammers block every radio around them apart from the channels you allow through. Players place them with the jammer item or command, then walk up to them to open the jammer's own screen, where they can turn it on and off, change its range and pick the allowed channels. You can also interact with the jammer to pick it back up. Anyone can shoot a jammer to destroy it.

return {
    model = `scully_radio3_jammer`,
    item = 'radio_jammer',
    command = 'jammer',
    target = false,
 
    permission = {
        states = { isLEO = true },
        jobs = { police = 0, sheriff = 0 },
        aces = { 'group.jammer' }
    },
 
    range = { min = 10.0, max = 150.0, step = 5.0, default = 40.0 },
 
    defaults = {
        { coords = vec4(0.0, 0.0, 0.0, 0.0), range = 120.0, allowed = { 1, 2 }, prop = true }
    }
}

When placing a jammer, look where you want it to go. It shows green when it can go there and red when the ground isn't flat or it's too far away.

Talk animations (data/animations.lua)

Players pick how they hold the radio when they talk in the radio's settings. You can add your own animations, and set exactly where the radio sits in the hand for each one.

return {
    {
        name = 'handheld',
        label = 'Handheld',
        dict = 'anim@scully_radio',
        anim = 'handheld',
        flag = 49,
        prop = true,
        attach = { ... }
    },
    { name = 'ear', label = 'Ear', dict = 'cellphone@', anim = 'cellphone_call_listen_base', flag = 49, prop = true },
    { name = 'default', label = 'Default / Shoulder', pma = true },
    { name = 'none', label = 'None', none = true }
}

The first animation in the list is the one new players start with.

Colors (data/colors.lua)

{ name = 'blue', label = 'Blue', color = '#1f5fd1' },

Designs (data/designs.lua)

{ name = 'woodland', label = 'Woodland Camo', image = 'woodland.svg' },

With itemColors on, every color apart from graphite needs an item called radio_<name>, like radio_blue. There is configuration files provided for both ox_inventory and qb-inventory for every color and design included with the resource along with item images.

Police app (data/leo.lua)

Items

The item lists are in the items folder:

• items/ox_inventory.lua for ox_inventory.
• items/qb-inventory.lua for qb-inventory.
• Copy items/images into your inventory's image folder.

Important: Radios and power banks must not stack (stack = false on ox_inventory, unique = true on qb-inventory), otherwise they can't each keep their own charge.

Power banks

Using a power bank plugs it into whichever radio in your inventory has the least charge, and charges it up over time. The power bank stays in your inventory and loses charge as it goes, you can see how much it has left on the item. It stops when the radio is full, the power bank is empty, or you lose either one.

Flat power banks charge back up while you sit in a vehicle.

Add-on packs

Add-on packs add new designs to the radio, and install by dragging them into the resource. They never replace your files, so your config stays exactly how you set it.

Installing a pack

1. Drag the pack's data, designs, items and stream folders into your scully_radio3 folder, and merge them when asked.
2. If you use itemColors, add the pack's items from its items/addons file to your inventory and copy its images into your inventory's image folder.
3. Restart your server.

To remove a pack, delete its files and restart.

Keybinds & Commands

Players can change these in their GTA key settings under FiveM.

Placing a jammer:

Next to a jammer:

On the jammer:

Exports

Client exports

-- ox_lib text UI example.
exports.scully_radio3:customHelpAlert(function(text)
    lib.showTextUI(text)
end, function()
    lib.hideTextUI()
end)

Server exports

exports.scully_radio3:setBattery(source, 100)

Events

Client events:

Server events:

AddEventHandler('scully_radio3:emergencySent', function(source, frequency, coords)
    print(('%s pressed their panic button on %s'):format(GetPlayerName(source), frequency))
end)

State bags

Locales

The languages are in the locales folder. Copy en.lua, translate it and set it in scully_radio3.cfg:

setr scully_radio3:locale "en"

Showcase

https://youtu.be/lKjy3TKmsJI (opens in a new tab)

Support

For support, updates and community discussion, join the Scully's Development community:

https://discord.gg/scully (opens in a new tab)