Skip to main content

Getting Started with QBCore

This guide will help you set up QBCore for HELIX so you can start developing right away. QBCore is distributed as a single GitHub repository containing all of its Lua packages. Simply download it, place it in your HELIX workspace, and you’re ready to go.

Game Client - preferred method

Launch HELIX game​

  • Browse the worlds tab and find the QBCore Template World
  • Click on the preview image and click the button that says REMIX
  • Enter your desired world name and press CONFIRM

You now have your very own world of the latest version of the QBCore template and can edit it as much as you please! This method also already installs all the required dependencies for you for less hassle!

GitHub - advanced method

1. Download QBCore​

Head to the official GitHub repository:

HELIX QBCore

You can either:

  • Click Code → Download ZIP to download it directly, or
  • Clone it using Git:
git clone https://github.com/hypersonic-laboratories/qbcore-rp

2. Create A Workspace​

  • Launch the HELIX client, click "Create World" & configure it.
  • Click continue, once loaded into the world press the N key to open build mode.
  • In the bottom left-hand corner select vault. Search for shells, select it and hit Add To World.
  • Also within the vault, search for the RP Downtown Map, select it and hit Add To World.
  • Select the code icon that shows a tooltip stating Edit Scripts.
  • Once that's selected it will open Windows Explorer with the correct directory. Proceed to next step.

3. Add to Your Workspace​

Extract (if downloaded as a ZIP) or copy the repository folder into your HELIX server workspace. For example:

-- workspace will be a long combo of numbers and letters
/workspace
  /scripts   <-- put the repo inside this folder

4. Configure Your Server​

Open your HELIX server’s configuration file config.json. Make sure the QBCore packages are listed under your packages section so HELIX can load it at startup: This is already setup by default from the github repository.

{
  "packages": [
    "qb-core",
    etc..
  ]
}

5. Start Coding​

Once QBCore is in place, press the Save button inside build mode. At this point you are safe to leave and rejoin the world. All QBCore Lua APIs will now be available. You can immediately begin creating scripts, resources, and game modes using the QBCore framework.

6. Keep QBCore Updated​

Pull the latest changes periodically to stay up-to-date:

cd workspace/scripts
git pull

This ensures you have the newest fixes, features, and modules.

✨