QBCore Framework

https://docs.qbcore.org/qbcore-documentation
Admin
QBCore is a comprehensive framework and set of resources designed for FiveM servers, providing core...
Tokens:105,941
Snippets:587
Trust Score:6.9
Update:11 months ago
Show doc for...
Tokens:
Raw
### Run FiveM Server Artifacts using run.sh

Source: https://docs.qbcore.org/qbcore-documentation/guides/linux-installation

This command executes the FiveM server using the 'run.sh' script. It is the final step in starting the server after downloading and extracting the artifacts. Ensure you are in the correct directory containing the 'run.sh' file.

```bash
./run.sh
```

--------------------------------

### Install MariaDB Server (Linux)

Source: https://docs.qbcore.org/qbcore-documentation/guides/linux-installation

Installs the MariaDB server package on the Linux system. This command requires user interaction during the setup process. Dependencies: sudo privileges.

```shell
sudo apt-get install mariadb-server
```

--------------------------------

### Example Configuration File in Lua

Source: https://docs.qbcore.org/qbcore-documentation/guides/script-optimization

Provides an example of a 'config.lua' file structure for centralizing configurable values such as coordinates and payment amounts. This promotes easier script management and updates.

```lua
Config = {
    Zones = {
        PoliceStation = vector3(441.1, -981.1, 30.7),
        Hospital = vector3(1151.21, -1529.62, 34.84)
    },
    Payments = {
        Police = 150,
        EMS = 120
    }
}
```

--------------------------------

### QBCore Vehicle Properties Example

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/client-function-reference

Demonstrates how to retrieve and set vehicle properties using QBCore functions. This example first gets the current properties of the vehicle the player is using and then applies them back to the vehicle, which can be useful for refreshing or applying saved configurations.

```lua
-- Example

local vehicle = GetVehiclePedIsUsing(PlayerPedId())
local vehicleProps = QBCore.Functions.GetVehicleProperties(vehicle)
QBCore.Functions.SetVehicleProperties(vehicle, vehicleProps)
```

--------------------------------

### Restart MariaDB Service (Linux)

Source: https://docs.qbcore.org/qbcore-documentation/guides/linux-installation

After modifying the database configuration, restart the MariaDB service to apply the changes. This ensures that the server reloads its configuration and starts listening on the new bind address. Use 'systemctl status mariadb' to verify the service is running.

```bash
sudo systemctl restart mariadb
sudo systemctl status mariadb
```

--------------------------------

### Connect to MariaDB as Root (Linux)

Source: https://docs.qbcore.org/qbcore-documentation/guides/linux-installation

Connects to the MariaDB service as the root user. You will be prompted to enter the root password set during the secure installation. Dependencies: MariaDB installed, root password.

```shell
mysql -u root -p
```

--------------------------------

### Basic Server.cfg Template

Source: https://docs.qbcore.org/qbcore-documentation/guides/miscellaneous-guides

A minimal template for a server.cfg file, including essential directives for server endpoints, maximum clients, Steam API key, and server tags.

```systemd
#   ____  ____   _____               
#  / __ \|  _ \ / ____|              
# | |  | | |_) | |     ___  _ __ ___
# | |  | |  _ <| |    / _ \| '__/ _ \
# | |__| | |_) | |___| (_) | | |  __/
#  \___/\____/ \_____\___/|_|  \___|

## You CAN edit the following:
{{serverEndpoints}}
sv_maxclients {{maxClients}}
set steam_webApiKey "none"
sets tags "default, deployer, qbcore, qb-core"
```

--------------------------------

### Lua: Folder Structure Example

Source: https://docs.qbcore.org/qbcore-documentation/guides/script-optimization

Illustrates a recommended folder structure for organizing qb-core scripts into client, server, and shared modules. This promotes modularity and separation of concerns.

```plaintext
my_script/
├── client/
│   ├── main.lua
│   ├── utils.lua
├── server/
│   ├── main.lua
│   ├── events.lua
├── shared/
│   ├── config.lua
└── fxmanifest.lua
```

--------------------------------

### QBCore Resource Management and Permissions

Source: https://docs.qbcore.org/qbcore-documentation/guides/miscellaneous-guides

Manages the startup of essential QBCore resources and defines access control permissions for administrators and other roles. This section ensures necessary components are loaded and secured.

```cfg
# These resources will start by default.
ensure mapmanager
ensure chat
ensure spawnmanager
ensure sessionmanager
ensure basic-gamemode
ensure hardcap
ensure baseevents

# QBCore & Extra stuff
ensure qb-core
ensure [qb]
ensure [standalone]
ensure [voice]
ensure [defaultmaps]

## Permissions ##
add_ace group.admin command allow # allow all commands
#add_principal identifier.{{principalMasterIdentifier}} qbcore.god <- doesn't exist yet, change the generated one below to qbcore.god
{{addPrincipalsMaster}}

# Resources
add_ace resource.qb-core command allow # Allow qb-core to execute commands

# Gods
add_ace qbcore.god command allow # Allow all commands

# Inheritance
add_principal qbcore.god group.admin # Allow gods access to the main admin group used to get all default permissions
add_principal qbcore.god qbcore.admin # Allow gods access to admin commands
add_principal qbcore.admin qbcore.mod # Allow admins access to mod commands
```

--------------------------------

### Secure MariaDB Installation (Linux)

Source: https://docs.qbcore.org/qbcore-documentation/guides/linux-installation

Runs a script to secure the MariaDB installation by setting a root password, removing anonymous users, disallowing remote root login, and removing the test database. Follow on-screen prompts. Dependencies: sudo privileges, MariaDB installed.

```shell
sudo mysql_secure_installation
```

--------------------------------

### Update System Packages (Linux)

Source: https://docs.qbcore.org/qbcore-documentation/guides/linux-installation

Updates the package list for the system's repositories. This is a prerequisite for installing new software. It does not require any input parameters. Dependencies: sudo privileges.

```shell
sudo apt-get update
```

--------------------------------

### Extract FiveM Artifacts using tar

Source: https://docs.qbcore.org/qbcore-documentation/guides/linux-installation

This command extracts the contents of the downloaded 'fx.tar.xz' archive. After downloading the artifacts, this step unpacks the server files into the current directory, making them ready for execution.

```bash
tar -xf fx.tar.xz
```

--------------------------------

### Apartment Integration Configuration for qb-multicharacter

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-multicharacter

Configures the integration with starting apartments for the qb-multicharacter script. It allows enabling or disabling starting apartments and setting default spawn coordinates if apartments are disabled.

```lua
-- enable/disable starting apartments
Config.StartingApartment = true

-- Default spawn coords if you have the above false
Config.DefaultSpawn = vector3(-1035.71, -2731.87, 12.86)
```

--------------------------------

### QBCore Server Configuration Settings

Source: https://docs.qbcore.org/qbcore-documentation/guides/miscellaneous-guides

Defines core server settings for QBCore, including license keys, server identity, network configurations, and resource loading. These variables control the fundamental aspects of your FiveM server.

```cfg
sv_licenseKey "{{svLicense}}"
sv_hostname "{{serverName}} built with {{recipeName}} by {{recipeAuthor}}!"
sets sv_projectName "[{{recipeName}}] {{serverName}}"
sets sv_projectDesc "{{recipeDescription}}"
sets locale "en-US"
load_server_icon myLogo.png
set sv_enforceGameBuild 2372
set mysql_connection_string "{{dbConnectionString}}"
```

--------------------------------

### Open MySQL Port with iptables (Linux)

Source: https://docs.qbcore.org/qbcore-documentation/guides/linux-installation

Use iptables to open the default MySQL port (3306) to allow incoming TCP connections. This command adds a rule to the firewall's input chain, specifying that traffic destined for port 3306 should be accepted. Verify iptables installation with 'iptables --version'.

```bash
sudo iptables -A INPUT -p tcp --dport 3306 -j ACCEPT
```

--------------------------------

### Enable MySQL UI

Source: https://docs.qbcore.org/qbcore-documentation/guides/miscellaneous-guides

Convar to enable the in-game MySQL UI, allowing developers to query and view database data directly within the game client. Requires 'command' ace permission.

```cfg
set mysql_ui true
```

--------------------------------

### Database Connection String (oxmysql)

Source: https://docs.qbcore.org/qbcore-documentation/guides/miscellaneous-guides

Configuration line for setting up the MySQL database connection string, typically used in server.cfg. It specifies the user, password, host, database name, and character set.

```cfg
set mysql_connection_string "mysql://root:12345@localhost/qbcore?charset=utf8mb4"
```

--------------------------------

### Example Command to Set Player Status (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-policejob

Demonstrates how to register a server-side command ('setstatus') that allows administrators to trigger client-side events to apply specific status effects to players. It takes the status type and duration as arguments.

```lua
RegisterCommand('setstatus', function(source, args)
    local status = args[1] -- the status type to set
    local time = args[2] -- the status duration
    TriggerClientEvent('evidence:client:SetStatus', source, status, time)
end)
```

--------------------------------

### Get Player List (Native vs. QB Core)

Source: https://docs.qbcore.org/qbcore-documentation/guides/miscellaneous-guides

Demonstrates two methods for obtaining a list of active players on the server: using the native GetActivePlayers() and the QB Core specific QBCore.Functions.GetPlayers(). Both iterate through players to access their Peds.

```etlua
for _, player in ipairs(GetActivePlayers()) do
local ped = GetPlayerPed(player)
-- do stuff
end
```

```etlua
for _, player in pairs(QBCore.Functions.GetPlayers()) do
local ped = GetPlayerPed(player)
-- do stuff
end
```

--------------------------------

### Shop Configuration for Weapons Requiring License

Source: https://docs.qbcore.org/qbcore-documentation/guides/miscellaneous-guides

Defines a weapon item within a shop configuration, specifying its properties including whether a license is required for purchase. This example from `qb-shops/config.lua` demonstrates how to set `requiresLicense = true` for specific items.

```lua
[4] = {
    name = "weapon_pistol",
    price = 2500,
    amount = 5,
    info = {},
    type = "item",
    slot = 4,
    requiresLicense = true
}
```

--------------------------------

### Download FiveM Artifacts using wget

Source: https://docs.qbcore.org/qbcore-documentation/guides/linux-installation

This command downloads the FiveM server artifacts archive from a provided URL. Ensure the URL is correct and points to a valid artifact build. This is a crucial step for setting up the FiveM server on Linux.

```bash
wget https://runtime.fivem.net/artifacts/fivem/build_proot_linux/master/5742-ded89bc6acf29a720a7686a1de70d28b62c75af8/fx.tar.xz
```

--------------------------------

### Configure qb-crypto Settings (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-crypto

This configuration file sets up the parameters for the qb-crypto resource. It defines the price range for 'qbit', history tracking, starting worth, labels, exchange point coordinates, refresh timers, and probabilities for market crashes or luck. It also includes settings for an optional real-life crypto ticker integration, requiring an API key for fetching live prices.

```lua
Crypto = {
    Lower = 500, -- Lowest possible crypto worth
    Upper = 5000, -- Highest possible crypto worth
    History = { ["qbit"] = {}}, -- Stores crypto worth history for viewing
    Worth = {"qbit"] = 1000}, -- Starting crypto worth (can add more)
    Labels = {"qbit"] = "Qbit"}, -- Crypto type label (can add more)
    Exchange = { -- Exchange point for cryptosticks
        coords = vector3(1276.21, -1709.88, 54.57),
        RebootInfo = {
            state = false,
            percentage = 0
        },
    },
    -- For auto updating the value of qbit
    Coin = 'qbit',
    RefreshTimer = 10, -- In minutes, so every 10 minutes.
    -- Crashes or luck
    ChanceOfCrashOrLuck = 2, -- This is in % (1-100)
    Crash = {20,80}, -- Min / Max
    Luck = {20,45}, -- Min / Max
    -- If not not Chance of crash or luck
    ChanceOfDown = 30, -- If out of 100 hits less or equal to
    ChanceOfUp = 60, -- If out of 100 is greater or equal to
    CasualDown = {1,10}, -- Min / Max (If it goes down)
    CasualUp = {1,10}, -- Min / Max (If it goes up)
}

Ticker = {
    Enabled = false, -- Enable/disable real life crypto prices
    coin = 'BTC', --- The coin, please make sure you find the actual name, for example: Bitcoin vs BTC, BTC would be correct
    currency = 'USD', -- For example USD, NOK, SEK, EUR, CAD and more here https://www.countries-ofthe-world.com/world-currencies.html
    tick_time = 2, --- Minutes (Minimum is 2 minutes) 20,160 Requests a month, Its recommended to get the free API key so the crypto script doesnt switch on and off if ratelimit is encountered
    Api_key = 'put_api_key_here', -- If you decide to get an api key for the API (https://min-api.cryptocompare.com/pricing) The free plan should be more than enough for 1 Fivem server
    --- Error handle stuff, for more user friendly and readable errors, Don't touch.
    Error_handle = {
        ['fsym is a required param.'] = 'Config error: Invalid / Missing coin name',
        ['tsyms is a required param.'] = 'Config error: Invalid / Missing currency',
        ['cccagg_or_exchange'] = 'Config error: Invalid currency / coin combination', -- For some reason api throws this error if either coin or currency is invalid
    },
}
```

--------------------------------

### Lua: Commenting and Organizing Code

Source: https://docs.qbcore.org/qbcore-documentation/guides/script-optimization

Demonstrates best practices for commenting and structuring Lua scripts for better readability and maintainability. Includes examples of variable declaration, function definitions, event handling, and main logic separation.

```lua
-- Check if the player is in range of the target zone
if #(playerCoords - targetCoords) < 10 then
    print('Player is in range')
end
```

```lua
-- Variables
local QBCore = exports['qb-core']:GetCoreObject()

-- Functions
local function calculateDistance(pos1, pos2)
    return #(pos1 - pos2)
end

-- Events
RegisterNetEvent('exampleEvent', function()
    print('Event triggered!')
end)

-- Main Logic
CreateThread(function()
    print('Script started!')
end)
```

--------------------------------

### Create Admin User and Grant Privileges (MariaDB)

Source: https://docs.qbcore.org/qbcore-documentation/guides/linux-installation

Creates a new user with a specified username and password, grants all privileges on all databases to this user, and reloads privileges. Replace 'user1' and 'password1' with desired credentials. For remote access, replace 'localhost' with '%'. Dependencies: Access to MariaDB console (e.g., via 'mysql -u root -p').

```sql
CREATE USER 'user1'@'localhost' IDENTIFIED BY 'password1';
SELECT User FROM mysql.user;
GRANT ALL PRIVILEGES ON *.* TO 'user1'@'localhost' IDENTIFIED BY 'password1';
FLUSH PRIVILEGES;
```

--------------------------------

### Bypass MariaDB Login (Linux)

Source: https://docs.qbcore.org/qbcore-documentation/guides/linux-installation

Connects to MariaDB as root without a password prompt, useful if the root password is forgotten. Requires sudo privileges. Dependencies: sudo privileges, MariaDB installed.

```shell
sudo mysql -u root
```

--------------------------------

### Define Starter Items with Lua Table

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/shared

Defines the initial items a player receives upon joining the server. This is stored as a Lua table where keys are item names (strings) and values are their amounts (numbers).

```lua
QBShared.StarterItems = {
    phone = 1,
    id_card = 1,
    driver_license = 1,
}
```

--------------------------------

### Get Players From Coords - QBCore Lua

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/client-function-reference

Retrieves a list of all player IDs within a specified radius of given coordinates. It uses QBCore.Functions.GetPlayers to get all active players. The default distance is 5 units if not specified.

```lua
function QBCore.Functions.GetPlayersFromCoords(coords, distance)
    local players = QBCore.Functions.GetPlayers()
    local ped = PlayerPedId()
    if coords then
        coords = type(coords) == 'table' and vec3(coords.x, coords.y, coords.z) or coords
    else
        coords = GetEntityCoords(ped)
    end
    local distance = distance or 5
    local closePlayers = {}
    for _, player in pairs(players) do
        local target = GetPlayerPed(player)
        local targetCoords = GetEntityCoords(target)
        local targetdistance = #(targetCoords - coords)
        if targetdistance <= distance then
            closePlayers[#closePlayers + 1] = player
        end
    end
    return closePlayers
end

-- Example

local coords = GetEntityCoords(PlayerPedId())
local radius = 5.0
local closestPlayers = QBCore.Functions.GetPlayersFromCoords(coords, radius)
print(QBCore.Debug(closestPlayers))
```

--------------------------------

### Define Weapon Attachments

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-weapons

Configuration for weapon attachments, specifying the components and corresponding items for various weapons, starting with the pistol.

```lua
WeaponAttachments = {
    -- PISTOLS
    ['WEAPON_PISTOL'] = { --items this weapon accepts as a attachment
        ['defaultclip'] = {
            component = 'COMPONENT_PISTOL_CLIP_01', -- Attachment hash
            item = 'pistol_defaultclip', --Item in the items.lua
            type = 'clip', --type of attachment
        },
        ['extendedclip'] = {
            component = 'COMPONENT_PISTOL_CLIP_02',
            item = 'pistol_extendedclip',
            type = 'clip',
        },
        ['flashlight'] = {
            component = 'COMPONENT_AT_PI_FLSH',
            item = 'pistol_flashlight',
        },
        ['suppressor'] = {
            component = 'COMPONENT_AT_PI_SUPP_02',
            item = 'pistol_suppressor',
        },
        ['luxuryfinish'] = {
            component = 'COMPONENT_PISTOL_VARMOD_LUXE',
            item = 'pistol_luxuryfinish',
        },
    },
}
```

--------------------------------

### qb-houses Generic Configuration (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-houses

Defines general settings for the qb-houses resource. Includes parameters for minimum Z offset for spawning, the number of 'stormram' items required for raiding, and options for displaying unowned house blips on the map. The 'Houses', 'Targets', and 'Furniture' tables are populated automatically.

```lua
Config = {}
Config.MinZOffset = 30 -- how far under the ground shells will spawn
Config.RamsNeeded = 2 -- how many stormram items are needed to raid a house
Config.UnownedBlips = false -- enable/disable unowned house blips on the map
Config.Houses = {} -- populates automatically on server start
Config.Targets = {} -- populates automatically on server start
Config.Furniture = {} -- pre-filled with tons of options
```

--------------------------------

### GET /plateinfo [plate]

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/commands

Retrieves information about a license plate, including whether it is flagged and the reason for flagging. Requires the 'plate' parameter.

```APIDOC
## GET /plateinfo [plate]

### Description
Shows whether a plate is flagged and gives the reason if so.

### Method
GET

### Endpoint
/plateinfo/{plate}

### Parameters
#### Path Parameters
- **plate** (string) - Required - The license plate to check.

### Response
#### Success Response (200)
- **is_flagged** (boolean) - True if the plate is flagged, false otherwise.
- **reason** (string) - The reason the plate is flagged (if applicable).

#### Response Example
```json
{
  "is_flagged": true,
  "reason": "Speeding ticket violation"
}
```
```

--------------------------------

### Product Configuration for qb-drugs Dealers

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-drugs

Defines the products available for purchase from dealers, specifying item names, prices, stock amounts, and requirements like minimum reputation.

```lua
Config.Products = { -- products availabe to buy from a dealer
    [1] = {
        name = "weed_white-widow", -- item name
        price = 15, -- how much it costs
        amount = 150, -- amount available in stock
        info = {}, -- item info (none)
        type = "item", -- item type
        slot = 1, -- inventory slot item will show in
        minrep = 0, -- how much rep needed to buy this item
    },
}
```

--------------------------------

### Configure qb-weathersync General Settings (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-weathersync

This snippet shows the general configuration options for qb-weathersync. It allows toggling dynamic weather, setting initial weather conditions, time, and blackout states. Dependencies include the core qb-core framework.

```lua
Config                  = {}
Config.DynamicWeather   = true -- set this to false if you don't want the weather to change automatically every 10 minutes.

-- On server start
Config.StartWeather     = 'EXTRASUNNY' -- default weather
Config.BaseTime         = 8 -- time     
Config.TimeOffset       = 0 -- time offset 
Config.FreezeTime       = false -- freeze time 
Config.Blackout         = false -- set blackout                                 
Config.BlackoutVehicle  = false -- set blackout affects vehicles                
Config.NewWeatherTimer  = 10 -- time (in minutes) between each weather change   
Config.Disabled         = false -- set weather disabled                         
```

--------------------------------

### Get Duty Count by Job (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/server-function-reference

Returns the number of players currently on duty for a given job. Returns a number.

```lua
local amount = QBCore.Functions.GetDutyCount('police')
print('Currently '..amount..' police online')
```

--------------------------------

### Configure General Pawnshop Settings

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-pawnshop

This snippet configures general settings for the pawnshop, including its interaction location, payment method (bank or cash), operating hours, and email notifications for melting.

```lua
Config = {}
Config.PawnLocation = vector3(412.34, 314.81, 103.13) -- interaction point
Config.BankMoney = false -- pay player in bank or set to false for cash
Config.UseTimes = false -- Set to false if you want the pawnshop open 24/7
Config.TimeOpen = 7 -- Opening Time
Config.TimeClosed = 17 -- Closing Time
Config.SendMeltingEmail = true -- enable/disable email when melting finished
```

--------------------------------

### Get Player Name

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/player-data

Retrieves the player's full character name. This is a simple getter function that returns a string.

```lua
local Player = QBCore.Functions.GetPlayer(source)
if not Player then return end
Player.Functions.GetName()
```

--------------------------------

### Create a Shop with Lua

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-inventory

Registers one or multiple shops by storing their data, including name, label, coordinates, item slots, and available items, into the global shop registry. It takes a shopData table as input.

```lua
local items = {
    { name = 'sandwich', amount = 10, price = 5 }
}

RegisterCommand('createShop', function(source)
    local playerPed = GetPlayerPed(source)
    local playerCoords = GetEntityCoords(playerPed)
    exports['qb-inventory']:CreateShop({
        name = 'testShop',
        label = 'Test Shop',
        coords = playerCoords, -- optional
        slots = #items,
        items = items
    })
end, true)

```

--------------------------------

### Get Account Balance (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-banking

Retrieves only the balance of a specified account by its name. It takes the account name as input and returns the balance as a number.

```lua
exports['qb-banking']:GetAccountBalance(accountName)
```

```lua
RegisterCommand('getBalance', function()
    local accountName = 'police'
    local balance = exports['qb-banking']:GetAccountBalance(accountName)
    print('Account: '..accountName..' Balance: '..balance)
end, true)
```

--------------------------------

### GET /ankletlocation [cid]

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/commands

Shows the location of a player using their citizen ID. Can only be used by players with the 'police' job. Requires the 'cid' parameter.

```APIDOC
## GET /ankletlocation [cid]

### Description
Shows the location of the player with the given `cid`. Can only be used by players with the job of 'police'.

### Method
GET

### Endpoint
/ankletlocation/{cid}

### Parameters
#### Path Parameters
- **cid** (number) - Required - The citizen ID of the player to check.

### Response
#### Success Response (200)
- **location** (object) - Contains the coordinates of the player.
  - **x** (number) - The x-coordinate.
  - **y** (number) - The y-coordinate.
  - **z** (number) - The z-coordinate.

#### Response Example
```json
{
  "location": {
    "x": 100.5,
    "y": -200.0,
    "z": 50.2
  }
}
```
```

--------------------------------

### Configure General Settings for qb-hotdogjob

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-hotdogjob

Sets up general configuration parameters for the hot dog job, including the cost to rent a cart, the player's current level, and the maximum reputation required. These values are fundamental for job progression and economy.

```lua
Config = {}
Config.StandDeposit = 250 -- how much it costs to rent a cart
Config.MyLevel = 1
Config.MaxReputation = 200
```

--------------------------------

### Configure Apartments in Lua

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-apartments

This Lua code snippet defines the configuration table for the qb-apartments resource. It allows enabling/disabling starting apartments, setting spawn offsets, and defining apartment locations with coordinates and polyzone data. Adjust these settings to customize the apartment system.

```lua
Apartments = {}
Apartments.Starting = true/false -- Enable or disable starting apartments 
Apartments.SpawnOffset = 30 -- How far under the map the apartment shell will spawn
Apartments.Locations = { -- Create new apartment locations
    ["apartment1"] = {
        name = "apartment1", -- The apartment name that saves in the database
        label = "South Rockford Drive", -- The label of the apartment (shown in preview)
        coords = { -- The apartment entrance location 
            enter = vector4(-667.02, -1105.24, 14.63, 242.32),
        },
        polyzoneBoxData = { -- The polyzone box information for the entrance
            heading = 245,
            minZ = 13.5,
            maxZ = 16.0,
            debug = false,
            length = 1,
            width = 3,
            distance = 2.0,
            created = false
        }
    },
}
```

--------------------------------

### Get Entity Coordinates (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/server-function-reference

Fetches the world coordinates (vector4) of a given entity using its handle. Useful for position-based logic.

```lua
local ped = GetPlayerPed(source)
local coords = QBCore.Functions.GetCoords(ped)
print(coords)
```

--------------------------------

### Database Debugging Convars

Source: https://docs.qbcore.org/qbcore-documentation/guides/miscellaneous-guides

Optional convars to enable slow query warnings and general debugging for the MySQL connection, useful during development and troubleshooting.

```cfg
set mysql_slow_query_warning 150
set mysql_debug true
```

--------------------------------

### qb-vehicleshop Configuration

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-vehicleshop

This snippet shows the general configuration options for the qb-vehicleshop script. It includes settings for sales commissions, finance zone location, payment warning intervals, minimum down payment percentages, and maximum payment plans.

```lua
Config.Commission = 0.10 -- Percent that goes to sales person from a full car sale 10%
Config.FinanceCommission = 0.05 -- Percent that goes to sales person from a finance sale 5%
Config.FinanceZone = vector3(-29.53, -1103.67, 26.42) -- Where the finance menu is located
Config.PaymentWarning = 10 -- time in minutes that player has to make payment before repo
Config.PaymentInterval = 24 -- time in hours between payment being due
Config.MinimumDown = 10 -- minimum percentage allowed down
Config.MaximumPayments = 24 -- maximum payments allowed
```

--------------------------------

### Get Closest Object (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/server-function-reference

Finds the closest world object to a player or a specific coordinate, returning its handle and the distance. Handles are numbers.

```lua
local ped = GetPlayerPed(source)
local location = GetEntityCoords(ped)
local objectHandle, distance = QBCore.Functions.GetClosestObject(source, location)
print('Closest Object:', objectHandle, 'Distance:', distance)
```

--------------------------------

### Configure General Jewelry Robbery Settings (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-jewelry

Sets up general configuration for the jewelry store robbery, including cooldown timers, required police presence, and the main location for the robbery.

```lua
Config = {}
Config.Timeout = 30 * (60 * 2000) -- cooldown between robberies in minutes
Config.RequiredCops = 2 -- Amount of police needed online to start the robbery
Config.JewelleryLocation = { -- location to start robbery
    ["coords"] = vector3(-630.5, -237.13, 38.08),
}
```

--------------------------------

### Get Player Metadata

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/player-data

Retrieves the value of a player's metadata by its name. This function returns the metadata value, which can be a string, table, or number.

```lua
local Player = QBCore.Functions.GetPlayer(source)
if not Player then return end
Player.Functions.GetMetaData('hunger')
```

--------------------------------

### Get Player Data on Client

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/player-data

Demonstrates how to retrieve a player's data on the client-side using the qb-core export. This function does not require any arguments.

```lua
local playerData = exports['qb-core']:GetPlayerData()
```

--------------------------------

### Get Blackout State (JavaScript)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-weathersync

This JavaScript export retrieves the current status of the blackout mode. It returns a boolean value: `true` if blackout is enabled, `false` otherwise.

```javascript
const state = global.exports["qb-weathersync"].getBlackoutState();
```

--------------------------------

### Get Blackout State (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-weathersync

This Lua export retrieves the current status of the blackout mode. It returns a boolean value: `true` if blackout is enabled, `false` otherwise.

```lua
local state = exports["qb-weathersync"]:getBlackoutState();
```

--------------------------------

### Set up Discord Rich Presence in qbcore

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-smallresources

Configures Discord Rich Presence for a FiveM server. This Lua script sets the application ID, large and small icons with hover text, and up to two action buttons. It includes a callback to display the current player count.

```lua
CreateThread(function()
    while true do
        -- This is the Application ID (Replace this with you own)
	SetDiscordAppId()

        -- Here you will have to put the image name for the "large" icon.
	SetDiscordRichPresenceAsset('logo_name')
        
        -- (11-11-2018) New Natives:

        -- Here you can add hover text for the "large" icon.
        SetDiscordRichPresenceAssetText('This is a lage icon with text')
       
        -- Here you will have to put the image name for the "small" icon.
        SetDiscordRichPresenceAssetSmall('logo_name')

        -- Here you can add hover text for the "small" icon.
        SetDiscordRichPresenceAssetSmallText('This is a lsmall icon with text')

        QBCore.Functions.TriggerCallback('smallresources:server:GetCurrentPlayers', function(result)
            SetRichPresence('Players: '..result..'/'..64)
        end)

        -- (26-02-2021) New Native:

        --[[ 
            Here you can add buttons that will display in your Discord Status,
            First paramater is the button index (0 or 1), second is the title and 
            last is the url (this has to start with "fivem://connect/" or "https://") 
        ]]--
        SetDiscordRichPresenceAction(0, "First Button!", "fivem://connect/localhost:30120")
        SetDiscordRichPresenceAction(1, "Second Button!", "fivem://connect/localhost:30120")

        -- It updates every minute just in case.
	Wait(60000)
    end
end)
```

--------------------------------

### Configure qb-recyclejob Settings (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-recyclejob

This configuration file sets up various parameters for the qb-recyclejob script. It includes defining spawn locations, duty and drop-off points, blip settings, action durations, and item tables for rewards. It also specifies pickup locations and warehouse objects.

```lua
Config = {
	-- warehouse entrance / spawn location on warehouse exit
	OutsideLocation 	= vector4(55.55, 6472.18, 31.43, 44.0),
	-- warehouse exit / spawn location on warehouse enter
	InsideLocation 		= vector4(1073.0, -3102.49, -39.0, 266.61),
	-- clock in/out
	DutyLocation 		= vector4(1048.7, -3100.62, -38.2, 88.02),
	-- package delivery location
	DropLocation 		= vector4(1048.224, -3097.071, -38.999, 274.810),
	-- enable/disable floating marker
	DrawPackageLocationBlip = true,
	-- progress bar times
	PickupActionDuration 	= math.random(4000, 6000),
	DeliveryActionDuration 	= 5000,

	MaxItemsReceived 	= 5, -- maximum random reward items amount
	MinItemReceivedQty 	= 2, -- minimum reward item amount
	MaxItemReceivedQty 	= 6, -- maximum reward item amount
	ChanceItem 		= "cryptostick", -- random chance reward item
	LuckyItem 		= "rubber", -- random chance reward item

	PickupLocations = { -- interaction locations to pickup recyclables
		[1] 	= vector4(1067.68, -3095.57, -39.9, 342.39),
		[2] 	= vector4(1065.20, -3095.57, -39.9, 342.39),
		[3] 	= vector4(1062.73, -3095.57, -39.9, 342.39),
		[4] 	= vector4(1060.37, -3095.57, -39.9, 342.39),
		[5] 	= vector4(1057.95, -3095.57, -39.9, 342.39),
		[6] 	= vector4(1055.58, -3095.57, -39.9, 342.39),
		[7] 	= vector4(1053.09, -3095.57, -39.9, 342.39),

		[8] 	= vector4(1053.07, -3102.62, -39.9, 342.39),
		[9] 	= vector4(1055.49, -3102.62, -39.9, 342.39),
		[10]	= vector4(1057.93, -3102.62, -39.9, 342.39),
		[11]	= vector4(1060.19, -3102.62, -39.9, 342.39),
		[12]	= vector4(1062.71, -3102.62, -39.9, 342.39),
		[13]	= vector4(1065.19, -3102.62, -39.9, 342.39),
		[14]	= vector4(1067.46, -3102.62, -39.9, 342.39),

		[15]	= vector4(1067.69, -3109.71, -39.9, 342.39),
		[16]	= vector4(1065.13, -3109.71, -39.9, 342.39),
		[17]	= vector4(1062.70, -3109.71, -39.9, 342.39),
		[18]	= vector4(1060.24, -3109.71, -39.9, 342.39),
		[19]	= vector4(1057.76, -3109.71, -39.9, 342.39),
		[20]	= vector4(1055.52, -3109.71, -39.9, 342.39),
		[21]	= vector4(1053.16, -3109.71, -39.9, 342.39),
	},
	WarehouseObjects = { -- interactable objects in the warehouse
		[1] = "prop_boxpile_05a",
		[2] = "prop_boxpile_04a",
		[3] = "prop_boxpile_06b",
		[4] = "prop_boxpile_02c",
		[5] = "prop_boxpile_02b",
		[6] = "prop_boxpile_01a",
		[7] = "prop_boxpile_08a",
	},
	PickupBoxModel = "prop_cs_cardbox_01", -- object show in players hands
	ItemTable = { -- reward items
		[1] = "metalscrap",
		[2] = "plastic",
		[3] = "copper",
		[4] = "iron",
		[5] = "aluminum",
		[6] = "steel",
		[7] = "glass",
	}
}
```

--------------------------------

### Get Players in Bucket (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/server-function-reference

Returns a list of player IDs assigned to a specific routing bucket. Returns false if the bucket is invalid or empty.

```lua
local players = QBCore.Functions.GetPlayersInBucket(3)
if players then
    print("Players in bucket 3:", json.encode(players))
end
```

--------------------------------

### Get Routing Bucket Objects (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/server-function-reference

Retrieves the internal state tables for player and entity routing buckets. Useful for inspecting bucket assignments.

```lua
local playerBuckets, entityBuckets = QBCore.Functions.GetBucketObjects()
QBCore.Debug(playerBuckets)
QBCore.Debug(entityBuckets)
```

--------------------------------

### Configure qb-busjob Settings (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-busjob

This snippet shows the basic configuration structure for the qb-busjob resource. It includes settings for allowed bus vehicles, the location of the bus depot, bus stop coordinates, and NPC skins for passengers. Ensure these values are correctly set for the resource to function as intended.

```lua
Config = {}
Config.AllowedVehicles = {} -- Define the bus model to use
Config.Location = vector4() -- Set the blip and vehicle withdraw location
Config.NPCLocations = {} -- The bus stop locations
Config.NpcSkins = {} -- List of ped models randomly chosen to spawn
```

--------------------------------

### Get Player Object on Server

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/player-data

Illustrates how to obtain the player object on the server-side using the qb-core export, passing the player's source ID.

```lua
local playerObject = exports['qb-core']:GetPlayer(source)
```

--------------------------------

### Show Input Form and Get User Data (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-input

Displays an interactive input form to the user and returns the submitted data. It accepts a table of configurations for the form, including input fields, headers, and submission text. The function returns a table containing the user's input or nil if the form is canceled.

```lua
RegisterCommand('testinput', function()
    local dialog = exports['qb-input']:ShowInput({
        header = "Test",
        submitText = "Bill",
        inputs = {
            {
                text = "Citizen ID (#)",
                name = "citizenid",
                type = "text",
                isRequired = true,
                default = "CID-1234",
            },
            {
                text = "Secret Code (Give to Nobody)",
                name = "code",
                type = "password",
                isRequired = true,
                default = "password123",
            },
            {
                text = "Bill Price ($)",
                name = "billprice",
                type = "number",
                isRequired = false,
                default = 1,
            },
            {
                text = "Bill Type",
                name = "billtype",
                type = "radio",
                options = {
                    { value = "bill", text = "Bill" },
                    { value = "cash", text = "Cash" },
                    { value = "bank", text = "Bank" }
                },
                default = "cash",
            },
            {
                text = "Include Tax?",
                name = "taxincl",
                type = "checkbox",
                options = {
                    { value = "gst", text = "10% incl."},
                    { value = "business", text = "35% incl.", checked = true },
                    { value = "othertax", text = "15% incl."}
                }
            },
            {
                text = "Some Select",
                name = "someselect",
                type = "select",
                options = {
                    { value = "none", text = "None" },
                    { value = "other", text = "Other"},
                    { value = "other2", text = "Other2" },
                    { value = "other3", text = "Other3" },
                    { value = "other4", text = "Other4" },
                    { value = "other5", text = "Other5" },
                    { value = "other6", text = "Other6" },
                },
                default = "other3",
            },
            {
                text = "Favorite Color",
                name = "favoritecolor",
                type = "color",
                default = "#ff0000",
            }
        }
    })

    if dialog ~= nil then
        for k,v in pairs(dialog) do
            print(k .. " : " .. v)
        end
    end
end, false)
```

--------------------------------

### Get Closest Object (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/client-function-reference

Finds the closest object to a given coordinate or the player's current location. Returns the closest object entity and the distance to it.

```lua
function QBCore.Functions.GetClosestObject(coords)
    local ped = PlayerPedId()
    local objects = GetGamePool('CObject')
    local closestDistance = -1
    local closestObject = -1
    if coords then
        coords = type(coords) == 'table' and vec3(coords.x, coords.y, coords.z) or coords
    else
        coords = GetEntityCoords(ped)
    end
    for i = 1, #objects, 1 do
        local objectCoords = GetEntityCoords(objects[i])
        local distance = #(objectCoords - coords)
        if closestDistance == -1 or closestDistance > distance then
            closestObject = objects[i]
            closestDistance = distance
        end
    end
    return closestObject, closestDistance
end

-- Example

local coords = GetEntityCoords(PlayerPedId())
local closestObject, distance = QBCore.Functions.GetClosestObject(coords)
print(closestObject, distance)
```

--------------------------------

### Configure General Settings for qb-smallresources

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-smallresources

This snippet shows how to configure general settings for the qb-smallresources script, including maximum dimensions, damage thresholds, idle camera, prone mode, effect times, and vehicle/ped spawn removals.

```lua
Config.MaxWidth = 5.0
Config.MaxHeight = 5.0
Config.MaxLength = 5.0
Config.DamageNeeded = 100.0
Config.IdleCamera = true -- enable/disable idle camrea
Config.EnableProne = true -- enable/disable prone
Config.JointEffectTime = 60 -- how long does getting high affect the player?
Config.RemoveWeaponDrops = true -- enable/disable native weapon drops
Config.RemoveWeaponDropsTimer = 25
Config.DefaultPrice = 20 -- carwash
Config.DirtLevel = 0.1 -- carwash dirt level

Config.Teleports = {
    --Elevator @ labs
    [1] = {
        [1] = { --First location of the Teleport
            coords = vector4(3540.74, 3675.59, 20.99, 167.5),
            ["AllowVehicle"] = false, -- enable/disable vehicle
            drawText = '[E] Take Elevator Up'
        },
        [2] = {
            coords = vector4(3540.74, 3675.59, 28.11, 172.5),
            ["AllowVehicle"] = false,
            drawText = '[E] Take Elevator Down'
        },

    },
    [2] = {
        [1] = {
            coords = vector4(909.49, -1589.22, 30.51, 92.24),
            ["AllowVehicle"] = false,
            drawText = '[E] Enter Coke Processing'
        },
        [2] = {
            coords = vector4(1088.81, -3187.57, -38.99, 181.7),
            ["AllowVehicle"] = false,
            drawText = '[E] Leave'
        },
    },
}

Config.CarWash = { -- carwash
    [1] = {
        ["label"] = "Hands Free Carwash",
        ["coords"] = vector3(25.29, -1391.96, 29.33),
    },
    [2] = {
        ["label"] = "Hands Free Carwash",
        ["coords"] = vector3(174.18, -1736.66, 29.35),
    }
}
```

--------------------------------

### Configure General House Robbery Settings (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qbcore-resources/qb-houserobbery

Sets up general configuration parameters for house robberies, including Z-offset for spawned shells, minimum police presence required, and allowed in-game time ranges for robberies.

```lua
Config = {}
Config.MinZOffset = 45 -- how far under the ground the shell will spawn
Config.MinimumHouseRobberyPolice = 2 -- minimum amount of police needed to rob
Config.MinimumTime = 5 -- minimum in-game hour to rob
Config.MaximumTime = 22 -- maximum in-game hour to rob
```

--------------------------------

### Get Closest Vehicle (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/client-function-reference

Finds the closest vehicle to a given coordinate or the player's current location. Returns the closest vehicle entity and the distance to it.

```lua
function QBCore.Functions.GetClosestVehicle(coords)
    local ped = PlayerPedId()
    local vehicles = GetGamePool('CVehicle')
    local closestDistance = -1
    local closestVehicle = -1
    if coords then
        coords = type(coords) == 'table' and vec3(coords.x, coords.y, coords.z) or coords
    else
        coords = GetEntityCoords(ped)
    end
    for i = 1, #vehicles, 1 do
        local vehicleCoords = GetEntityCoords(vehicles[i])
        local distance = #(vehicleCoords - coords)

        if closestDistance == -1 or closestDistance > distance then
            closestVehicle = vehicles[i]
            closestDistance = distance
        end
    end
    return closestVehicle, closestDistance
end

-- Example

local coords = GetEntityCoords(PlayerPedId())
local closestVehicle, distance = QBCore.Functions.GetClosestVehicle(coords)
print(closestVehicle, distance)
```

--------------------------------

### Get Coordinates with Heading (Lua)

Source: https://docs.qbcore.org/qbcore-documentation/qb-core/client-function-reference

Fetches the entity's coordinates along with its heading. This function is an enhanced version of the native GetEntityCoords, providing more positional information.

```lua
function QBCore.Functions.GetCoords(entity)
    return vector4(GetEntityCoords(entity), GetEntityHeading(entity))
end

-- Example

local coords = QBCore.Functions.GetCoords(PlayerPedId())
print(coords)
```
Tokens:
Raw