Installation

1. Requirements

oxmysql
One framework: ESX, QBCore or Qbox
Optional: ox_target or qb-target, a dispatch, a garage and a clothing resource
Optional: kyoGangTerritories

2. Game build

Most interiors work on any game build. A few need a newer one:

Interior	Minimum `sv_enforceGameBuild`
Meth, cocaine, weed, counterfeit cash, documents, bunker, warehouses, clubhouses, vehicle warehouse	any
Nightclub, facility	1290
Acid lab	2802

sv_enforceGameBuild 2802

Note: if your server runs an older build, don’t create acid labs or headquarters inside the nightclub or the facility. The lab would load an empty interior.

3. Add the resource

Put the kyoEmpireBuilder folder in your resources folder.
Start it after oxmysql, the framework, the inventory and the target:

ensure oxmysql
ensure es_extended        # or qb-core / qbx_core
ensure ox_inventory       # your inventory
ensure ox_target          # optional
ensure kyoEmpireBuilder

4. Items

The install/ folder has the items ready for every inventory. Use the file of the inventory you run:

Inventory	File	Where to paste it
ox_inventory (also Qbox)	`install/ox_inventory.lua`	`ox_inventory/data/items.lua`
qs-inventory	`install/qs-inventory.lua`	`qs-inventory/shared/items.lua`
qb-inventory	`install/qb-inventory.lua`	`qb-core/shared/items.lua`
origen_inventory	`install/origen_inventory.lua`	the items file of origen_inventory
ESX default inventory	`install/esx.sql`	run it in your database

Item images

install/items/ contains a transparent 256×256 image for every item, named <item>.png. Copy them to the image folder of your inventory:

Inventory	Image folder
ox_inventory	`ox_inventory/web/images/`
qs-inventory	`qs-inventory/html/images/`
qb-inventory	`qb-inventory/html/images/`
origen_inventory	the images folder of origen_inventory
ESX default inventory	not needed, it shows no images

Items used by the script

Item	Used for
`meth_bag`, `coke_bag`, `weed_bag`, `counterfeit_cash`, `fake_id`, `weapon_parts`, `acid_tab`	Lab products
`chemicals`, `pseudoephedrine`, `coca_leaf`, `weed_seed`, `fertilizer`, `paper_roll`, `ink_cartridge`, `steel`, `gunpowder`	Ingredients that add supplies to a lab
`police_ram`	Police: breach a lab during a raid
`breach_kit`	Wars: force a rival organization’s lab

Every item can be renamed in config/config_labs.lua (products, ingredients, Config.Wars.BreachItem) and config/config.lua (Config.Police.RamItem).

5. Database

Nothing to do. With Config.AutoInstallSQL = true the tables are created and updated on start.

If you prefer to import them yourself, set it to false and run kyoEmpireBuilder.sql.

6. Admin access

Give the ACE permission to your admins in server.cfg:

add_ace group.admin kyo.empire.admin allow

Or add their identifiers to Config.Admin.Identifiers in config/config.lua:

Identifiers = {
    'license:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx',
},

7. Discord logs (optional)

Paste your webhook URLs in config/config_server.lua. That file is server-only, so players can never read it.

8. First steps in game

/admineb > Organizations > New organization, or let players buy one at the NPC.
Points > New point: organization panel, stash, garage and wardrobe. They are placed where you stand. A point created while you are inside a lab only exists in that lab.
Labs > New lab: choose the type and the owner. The entrance is placed where you stand. Use Vehicle point here to choose where mission vans appear.
Interiors > Visit: if an exit, laptop, storage or table is slightly off, stand where it should be and press its button.

Tip: if bosses are allowed to place their own points (Config.Orgs.BossPoints), step 2 is optional. See Configuration.