LogoLogo
  • 👋Introduction
  • Project Sponsors
    • ✍️JetBrains
    • 📚GitBook
    • 🗃️Pleb Masters: Forge
    • 🎥KakarotDevs
  • Guides
    • 🪟Windows Installation
    • 🐧Linux Installation
    • 🔓Setting Permissions
    • 🚀Script Optimization
    • 📑Miscellaneous Guides
    • 📝Visual Studio Code
    • 🔗Useful Links
  • QB-Core
    • Core Object
    • 📊Player Data
    • 📜Shared
    • ↗️Shared Exports
    • 💬DrawText
    • 🎮Client Event Reference
    • 🎮Client Function Reference
    • 🖥️Server Event Reference
    • 🖥️Server Function Reference
    • ❗Commands
  • QBCore Resources
    • 🔧qb-adminmenu
    • 🚑qb-ambulancejob
    • 🏨qb-apartments
    • 🏦qb-banking
    • 💰qb-bankrobbery
    • 🚌qb-busjob
    • 🏢qb-cityhall
    • 👕qb-clothing
    • 🔄qb-commandbinding
    • 🪙qb-crypto
    • 🤿qb-diving
    • 🚪qb-doorlock
    • 💊qb-drugs
    • 🕺qb-emotes
    • ⌚qb-fitbit
    • ⛽qb-fuel
    • 🚘qb-garages
    • 🚛qb-garbagejob
    • 🌭qb-hotdogjob
    • 🔫qb-houserobbery
    • 🏡qb-houses
    • ℹ️qb-hud
    • 📝qb-input
    • 🏠qb-interior
    • 🎒qb-inventory
    • 💎qb-jewelry
    • ⌨️qb-keyminigame
    • 🏁qb-lapraces
    • 🔃qb-loading
    • 🪛qb-lockpick
    • 👔qb-management
    • 🧑‍🔧qb-mechanicjob
    • ↖️qb-menu
    • 🙋qb-multicharacter
    • 📰qb-newsjob
    • 🤑qb-pawnshop
    • 📱qb-phone
    • 👮qb-policejob
    • 🖨️qb-printer
    • 🔐qb-prison
    • 🔄qb-radialmenu
    • 📻qb-radio
    • ♻️qb-recyclejob
    • 📋qb-scoreboard
    • 🔋qb-scrapyard
    • 🏪qb-shops
    • 🤹qb-skillbar
    • 📚qb-smallresources
    • 🗺️qb-spawn
    • 🔫qb-storerobbery
    • 🏎️qb-streetraces
    • 🚕qb-taxijob
    • 🛻qb-towjob
    • 👁️qb-target
    • 🚛qb-truckerjob
    • 🔫qb-truckrobbery
    • 💻qb-tunerchip
    • 🔨qb-vehiclefailure
    • 🔑qb-vehiclekeys
    • 📄qb-vehiclesales
    • 🚗qb-vehicleshop
    • 🍇qb-vineyard
    • 🔫qb-weapons
    • 🌤️qb-weathersync
    • 🌿qb-weed
Powered by GitBook
On this page
  • Database Configuration
  • MariaDB
  • HeidiSQL
  • Artifact and txAdmin
Edit on GitHub
  1. Guides

Windows Installation

Installing a QBCore server step by step.

PreviousKakarotDevsNextLinux Installation

Last updated 3 months ago

Database Configuration

Install and

MariaDB

HeidiSQL

  • Open HeidiSQL, click the green circle with the plus sign and name it something

The names don't matter, you can name them whatever you want!

Press new to create a session

Artifact and txAdmin

Double click on FXServer.exe to run it. Once loaded, it should open a web browser page

After you link your FiveM account, which it should do automatically, make a password. Then you will be greeted with steps

When you get to step number 3, click "Popular Template" then "QBCore Framework"

Select a folder you would like to store your server data in.

Scroll to the bottom and run the recipe deployer

Keymaster keys only require the IP address the first time it launches after that the generated key can be used on any IP.

Paste your Keymaster key where prompted.

Then click "Run Recipe"

Let yarn install all the way through on the initial startup.

Once this is complete, we recommend visiting Setting Permissions to configure your server.cfg with any players you'd like to give elevated permissions!

Rename this to whatever you'd like and press open

Make a new folder on your desktop and name it whatever you want, download the latest recommended FiveM , then extract them to the folder you made

The webpage for downloading an artifact version
txAdmin is already bundled in with the FiveM artifacts so running the server starter will launch it
txAdmin starting page after logging in
Choosing a deployment type
Selecting QBCore from the templates
It is suggested to use the path txAdmin suggests
Click on next

Go to and generate a key. Fill out that information correctly.

Entering your CFX key
After you let the recipe install you will be greeted with a screen like this.

If you did not get the above message and got an error message, please use the official and post in

🪟
artifacts
keymaster
QBCore Discord
fivem-support
MariaDB
HeidiSQL