Installation
Follow this guide to install and configure Finals Bossmenu / Management on your FiveM server.
1. Prerequisites
Before installing, ensure your environment meets the following specifications:
| Requirement | Supported Versions | Notes |
|---|---|---|
| FXServer Artifact | 7290 or newer | Required for modern Lua 5.4 features. |
| oxmysql | Latest release | Required for MySQL persistence. |
| Core Framework | One of: qbx_core, qb-core, es_extended, ox_core | Auto-detected or configured in config.lua. |
| UI Environment | Pre-built in ui/ | Run npm run build inside web/ only if customizing frontend. |
2. Download and Folder Placement
-
Place the
finals_managementfolder into your server's resources directory:Plain textresources/[finals]/finals_management/ -
Important: Do not rename the folder unless you update all export references and event names across your server.
3. Server Configuration (server.cfg)
Start dependencies before finals_management in your server.cfg. Example load orders:
# Database Library
ensure oxmysql
# Framework & Libraries (Ensure your framework loads first)
# For Qbox:
ensure ox_lib
ensure qbx_core
# For QBCore:
# ensure qb-core
# For ESX:
# ensure es_extended
# For OX Core:
# ensure ox_lib
# ensure ox_core
# Optional Banking & Target Integrations
# ensure finals_banking
# ensure ox_target
# Finals Management
ensure finals_management4. Database Setup
By default, Config.SqlBootstrap.enabled = true is enabled in config.lua. Upon server startup, the resource will automatically create all necessary tables if they do not already exist:
finals_duty_sessionsfinals_applications_questions&finals_applications_filingsfinals_hire_pendingfinals_own_societyfinals_pending_paychecks
If your hosting environment restricts DDL operations, you can run the SQL files manually in HeidiSQL or phpMyAdmin. See the Database & SQL page for raw schemas.
5. Framework-Specific Installation Guides
Select your server stack below for tailored configuration instructions:
- QBCore: Shared jobs configuration, disabling duplicate paycheck loops, and offline roster queries.
- Qbox (QBX): Qbox player payroll delegation and native duty integration.
- ESX: Job grades setup,
esx_society/ banking coordination, and user metadata. - OX Core: Group grades,
ox_libcallbacks, andcharacters.statusesintegration.
6. First Start Checklist
-
oxmysqlstarts beforefinals_managementinserver.cfg. - Framework detected correctly or set explicitly in
Config.Framework. - Confirmed only one paycheck system is running (disabled old paycheck scripts to prevent double pay).
- Started the server and tested
/management(as boss) and/paycheck(as employee).