Installation Guide

This guide walks you through installing ARS CarPlay on a FiveM server. Follow each step in order — the load order in server.cfg matters.

Prerequisites

Before installing, ensure these resources are already installed and started on your server:

Resource	Purpose	Required
ox_lib	Locales, callbacks, notifications, keybinds	Yes
xsound	Audio backend for Music & Internet Radio (positional 3D sync)	Yes
qb-core or qbx_core or es_extended	Player framework (one of three)	Yes
oxmysql	Vehicle ownership checks for persistent settings (plate scope)	Optional (soft dependency)

Load order is critical. ox_lib and xsound must start before ars_carplay. Your framework must also be started before ars_carplay so auto-detection works.

Installation Steps

1. Download and Place Resource

Download the resource from the CFX portal and place it in your server’s resources folder:

server-data/resources/[ARS]/ars_carplay/

The folder name must be ars_carplay (matches the fxmanifest.lua resource name).

The NUI (html/) is pre-built and included. No build step required.

2. Add to server.cfg

Add the ensures in this exact order:

ensure ox_lib
ensure xsound
ensure ars_carplay

If you use a subfolder (e.g., [cars]), the path is ensure [cars]/ars_carplay.

3. Choose a Framework

Open config.lua and set Config.Framework:

Config.Framework = 'auto'  -- 'auto' | 'qb' | 'qbx' | 'esx'

• 'auto' (default) — Detects the running framework at startup (qbx_core > qb-core > es_extended).
• Pin to 'qb', 'qbx', or 'esx' to skip detection.

4. Verify In-Game

1. Start your server.
2. Spawn a vehicle (must be a car/truck — bikes, boats, aircraft are disabled by default).
3. Enter the driver seat.
4. Type /carplay.
5. The CarPlay tablet should appear docked at the bottom-right.

Updating the Resource

When a new version is released:

1. Replace the resource folder.
2. Restart the resource in-game (refresh + ensure ars_carplay).

Verification Checklist

After installation, confirm:

• ox_lib and xsound show as started in resmon before ars_carplay.
• Framework resource (qb-core / qbx_core / es_extended) is started.
• In-game: driver seat + F6 opens the dashboard.
• Music app plays a direct .mp3 URL and a YouTube link.
• Vehicle app toggles engine, doors, windows, lights.
• Navigation shows street name, speed, heading, and nearby POIs.
• Radio app switches between FM presets and Internet streams.

Troubleshooting

Symptom	Likely Cause	Fix
/carplay does nothing / no notification	Not in a vehicle, not driver seat, or vehicle class disabled	Check Config.CarPlay.disabledVehicleClasses (default: 8, 13, 14, 15, 16)
UI opens but no audio (Music/Radio)	xsound not started or started after ars_carplay	Move ensure xsound above ensure ars_carplay in server.cfg
“No framework detected” print in console	Framework resource name differs or not started	Set Config.Framework = 'qb' | 'qbx' | 'esx' explicitly
Settings don’t persist after restart	oxmysql not started; plate-scope ownership check fails	Start oxmysql before ars_carplay, or set Config.CarPlay.ownership.fallbackOwned = true (default)
NUI shows “CarPlay unavailable for this vehicle”	Vehicle class in disabledVehicleClasses	Remove the class ID from Config.CarPlay.disabledVehicleClasses
Fuel gauge reads 0 / wrong	Fuel system not auto-detected	Set Config.Vehicle.fuelSource = 'native' or pin a system key (e.g., 'ox_fuel')

---

Note: This guide is written by a third party. If you find any incorrect or outdated information, please contact us on Discord so we can update it for you.