Installation

Do not use FileZilla. It can corrupt or skip hidden files during upload. We recommend WinSCP.

Requirements

Server Build 17000+

Your FXServer artifact must be above 17000, with OneSync enabled.

A MySQL Wrapper

oxmysql or mysql-async. ESX Legacy, QBCore and Qbox all ship one already.

An Audio Resource

xsound (recommended) or mx-surround. Without one, the Music app stays silent.

Any Framework

ESX Legacy, QBCore, Qbox or Standalone — detected automatically, no bridge resource to install.

Installation Steps

Create the resource folder

Create a folder in your resources directory called [road] (or use one you already have), and extract the download into it.The resource folder itself must be named roadcarradio — the exports and the NUI page reference that name.

resources/
  [road]/
    roadcarradio/
      fxmanifest.lua
      config.lua
      client/  server/  bridge/  locales/  public/

Start the resource

Add it to your server.cfg, after your framework and your MySQL resource:

server.cfg

ensure oxmysql
ensure es_extended      # or qb-core / qbx_core
ensure xsound
ensure roadcarradio

Database

Nothing to import. On the first start RoadCarRadio creates every table it needs and prints:

[RoadCarRadio] Database ready (8 tables checked)

roadcarradio.sql is still included if you prefer to import the schema by hand, but it is not required.

Add the inventory item

Only needed if you keep the install system enabled (Config.NeedInstall = true). Add these items to your inventory:

Item	Purpose
`carradio`	Installs the radio into the vehicle the player is sitting in
`removecarradio`	Takes it back out

ESX
QBCore / Qbox
ox_inventory

INSERT INTO `items` (`name`, `label`, `weight`, `rare`, `can_remove`) VALUES
  ('carradio', 'Car Radio', 1, 0, 1),
  ('removecarradio', 'Radio Removal Kit', 1, 0, 1);

Add to qb-core/shared/items.lua:

['carradio'] = { name = 'carradio', label = 'Car Radio', weight = 1000, type = 'item', image = 'carradio.png', unique = false, useable = true, shouldClose = true, description = 'Installs a radio into a vehicle' },
['removecarradio'] = { name = 'removecarradio', label = 'Radio Removal Kit', weight = 1000, type = 'item', image = 'removecarradio.png', unique = false, useable = true, shouldClose = true, description = 'Removes a radio from a vehicle' },

Add to ox_inventory/data/items.lua:

['carradio'] = { label = 'Car Radio', weight = 1000, stack = true, close = true },
['removecarradio'] = { label = 'Radio Removal Kit', weight = 1000, stack = true, close = true },

Want every vehicle to have it without any item? Set Config.NeedInstall = false in config.lua and skip this step entirely.

Restart and open it

refresh
ensure roadcarradio

Get into a vehicle and press M (configurable via Config.OpenKey).

Installation complete. Head to Configuration below to tune it to your server.

Configuration

Everything lives in config.lua, which is escrow_ignore — you can read and edit it freely. The settings you will most likely touch first:

Access

config.lua

Config.OpenKey = "M"              -- Key that opens the screen
Config.OnlyDriver = true          -- false lets every occupant use it
Config.AllOccupantsCanControl = true
Config.DamageUse = true           -- Screen stops working on a wrecked car
Config.MinimumCarHealth = 80      -- ...below this percentage

Install system

config.lua

Config.NeedInstall = true         -- false = every vehicle has it
Config.NeedJob = false            -- true = only the jobs below may install
Config.Jobs = { "mechanic" }
Config.RemoveCarRadioAfterInstall = false
Config.BuildInAnimation = true

Music

config.lua

Config.AudioLibrary = 'xsound'    -- 'xsound' or 'mxsurround'
Config.DefaultMusicValue = 0.5    -- Starting volume
Config.DefaultMusicRange = 2.0    -- Audible range in metres
Config.DefaultMusicRangeBrokenWindow = 10   -- ...with the windows broken
Config.SkipMusicNeedAccept = false -- true auto-approves submitted songs
Config.DisableRadioMusic = true   -- Mutes the game radio while music plays

Custom Music API

Replace the built-in library entirely and serve songs from your own HTTP server.

Rear camera

config.lua

Config.RearCamera = {
    active = true,
    autoWhenReversing = true,
    autoReverseDelay = 1200,      -- ms of continuous reversing before it opens
    holdToView = false,           -- true = hold the key instead of toggling
    toggleKey = 21,               -- LEFT SHIFT
    needCarRadioInstalled = true,
    vehicleTypes = { "automobile", "bike" }
}

autoReverseDelay stops the camera flipping up every time someone taps S while manoeuvring. Set it to 0 for the old behaviour of switching instantly.

Autopilot

config.lua

Config.AutoMaxSpeed = 30.0        -- 30.0 ≈ 108 km/h
Config.AutoFlagsUsed = 316        -- Driving style flags
Config.AutopilotNeedAccess = false
Config.AutopilotAccessCars = { "adder", "zentorno" }

Diagnostics

config.lua

Config.Debug = false              -- true registers /rearcamdebug

Updating

Back up your config.lua

Updates overwrite everything except the files you have edited. Keep a copy of config.lua, MusicAPI.lua and locales/ before replacing the folder.

Replace the resource folder

Delete the old roadcarradio folder and upload the new one, then restore your config.lua.

Compare your old config.lua against the new one. New releases add keys, and a key that is missing falls back to a built-in default — which may not be the value you want.

Restart

refresh
restart roadcarradio

New tables and columns are added automatically on start. There is no SQL file to import for an update.

Coming from RoadCarPlay?

The resource was renamed, and so were the things your other scripts might reference:

Old	New
Resource folder `roadcarplay`	`roadcarradio`
Item `carplay` / `removecarplay`	`carradio` / `removecarradio`
`exports['roadcarplay']:blockCarPlay()`	`exports['roadcarradio']:blockCarRadio()`
`exports['roadcarplay']:unblockCarPlay()`	`exports['roadcarradio']:unblockCarRadio()`
`getCarsCarplayIsInstalled`	`getCarsCarRadioIsInstalled`
`/openCarplay`, `/fixcarplay`	`/openCarRadio`, `/fixcarradio`
`Config.RemoveCarPlayAfterInstall`	`Config.RemoveCarRadioAfterInstall`

Your installed vehicles migrate themselves. On the first start the old roadshop_carplay_cars table is copied into roadshop_carradio_cars and renamed to roadshop_carplay_cars_migrated. Nothing to do by hand — you can delete the renamed table once you have checked it went through.

Next Steps

Commands

Every command and keybind the resource registers

Custom Music API

Serve your own music library from your own server

Client API

Exports for integrating RoadCarRadio with your own scripts

FAQ

Common questions and troubleshooting

Home

RoadPhone Pro

RoadPhone

RoadPad

RoadCarRadio

RoadPods

RoadBackup

Requirements

Server Build 17000+

A MySQL Wrapper

An Audio Resource

Any Framework

Installation Steps

Configuration

Access

Install system

Music

Custom Music API

Rear camera

Autopilot

Diagnostics

Updating

Coming from RoadCarPlay?

Next Steps

Commands

Custom Music API

Client API

FAQ

​Requirements

Server Build 17000+

A MySQL Wrapper

An Audio Resource

Any Framework

​Installation Steps

​Configuration

​Access

​Install system

​Music

Custom Music API

​Rear camera

​Autopilot

​Diagnostics

​Updating

​Coming from RoadCarPlay?

​Next Steps

Commands

Custom Music API

Client API

FAQ

Requirements

Installation Steps

Configuration

Access

Install system

Music

Rear camera

Autopilot

Diagnostics

Updating

Coming from RoadCarPlay?

Next Steps