Connect ESX, QBCore or QBox
Bring your framework's characters, vehicles, licences, jobs and money into the CAD, and have fines, jail, impounds and duty in the CAD happen in game too.
The Integrations module joins your server's framework and the CAD together, so nobody does anything twice:
- Characters in game become civilians, with the vehicles they own, their licences, their firearms and their money.
- A framework job puts players on the right department roster at the right rank, and duty in game signs them on in the CAD.
- Fines, jail sentences, impounds and licence changes made in the CAD happen in game.
It works with ESX, QBCore and QBox, and reads characters and vehicles from ox_core and ND_Core. The LonexOne FiveM resource finds your framework by itself.
Before you start#
- The CAD and Integrations modules need to be installed.
- Your game server needs the LonexOne FiveM resource, version 0.7.0 or newer. See Install the LonexOne FiveM resource.
- Your framework and oxmysql must start before LonexOne in your
server.cfg. - To change the settings, you need the Connect the game framework and choose what it syncs to the CAD permission.
Turn it on#
- Install the Integrations module from Modules in your control panel.
- Restart the LonexOne resource, or your server.
- Open Integrations in the sidebar. Under Game servers, your server shows the framework it found within a minute.
The first time it connects, the resource brings every character, licence, firearm and owned vehicle across. On a big server this can take a few minutes. The server console says Integrations: connected to qbcore (or esx, qbox, ox or nd) and how many characters it synced.
Players who haven't joined the site yet#
Characters are kept in the CAD even when the player has no LonexOne account. They wait with the player's Discord account and become theirs the moment that person joins your community site with Discord. Their job does the same: they land on the right roster when they join. Officers can look them up straight away either way.
Waiting for the player to join the site on the Integrations page shows how many are waiting.
From the game#
| Setting | What it does |
|---|---|
| Characters | Each character becomes a civilian with its name, date of birth, gender and phone. The character a player is playing is their current civilian in the CAD and for /showid. |
| Owned vehicles | Owned vehicles are registered to their character. Vehicles sold or deleted in game leave the CAD. Checked every 10 minutes. |
| Licences | Licences a character holds in game are added in the CAD. |
| Firearms from ox_inventory | Weapons with a serial number in ox_inventory are registered to whoever holds them. A weapon that changes hands moves to its new owner. |
The game decides who a character is and what they own. The CAD keeps its own papers, flags, records, warrants, suspensions and impounds, and the sync never overwrites them.
Civilians made in the CAD#
Under Civilians made in the CAD, choose:
- Only from game characters: the CAD's New character button goes away, so every civilian is a real character. This is the starting choice.
- Game characters, and players can still make their own in the CAD: both work side by side.
Civilians players made before you connected stay either way.
Jobs and duty#
Your framework's jobs show under Jobs and duty once a server has connected. For each job you want in the CAD:
- Open the job and pick its Department.
- Click Save.
- Open it again and pick the Rank for each grade. A grade with the same name as one of your ranks is matched by itself.
- Click Save.
Then:
- Jobs put players on the roster: someone with that job is added to the department at the rank for their grade, and promoted or demoted as their grade changes in game.
- Leaving the job takes them off the roster: when they change job in game, they leave the roster the job put them on. People you added to a roster by hand are never taken off.
- Duty follows the game: going on duty in the framework signs them on in the CAD with their roster callsign, and going off duty signs them off. Signing on or off in the CAD, or with
/onduty, sets their duty in the framework too. Being on duty when they join the server doesn't sign them on; only going on duty does.
Jobs and duty are checked every 15 seconds.
In game#
| Setting | What it does |
|---|---|
| Fines come out of the bank | A citation or arrest takes its fine from the character's bank in game, and it shows as paid in the CAD under Bank in game. If they can't afford it, the fine stays owed. |
| Jail sentences | Pick your jail resource: qb-prison, qbx_prison, esx-qalle-jail, or another one through a server event. Minutes in jail for each month turns the sentence into game time. |
| Impounds follow the car | Impounding a car in the CAD takes it off the street and into the framework's impound. Releasing it puts it back in their garage. |
| Licence changes reach the game | A licence suspended, revoked or restored in the CAD is taken away or given back in game. |
| Use the game's money instead of the CAD bank | The CAD bank is switched off, and each civilian's bank and cash from the game show on their profile. |
Fines, licences and impounds happen even when the player is offline. Jail waits until they're back on the server, for up to a week.
Sent to the game on the Integrations page lists what the CAD has sent and whether it worked.
Another jail resource#
Choose Another jail resource, through a server event and type the event your jail listens for. LonexOne fires it on the server with the player's server id, the minutes and the reason, like TriggerEvent('myjail:server:jail', source, minutes, reason).
Licences#
The Licences table lists the licence names your framework uses, like driver and weapon on QBCore, or drive, drive_bike and weapon on ESX. Pick which of your licence types each one counts as, or Ignore it. Common names are matched for you, for example weapon to your firearms licence.
What each framework supports#
| QBCore and QBox | ESX | ox_core and ND_Core | |
|---|---|---|---|
| Characters and vehicles | Yes | Yes | Yes |
| Licences | Yes | Yes, with esx_license | No |
| Jobs on the roster | Yes | Yes | No |
| Duty | Yes | Only versions with job duty | No |
| Fines, impounds and licence changes | Yes | Yes | No |
| Money | Yes | Yes | ND_Core only |
Something not working?#
The server shows "No framework reported yet".
Make sure your framework and oxmysql start before LonexOne in server.cfg, then restart LonexOne.
The console says "could not read characters from the database".
oxmysql isn't running, or your framework uses different table names. LonexOne reads the standard tables: players and player_vehicles for QBCore and QBox, users, owned_vehicles and user_licenses for ESX, characters and vehicles for ox_core, and nd_characters and nd_vehicles for ND_Core.
A player's characters aren't on their account. They need to join your community site with the same Discord account they use in FiveM. Their characters move across as soon as they do.
"You need a callsign on the roster before you can go on duty in the CAD." Give them a callsign on the department roster. Duty in game can't sign them on in the CAD without one.
A fine shows "Not enough in the bank". The character couldn't afford it, so it stays owed in the CAD. They can pay it in the CAD later.
ESX vehicles show a number instead of a model. ESX saves vehicles by their model number rather than name. The plate and owner are right.
See also
Can't find what you need?
Open a ticket in our Discord and someone from the team will help. Found a bug, or missing a feature? Tell us on the feedback board.