Documentation Index
Fetch the complete documentation index at: https://docs.sixm.gg/llms.txt
Use this file to discover all available pages before exploring further.
Prerequisites
Make sure you have a working QBCore server with these resources:
qb-core
oxmysql
ox_lib (required by most scripts)
Installation Steps
Upload the Script
Place the script folder in your resources directory:resources/[sixm]/sixm_scriptname/
Import SQL
If the script includes a .sql file, import it into your database:-- Import via HeidiSQL, phpMyAdmin, or CLI
source /path/to/install.sql
Configure Framework
In the script’s config.lua, set the framework (or leave as auto):Config.Framework = 'qbcore' -- or 'auto' for auto-detection
Add Items (if applicable)
Some scripts require adding items to your shared items. Check the script’s README.md for item definitions:-- In qb-core/shared/items.lua (or ox_inventory items)
['sixm_item'] = {
name = 'sixm_item',
label = 'Item Name',
weight = 100,
type = 'item',
image = 'sixm_item.png',
unique = false,
useable = true,
shouldClose = true,
description = 'An item from SixM script'
},
Add to server.cfg
Place it after qb-core, oxmysql, and ox_lib. Restart
Restart your server or use ensure sixm_scriptname in txAdmin.
QBCore-Specific Configuration
Jobs
If the script uses jobs, make sure they exist in your qb-core/shared/jobs.lua:
['sixm_job'] = {
label = 'Job Name',
defaultDuty = true,
offDutyPay = false,
grades = {
['0'] = { name = 'Recruit', payment = 50 },
['1'] = { name = 'Worker', payment = 100 },
['2'] = { name = 'Manager', payment = 150 },
['3'] = { name = 'Boss', payment = 200, isboss = true },
},
},
Permissions
QBCore uses the job/gang grade system for permissions. Configure which grades can access features in the script’s config:
Config.MinGrade = 2 -- Minimum job grade to access admin features