Scully Vehicle Radio

Replaces the GTA radio wheel with a smooth station picker made of spinning records, shows the song and artist that's playing, and lets you control which stations can be heard where, including bad signal areas with static and drop outs.

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

• Hold the radio key in a vehicle to open the picker, move the mouse (or use the next / previous station keys) to scroll through the stations and let go to tune in.
• Every station gets its own icon and color, with a spinning record, a tuning dial and a live equalizer for the station that's playing.
• Tap the next / previous station keys to skip without opening the picker.
• Shows the song name and artist that's playing, in the picker and in a now playing popup when the station or song changes.
• You can add your custom / add-on radio stations.
• Turn stations off everywhere, or only in certain areas (native zones or coords), or limit an area to a few stations.
• Radio static system that works with areas mentioned above, every tunnel and parking garage on the map and bad weather. You can disable each one or change how much each one impacts your radio.
• Optional static when scrolling between stations, like tuning a real radio.
• An export to add interference from your own resources, for weather or events.
• You can set custom station labels.
• You can disable it for certain vehicle classes.
• Optional driver only mode.
• Configurable UI size / scale.
• Locale support.

Requirements

• A FiveM server on a latest recommended build.

The resource manifest declares:

dependencies {
    '/server:35245' -- Server artifacts / build number
}

Installation

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

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

3. Move scully_vehicleradio.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_vehicleradio.cfg

5. Start the resource:

ensure scully_vehicleradio

6. Restart the server.

Important: The resource intentionally throws an error if scully_vehicleradio.cfg is left inside the resource folder. Copy it next to server.cfg, then delete it from the resource. This exists so the step can't be skipped by accident.

Configuration

Server-wide settings live in scully_vehicleradio.cfg. Station icons and colors are configured in data/stations.lua.

Core

setr scully_vehicleradio:locale "en"
setr scully_vehicleradio:scale 100

Controls

setr scully_vehicleradio:wheelControl 85
setr scully_vehicleradio:nextControl 81
setr scully_vehicleradio:previousControl 82
setr scully_vehicleradio:sensitivity 1.6

These are control IDs rather than keys, so they follow whatever the player has bound to the GTA radio controls in their settings.

Behaviour

setr scully_vehicleradio:driverOnly "false"
setr scully_vehicleradio:hideDefaultPopup "true"
setr scully_vehicleradio:showToast "true"
setr scully_vehicleradio:toastTime 3000
setr scully_vehicleradio:showOff "true"

Now playing

setr scully_vehicleradio:showTrack "true"
setr scully_vehicleradio:trackToast "true"

Talk shows and adverts have no song name, so they show as "Talk / adverts".

Static & interference

setr scully_vehicleradio:staticVolume 35
setr scully_vehicleradio:tuningStatic "true"
setr scully_vehicleradio:dropouts "true"

Data Files

Customising

Stations (data/stations.lua)

return {
    defaultIcon = 'radio',
    defaultColor = '#8d99ae',
 
    disabled = { 'RADIO_19_USER', 'RADIO_36_AUDIOPLAYER' },
 
    blockedClasses = {},
 
    labels = {},
 
    interiorInterference = 0.6,
 
    weatherInterference = {
        [`THUNDER`] = 0.7,
        [`SNOW`] = 0.7,
        [`BLIZZARD`] = 0.7,
        [`SNOWLIGHT`] = 0.7,
        [`XMAS`] = 0.7,
        [`HALLOWEEN`] = 1.0
    },
 
    areas = { ... },
 
    stations = {
        RADIO_01_CLASS_ROCK = { icon = 'guitar-pick', color = '#ef5350' },
        RADIO_05_TALK_01 = { icon = 'message-circle', color = '#8d99ae', enabled = false },
        ...
    }
}

Areas

Every area the player is in applies at once. If you're tuned to a station that can't be heard where you're driving, the radio moves to one that can and shows "No signal".

areas = {
    {
        label = 'Mount Chiliad',
        coords = vec3(501.0, 5604.0, 797.0),
        radius = 650.0,
        minHeight = 450.0,
        only = { 'RADIO_05_TALK_01', 'RADIO_11_TALK_02' },
        interference = 0.55
    },
    {
        label = 'Fort Zancudo',
        zones = { 'ARMYB' },
        interference = 0.9
    }
},

Station names are the GTA ones, for example: RADIO_01_CLASS_ROCK. exports.scully_vehicleradio:getStations() lists the ones available where you are.

Keybinds & Commands

While the picker is open, move the mouse left and right to pick a station, or tap the next / previous keys to move one at a time.

Exports

Client exports

exports.scully_vehicleradio:setStation('RADIO_02_POP')
 
-- Disable the picker and use the default radio.
exports.scully_vehicleradio:setDisabled(true)
 
-- Set your own custom interference.
exports.scully_vehicleradio:setInterference(0.4)
 
local track = exports.scully_vehicleradio:getCurrentTrack()
 
if track and track.song then
    print(('%s - %s'):format(track.song, track.artist))
end

Locales

Locale files go in locales/ and the active one is set with:

setr scully_vehicleradio:locale "en"

To add a language, copy an existing locale file and translate its values.

Support

For support, updates and community discussion, join the Scully's Development community: https://discord.gg/scully (opens in a new tab)