Browse docs
Installation
What you need
Crime System supports ESX, QBCore, and Qbox. You also need:
sky_basesky_jobs_base- Your working framework, database, inventory, and targeting setup.
Keep the Sky resources up to date together. Police Job, Ambulance Job, and Fire Job add optional integrations; they are not required to install Crime System.
For download, license, or general server setup help, use the Installation Guide.
Installation steps
Add the resource
Copy the sky_crimesystem folder into your server's resources directory. This is the folder containing fxmanifest.lua. Do not rename it.
Set the start order
Add these lines to your server.cfg, after your framework, database, inventory, and targeting resources:
add_filesystem_permission sky_base write sky_jobs_base
add_filesystem_permission sky_base write sky_crimesystem
ensure sky_base
ensure sky_jobs_base
ensure sky_crimesystem
The FiveM server commands reference explains the start command if you need more detail.
These filesystem permissions allow Sky Base to save
files for Jobs Base and Crime System. Keep them before the Sky ensure lines and perform a
full server restart after adding or changing them.
Leave automatic database setup enabled
The normal installation creates and updates its database tables automatically. Keep the shipped database settings enabled.
You do not need to manually import Crime's table schema for this setup. Your inventory may still need its separate item import in the next step. If the console reports a database error when the server starts, resolve it before continuing.
Prepare the items
Open Inventory Items. It contains all 166 default items and complete blocks for ox_inventory, QS, QB-Core, Tgiann, Jaksam, CodeM, and ESX. Choose the format for your active inventory and add the missing entries.
The Drug Creator can register and persist items at runtime when the active inventory supports it. ox_inventory still needs the supplied item definitions because it does not provide the required runtime-definition API. In every case, check the server console for missing-item warnings.
Give yourself setup access
Follow Permissions to configure your administrator group. You will check the commands after starting the server.
Start the server
Check the console for errors, then open /jobconfig and select Crime System.
Check: /jobconfig, /drugcreator, and /heistcreator all open for your administrator. Resolve startup errors or missing permissions before creating your organization.
Continue with First Setup to prepare your organization and its activities.
If you manage database setup manually
The database switches are in config/config.lua:
| Setting | Controls |
|---|---|
Config.AutoExecuteQuery | Main Crime tables |
Config.HeistPersistence.enabled | Saving heist definitions and plans |
Config.HeistPersistence.autoMigrate | Automatic setup of the heist tables |
Config.PvPEvents.autoMigrate | Automatic setup of faction event tables |
The supplied import.sql includes the main Crime and PvP tables, but not the separate heist tables. Keep heist auto-migration enabled unless you maintain those tables yourself.
Before updating later
Back up the database and your customized config folder. The database stores your setup and player progress, including owned laboratories, plants, stock, and heist plans.
Also keep copies of edited heist files and exports. Follow Updates and Backups, then test the features affected by the update.