Lumo Docs

Installing a resource ​

The same steps work for every Lumo resource. Each product's own Installation page then lists what is specific to it: what it replaces, SQL, and per-framework notes.

1. Download ​

  • Escrow edition: sign in to Cfx Portal with the Cfx.re account you linked at checkout and open Granted Assets. Download the resource there.
  • Open-source edition: use the download from your purchase.

The server running an escrow edition must use a license key (sv_licenseKey) from that same Cfx.re account, or the resource refuses to start.

2. Put it in your resources ​

  1. Unzip it into your resources folder, for example resources/[lumo]/.
  2. Keep the folder name. Other resources call it by name (exports['lumo-clothing']), so a renamed folder breaks them.
  3. Some zips contain a [compat] folder. It holds small stand-ins for stock resources (for example qb-inventory or qbx_spawn). Move only the ones the product's Installation page tells you to use, and delete the rest.

3. Requirements ​

Almost everything needs these two, started before any Lumo resource:

cfg
ensure oxmysql
ensure ox_lib

The framework (qb-core, qbx_core or es_extended) is detected on its own. Everything else a resource can use (target, inventory, clothing, phone) is optional and detected at runtime. Compatibility lists what each resource cannot start without.

4. server.cfg order ​

Start a resource after whatever it talks to:

cfg
ensure oxmysql
ensure ox_lib
ensure qb-core              # or qbx_core / es_extended / nothing
ensure ox_inventory         # your inventory
ensure ox_target            # optional: lumo-interact, qb-target or ox_target

ensure lumo-clothing        # then the Lumo resources
ensure lumo-apartments

5. Remove what it replaces ​

Two scripts doing the same job (two inventories, two clothing scripts, two multicharacters) fight over the same events. Each Installation page has a remove list for QBCore, Qbox and ESX. Remove the old script; do not just stop it in txAdmin, or it comes back on the next restart.

6. Database ​

Most resources create their tables on first start; the product's Installation page says so, or names the sql/ file to import. Restart the whole server the first time, not only the resource, so other resources see it from the start.

7. Check the console ​

Most resources print the framework they found on start, for example:

text
[lumo-clothing] ready — framework: esx

If you see red errors instead, see Troubleshooting.