INSTALLATION#

This page walks you from download ➜ placement ➜ startup order ➜ framework setup. If anything fails, check the Common mistakes list at the end.

ASSET DOWNLOAD#

📌 INSTRUCTION — To access the asset, you must have purchased it using your own Keymaster account. If you need to transfer the asset to a different Keymaster account, you can use the transfer system. Please note that the transfer can only be performed once for an asset, so ensure the transfer is done carefully

First, log in to the CFX portal. Once inside, grab the asset from the official CFX page—you can download it as many times as you like. Need updates later? Just head back to the same page and download again.

First, log in to the official CFX portal by clicking here

Finding Your Assets#

Once logged in, navigate to the "Granted Assets" section to view all the assets you've purchased. Locate the asset you want to download and click on Download Button it.

WHAT IS CFX AUTH?

ASSET DEPENDENCIES#

All dependencies are mandatory—use the full dependency guide and include every required file.

When downloading a dependency, make sure the file is fully unzipped and does not contain "-main" at the end of its folder name. If it does, remove "-main" before using it.

REQUIRED DEPENDENCIES:

onex-base — Download by clicking here
- For every script that requires onex-base, it is automatically included with your purchase.

UPDATE ARTIFACTS & GAME BUILD#

Keeping your artifacts and game build up to date is essential to prevent common server issues. Follow the steps below to update correctly:

Update Artifacts#

💡TIP — To find the best FiveM artifact, visit artifacts.jgscripts.com. Thanks to JG Scripts.

Replace your existing artifacts with the latest version. Download the correct artifacts for your operating system from the official sources:

Windows: Windows Artifacts
Linux: Linux Artifacts

Update Gamebuild#

Download the latest artifacts for your operating system from the official sources and replace your existing artifacts with the new version.

server.cfg
sv_enforceGameBuild 3095

ASSET POSITIONING#

Please note that this asset includes two downloads: onex-spawn and onex-base. You can place and start both within the same folder.

— Onex Scripts

To run this asset correctly, you must follow the proper start order. We recommend placing all dependencies and the onex-spawn asset inside the [onex] folder for clean organization.

📌 CAUTION — If you don't, you'll need to start each dependency manually in the correct order.

server.cfg
# Always start core frameworks first
ensure es_extended or qb-core

# Start all Onex dependencies and assets together
ensure [onex]

If you prefer to keep resources separate, list them individually in the proper order:

server.cfg
  # Always start core frameworks first
  ensure es_extended or qb-core

  # Start each dependency and Onex asset in order
  ensure onex-base

  # Other onex scripts if you have
  ensure onex-spawn

🌐 INFO — The script automatically detects your framework and uses the appropriate events and data structures. No additional framework-specific setup is required.

QB-APARTMENTS INTEGRATION (OPTIONAL)#

If you're using qb-apartments, onex-spawn provides seamless integration:

Enable QB-Apartments Support#

The script automatically detects if qb-apartments is installed and provides apartment spawn options.

Configure Apartment Locations#

Apartment spawn locations are pre-configured in config/config.lua under Settings.QBApartmentsLocations. You can add more apartments or customize existing ones.

How It Works#

When a player has an owned apartment, they'll see their last location. If they don't own an apartment, they'll see the apartment selection screen to choose one.

💡 TIP — QB-Apartments integration is automatic. Just ensure qb-apartments is started before onex-spawn in your server.cfg.