Installation Guide

Get started with OOS Scripts in minutes.

looks_one Download & Extract

After purchasing a script from our store, download the latest version from the CFX Portal (Cfx.re Keymaster). Extract the ZIP file into your server's resources folder.

-- Your server directory structure example
server/
├── resources/
│ ├── oos_scriptname/
│ │ ├── client/
│ │ ├── server/
│ │ ├── config.lua
│ │ └── fxmanifest.lua
└── server.cfg

looks_two Add to server.cfg

Add the ensure statement to your server.cfg file to start the resource:

# Add after your framework ensure
ensure oos_scriptname

looks_3 Configure

Open the config.lua file and customize the settings to match your server:

Config = {}

-- Auto-detected: 'esx', 'qb', or 'qbox'
Config.Framework = 'auto'

-- Enable debug mode for development
Config.Debug = false

-- Locale settings
Config.Locale = 'en'

settings Configuration

Each script comes with a comprehensive config.lua file. Refer to the specific script's documentation for all available configuration options.

info
Framework Detection

All OOS Scripts feature automatic framework detection. Set Config.Framework = 'auto' and the script will detect ESX, QBCore, or QBox automatically.

code
Open-Source Customization

Many of our scripts include open-source sections that you can freely modify and extend. Check each script's files for customizable code alongside the escrow-protected core.

code Framework Setup

ESX Legacy

Ensure es_extended is started before OOS scripts.

QBCore

Ensure qb-core is started before OOS scripts.

QBox

Ensure qbx_core is started before OOS scripts.

output Exports & Events

Some script exposes exports and events for integration. Check each script's specific documentation for available calls.

-- Example: Using an export from an OOS script
local result = exports['oos_scriptname']:GetData()

-- Example: Listening for an event
RegisterNetEvent('oos_scriptname:client:onAction')
AddEventHandler('oos_scriptname:client:onAction', function(data)
print('Action triggered!')
end)
```