Browse docs

Installation

Install the required resources, prepare inventory items, and open the Crime System setup.

What you need

Crime System supports ESX, QBCore, and Qbox. You also need:

  • sky_base
  • sky_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:

server.cfg
ensure sky_base
ensure sky_jobs_base
ensure sky_crimesystem

The FiveM server commands reference explains the start command if you need more detail.

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 155 default items and complete ox_inventory and ESX import blocks. Choose the format for your active inventory and add the missing entries.

The Drug Creator attempts to add its items automatically. Check the server console for missing-item warnings and add any missing items to your inventory.

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:

SettingControls
Config.AutoExecuteQueryMain Crime tables
Config.HeistPersistence.enabledSaving heist definitions and plans
Config.HeistPersistence.autoMigrateAutomatic setup of the heist tables
Config.PvPEvents.autoMigrateAutomatic 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.