Skip to Content
QBCore docs – powered by Nextra 4
Getting StartedGetting Started with QB-Core

Goal

Set up a local QB-Core development server the way QBCore is actually deployed: through FiveM server artifacts, txAdmin, and QBCore resources.

Prerequisites

  • FiveM server artifacts
  • A valid FiveM license key
  • MariaDB or MySQL running
  • A local Windows or Linux environment for testing

Steps

  1. Start with the platform install guide

  2. Install the FiveM server artifacts and open txAdmin Follow the platform guide to download the server artifacts, create your server data folder, and finish the first txAdmin setup.

  3. Deploy QBCore as server resources Use the txAdmin recipe/template flow or the installation guide to place qb-core and the required companion resources in your server’s resources directory.

  4. Configure your server Add your license key, database connection string, and required ensure lines in server.cfg.

  5. Start the server and test locally Boot the server from txAdmin or your start script, then connect from FiveM to confirm the server loads cleanly.

Do not treat qb-core as a standalone Node.js app. Cloning the repository and running npm start will not produce a working FiveM/QBCore server.

Verification

  • txAdmin finishes recipe deployment or the server starts without resource errors
  • The console shows the QBCore resources loading
  • You can connect from FiveM to your local endpoint (commonly localhost:30120)

See also

Last updated on