Electus LogoElectus Documentation

Installation

Step-by-step installation guide.

Installation Steps

Please ensure you follow these steps carefully. If you are having trouble installing, please join our Discord for support.

Make sure to use MariaDB version 11+. You can find how to upgrade here. Also make sure to make a backup before upgrading!

Download the package

Download the package from Portals.

Run the SQL file

electus_heists.sql

Run electus_heists.sql in your database. It creates the heist, active heist, crew, heat, level, skill tree, interior placement, and overlap group tables.

The included database checker can create missing tables and columns on startup, but you should still import the SQL file during installation.

Add script to server.cfg

Add electus_heists after its dependencies.

ensure oxmysql
ensure ox_lib
ensure bob74_ipl
ensure electus_heists

If your server uses another compatible database resource, make sure it provides the MySQL.*.await API before electus_heists starts.

Add the items to your inventory

The resource includes item definitions in inventory_items.lua.

inventory_items.lua

Inventory icons

Place the icons from electus_heists/imgs/items in your inventory script's image folder.

If your inventory uses a custom image path, update Config.InventoryPath in config/config.lua.

Configure admin access

The heist creator command is:

/heists

Access is controlled by Config.AdminPermissions in config/config.lua. You can allow console access, ACE permissions, framework groups, or specific identifiers.

Configure contract access

The contracts UI can be opened by command or NPC.

The default command is:

/contracts

Configure these entry points in Config.ContractMenu.

Import default heists

Default JSON archives are included in:

  • heists_jsons/default
  • heists_jsons/k4mb1

Open /heists, use the Projects import flow, and import the JSON files you want to use. K4MB1 heists require the matching maps/MLOs.

Configure the script

In the folder config you will find all configurable files.

Restart your server

Restart your server to apply the changes.