For the complete documentation index, see llms.txt. This page is also available as Markdown.

Installation

1

Install dependencies

Make sure every resource on the Dependencies page is installed and starts before Blackmarket. At minimum: your framework, ox_lib, oxmysql, an inventory and a target resource.

2

Add the resource

  1. Download the asset from the FiveM Keymaster (Granted Assets) or your order, and unzip it.

  2. Drop the rm_blackmarkets folder into your server's resources directory (for example resources/[rainmad]/rm_blackmarkets).

3

Start the resource

Add it to your server.cfg, after its dependencies:

ensure oxmysql
ensure ox_lib
ensure ox_inventory      # or your inventory
ensure ox_target         # or qb-target

ensure rm_blackmarkets
4

Database

There is nothing to import. On the first start the resource creates its tables automatically through oxmysql:

  • rm_blackmarkets_warehouses, rm_blackmarkets_members, rm_blackmarkets_inventory, rm_blackmarkets_orders

  • rm_blackmarkets_sales_log, rm_blackmarkets_vault_log, rm_blackmarkets_audit_log

  • phone tables (only when cfg.bridge.phone isn't false): rm_blackmarkets_warehouse_public, rm_blackmarkets_conversations, rm_blackmarkets_messages

5

Register your items

Every item in cfg.items (weapons, ammo, drugs, tools…) must already exist in your inventory. Items that are not registered there cannot be ordered, stocked or sold. See How to Add an Item.

6

Grant admin access

By default, anyone with FiveM's built-in command ace (the server console, usually group.admin) can open the admin panel. To allow specific staff without that ace, add their identifiers to cfg.admin.allowedIdentifiers. Then run the command (default /bm_admin) in-game to create your first warehouse.

cfg.admin = {
    command = 'bm_admin',
    allowedIdentifiers = {
        ['license:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'] = true,
    },
}

See Admin Panel for what the panel can do.

7

Configure

Open cfg.lua and set your framework/target, currency, items, warehouse coordinates, police jobs and the rest. The Configuration page walks through every section.

Last updated