Requirements
These must be installed and started before the battle pass.
| Dependency | Required | Notes |
|---|
| ox_lib | Yes | UI, commands, and shared helpers |
| oxmysql | Yes | Database access — tables auto-create |
| Framework | Yes | qbx_core (Qbox), qb-core (QBCore), or es_extended (ESX) |
| ox_inventory | For item rewards | Required on Qbox; recommended on all frameworks |
| A garage system | For vehicle rewards | Vehicle rewards are added as owned vehicles to a garage |
Item rewards and Vehicle rewards are optional. If you only hand out Money rewards, you don’t need ox_inventory or a garage.
Install steps
-
Place the
nex_battlepass folder in your resources directory.
-
Open
shared/config.lua and set your framework:
Config.Framework = 'qbx' -- 'qbx' | 'qb' | 'esx'
-
Add it to your
server.cfg after its dependencies:
ensure ox_lib
ensure oxmysql
ensure ox_inventory
ensure nex_battlepass
-
Start or restart the server.
Order matters. If nex_battlepass starts before its framework, ox_lib, or oxmysql, it won’t detect a framework and will fail to load. Keep the ensure lines in the order shown above.
Database
The required database tables are created automatically on first start — there is no SQL file to import. The tables created are:
nex_battlepass — player progressnex_battlepass_levels — your levels and rewards (managed via /bpadmin)nex_battlepass_codes — redemption codes (code mode)nex_battlepass_redemptions — used Tebex transactions
See Exports for the full table list.
Opening the UI
| Action | Default | Where to change |
|---|
| Open command | /battlepass | Config.OpenCommand |
| Open keybind | F7 (players can rebind in Settings → Key Bindings) | Config.OpenKey (set to '' to disable) |
exports.nex_battlepass:openBattlepass()
First run
A fresh install starts with no levels. Run /bpadmin (admin only) to open the in-game editor and start adding levels and rewards. See the Rewards editor page.
Updating
To update, stop the resource, replace the nex_battlepass folder with the new version, keep your edited shared/config.lua and server/sv_config.lua settings, and restart. Your levels, rewards, and player progress live in the database, so they are preserved across updates.
