Skip to main content

Quick Start

Every SixM script follows the same basic installation pattern:
1. Download → 2. Extract → 3. Upload → 4. SQL → 5. Configure → 6. Ensure → 7. Restart

Script Structure

A typical SixM script folder looks like this:
sixm_scriptname/
├── client/           # Client-side code
├── server/           # Server-side code
├── config/           # Configuration files
│   ├── config.lua    # Main configuration
│   └── locales/      # Translation files
├── html/             # NUI/UI files (if applicable)
├── sql/              # Database migrations
│   └── install.sql   # Initial database setup
├── fxmanifest.lua    # Resource manifest
└── README.md         # Script documentation

Common Patterns

Config Files

All scripts have a config.lua or config/ directory. This is where you customize behavior, enable/disable features, and set up framework-specific options.
Config = {}

Config.Framework = 'auto'  -- 'auto', 'qbcore', 'esx', 'qbox', 'standalone'
Config.Debug = false        -- Enable debug mode for troubleshooting
Config.Language = 'en'      -- Language for notifications and UI

Exports

Most scripts provide exports for integration with other resources:
-- Example: check if a player has a specific status
local result = exports['sixm_scriptname']:SomeExport(playerId)
Check each script’s specific documentation for available exports.

Next Steps

Choose your framework for specific installation instructions:

QBCore

ESX

QBox

Standalone